Convert to Order API for line item support #33

agileware-fj · 2021-01-20T04:51:32Z

This converts the integration to use the Order API to allow adding line items that are linked properly to the resulting contribution.

This might be related to or at least interfere with work on #32

monishdeb · 2021-01-20T08:25:40Z

I have applied the patch on one of our staging site to test it correctly records separate line-item and and financial item on purchasing an order with multiple products. I have added an order with two product items:

Test Product (National) - Green ($50)
PEI T-Shirt ($18)

Here's the financial records before and after applying the patch:

BEFORE

civicrm_api3('LineItem', 'get', [
  'sequential' => 1,
  'contribution_id' => 25955,
  'api.FinancialItem.get' => ['entity_id' => "\$value.id", 'entity_table' => "civicrm_line_item"],
]);
// result
{

    "is_error": 0,
    "version": 3,
    "count": 2,
    "values": [
        {
            "id": "122651",
            "entity_table": "civicrm_contribution",
            "entity_id": "25955",
            "contribution_id": "25955",
            "price_field_id": "1",
            "label": "PEI T-Shirt",
            "qty": "1.00",
            "unit_price": "68.00",
            "line_total": "68.00",
            "financial_type_id": "60",
            "non_deductible_amount": "0.00",
            "contribution_type_id": "60",
            "api.FinancialItem.get": {
                "is_error": 0,
                "version": 3,
                "count": 0,
                "values": []
            }
        },
        {
            "id": "122652",
            "entity_table": "civicrm_contribution",
            "entity_id": "25955",
            "contribution_id": "25955",
            "price_field_id": "1",
            "label": "Test Product (National) - Green",
            "qty": "1.00",
            "unit_price": "68.00",
            "line_total": "68.00",
            "financial_type_id": "60",
            "non_deductible_amount": "0.00",
            "contribution_type_id": "60",
            "api.FinancialItem.get": {
                "is_error": 0,
                "version": 3,
                "count": 0,
                "values": []
            }
        }
    ]
}

AFTER

{

    "is_error": 0,
    "version": 3,
    "count": 2,
    "values": [
        {
            "id": "122665",
            "entity_table": "civicrm_contribution",
            "entity_id": "25960",
            "contribution_id": "25960",
            "price_field_id": "1",
            "label": "Test Product (National) - Green",
            "qty": "1.00",
            "unit_price": "68.00",
            "line_total": "68.00",
            "financial_type_id": "60",
            "non_deductible_amount": "0.00",
            "tax_amount": "0.00",
            "contribution_type_id": "60",
            "api.FinancialItem.get": {
                "is_error": 0,
                "version": 3,
                "count": 1,
                "id": 48868,
                "values": [
                    {
                        "id": "48868",
                        "created_date": "2021-01-20 03:12:24",
                        "transaction_date": "2021-01-20 03:12:23",
                        "contact_id": "49916",
                        "description": "Test Product (National) - Green",
                        "amount": "50.00",
                        "currency": "CAD",
                        "financial_account_id": "90",
                        "status_id": "1",
                        "entity_table": "civicrm_line_item",
                        "entity_id": "122665"
                    }
                ]
            }
        },
        {
            "id": "122666",
            "entity_table": "civicrm_contribution",
            "entity_id": "25960",
            "contribution_id": "25960",
            "price_field_id": "1",
            "label": "PEI T-Shirt",
            "qty": "1.00",
            "unit_price": "68.00",
            "line_total": "68.00",
            "financial_type_id": "60",
            "non_deductible_amount": "0.00",
            "tax_amount": "0.00",
            "contribution_type_id": "60",
            "api.FinancialItem.get": {
                "is_error": 0,
                "version": 3,
                "count": 1,
                "id": 48869,
                "values": [
                    {
                        "id": "48869",
                        "created_date": "2021-01-20 03:12:24",
                        "transaction_date": "2021-01-20 03:12:23",
                        "contact_id": "49916",
                        "description": "PEI T-Shirt",
                        "amount": "18.00",
                        "currency": "CAD",
                        "financial_account_id": "90",
                        "status_id": "1",
                        "entity_table": "civicrm_line_item",
                        "entity_id": "122666"
                    }
                ]
            }
        }
    ]
}

As you can see in the later case it fixes two issues:

There is an associated FinancialItem which was missing earlier.
LineItem total is correct

Hence, the current patch confirms that it correctly records the financial information on purchasing a product.

monishdeb · 2021-01-20T08:33:57Z

The current patch fixes another issue mentioned in #32 where I the update status code wasn't able to change the Donation's status to 'Cancelled' or 'Refunded' on cancelling or refunding a order. Here's the screenshot of both the cases of:

Cancelled contribution:

Refunded contribution:

Ensured that financial adjustment are correct.

monishdeb · 2021-01-20T08:46:18Z

includes/class-woocommerce-civicrm-manager.php

-		 				  '0' => 3,
-		 				),
+		 			$params['line_items'][0]['line_item'][] = array(
+		 				'price_field_id' => '1',


Can you please replace the hardcoded ID with api call?

monishdeb · 2021-01-20T08:47:41Z

includes/class-woocommerce-civicrm-manager.php

 			'trxn_id' => $txn_id,
 			'invoice_id' => $invoice_id,
 			'source' => $source,
 			'receive_date' => $order_paid_date,
-			'contribution_status_id' => $contribution_status_id,
+			// 'contribution_status_id' => $contribution_status_id,


like to know why this line is commented out!!.

This probably actually should be hard-coded to 'Pending' and then a payment recorded for completed WooCommerce orders, as per what the Order API expects.

monishdeb · 2021-01-20T08:48:26Z

includes/class-woocommerce-civicrm-manager.php

@@ -677,7 +676,7 @@ public function add_contribution( $cid, &$order ) {
 		 * @since 2.0
 		 * @param array $params The params to be passsed to the API
 		 */
-			$contribution = civicrm_api3( 'Contribution', 'create', apply_filters( 'woocommerce_civicrm_contribution_create_params', $params ) );
+			$contribution = civicrm_api3( 'Order', 'create', apply_filters( 'woocommerce_civicrm_contribution_create_params', $params, $order ) );


Awesome 👍

I have put the new code in and it seems to fix the problem of the financial contribution link, but the plugin also seems to be trying to create a membership which is failing as follows:

Error Details

An error of type E_ERROR was caused in line 133 of the file /home/rjakn8hl475q/public_html/shop/wp-content/plugins/civicrm/civicrm/api/api.php. Error message: Uncaught CiviCRM_API3_Exception: [constraint violation: DB Error: constraint violation thrown

Maybe it is because I have set the WooCommerce product to set to Contribution Type = Membership in Civi although it has worked in the past. Can you tell me what the code is trying to do with creating a membership record in Civi because I can't see anywhere in WooCommerce where this is set or how it is triggered?

@ralphyke yes, setting the Financial Type to Member Dues seems to (obscurely) attempt to create a Membership, I think I will strip that out for now as it's not the best implementation.

Ok, if you can strip that out and then I can put in the new version again, that would be great

mecachisenros · 2021-01-21T11:12:11Z

Thanks @agileware-fj for the PRs and @monishdeb for reviewing.

I'll review and test and report back.

JoeMurray · 2021-01-21T18:36:48Z

@monishdeb could you test for multiple line items to ensure that financial items are created properly in that use case.

Thanks, @mecachisenros for your work on this. JMA would like to leave the work and testing for the membership stuff to you and others as we focus on the financial stuff. Thanks again @agileware-fj for your patches. Cheers,

agileware-justin · 2021-01-21T22:22:10Z

This and the other two PRs were funded work as part of a WordPress / CiviCRM integration project.

We were planning on releasing these changes at some stage once the project was done, @JoeMurray your recent comment about maintainers and line items was the prompt to bring that plan forward :)

monishdeb · 2021-01-22T00:05:29Z

@JoeMurray yes I have tested with multiple line-items and posted my findings above. I have tested with two items:

Test Product (National) - Green ($50)
PEI T-Shirt ($18)

And using chain API result, that the line-items and financial items are created correctly.

mecachisenros · 2021-02-03T15:52:46Z

@monishdeb @agileware-fj @agileware-justin @JoeMurray
Merged, with some fixes:

replaced hardcoded price_field_id with default_contribution_amount price field
line_items are created on a per product basis rather than one line_item with multiple products

mecachisenros · 2021-02-03T15:57:45Z

Forgot to mention, added basic Membership implementation.

The membership is configurable in the CiviCRM Settings panel in the Edit/Add Product screen in Woo.

All membership default/settings (i.e. period, plan, etc.) are based on how the Membership is configured in CiviCRM.

monishdeb · 2021-02-03T16:40:00Z

Thanks you so much guys for getting this PR merged. Much needed change to get the financial entries recorded for the purchased order. Also enables line-item editor to edit the associated line-items properly now, unlike earlier which throws an error due to missing financial-item, which fixed by this patch.

CIVIWOO-10: Convert to Order API for line item support

cfcc0f4

agileware-fj mentioned this pull request Jan 20, 2021

Use a line item to add shipping #34

Merged

This was referenced Jan 20, 2021

Fail to change status of related contribution when order status is changed to Completed to Cancelled #32

Open

Become maintainer/put out new release? #28

Open

monishdeb reviewed Jan 20, 2021

View reviewed changes

mecachisenros merged commit cfcc0f4 into mecachisenros:master Feb 3, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert to Order API for line item support #33

Convert to Order API for line item support #33

agileware-fj commented Jan 20, 2021

monishdeb commented Jan 20, 2021

monishdeb commented Jan 20, 2021 •

edited

Loading

monishdeb Jan 20, 2021

monishdeb Jan 20, 2021

agileware-fj Jan 22, 2021

monishdeb Jan 20, 2021

ralphyke Jan 20, 2021 •

edited

Loading

mecachisenros Jan 21, 2021

ralphyke Jan 21, 2021

mecachisenros commented Jan 21, 2021

JoeMurray commented Jan 21, 2021

agileware-justin commented Jan 21, 2021

monishdeb commented Jan 22, 2021

mecachisenros commented Feb 3, 2021

mecachisenros commented Feb 3, 2021

monishdeb commented Feb 3, 2021

Convert to Order API for line item support #33

Convert to Order API for line item support #33

Conversation

agileware-fj commented Jan 20, 2021

monishdeb commented Jan 20, 2021

BEFORE

AFTER

monishdeb commented Jan 20, 2021 • edited Loading

monishdeb Jan 20, 2021

Choose a reason for hiding this comment

monishdeb Jan 20, 2021

Choose a reason for hiding this comment

agileware-fj Jan 22, 2021

Choose a reason for hiding this comment

monishdeb Jan 20, 2021

Choose a reason for hiding this comment

ralphyke Jan 20, 2021 • edited Loading

Choose a reason for hiding this comment

Error Details

mecachisenros Jan 21, 2021

Choose a reason for hiding this comment

ralphyke Jan 21, 2021

Choose a reason for hiding this comment

mecachisenros commented Jan 21, 2021

JoeMurray commented Jan 21, 2021

agileware-justin commented Jan 21, 2021

monishdeb commented Jan 22, 2021

mecachisenros commented Feb 3, 2021

mecachisenros commented Feb 3, 2021

monishdeb commented Feb 3, 2021

monishdeb commented Jan 20, 2021 •

edited

Loading

ralphyke Jan 20, 2021 •

edited

Loading