Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolve Issue with Payment Allocation to Contribution Line Item #29823

Closed
wants to merge 3 commits into from
Closed

Resolve Issue with Payment Allocation to Contribution Line Item #29823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53d5384
Pro rate payment lineitems amount with correct values
olayiwola-compucorp Feb 14, 2024
0de1660
Compute allocated tax amount in getPayableLineItems
olayiwola-compucorp Mar 26, 2024
1e2449e
Ensure payment amount are allocated to lineitems without roundoff error
olayiwola-compucorp Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 41 additions & 16 deletions CRM/Financial/BAO/Payment.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public static function create(array $params): CRM_Financial_DAO_FinancialTrxn {
$contribution = civicrm_api3('Contribution', 'getsingle', ['id' => $params['contribution_id']]);
$contributionStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contribution['contribution_status_id']);
$isPaymentCompletesContribution = self::isPaymentCompletesContribution($params['contribution_id'], $params['total_amount'], $contributionStatus);
$lineItems = self::getPayableLineItems($params);
$lineItems = self::getPayableLineItems($params, $contribution);

$whiteList = ['check_number', 'payment_processor_id', 'fee_amount', 'total_amount', 'contribution_id', 'net_amount', 'card_type_id', 'pan_truncation', 'trxn_result_code', 'payment_instrument_id', 'trxn_id', 'trxn_date', 'order_reference'];
$paymentTrxnParams = array_intersect_key($params, array_fill_keys($whiteList, 1));
Expand Down Expand Up @@ -163,19 +163,13 @@ public static function create(array $params): CRM_Financial_DAO_FinancialTrxn {
if ($financialItem['financial_item.entity_id'] === (int) $lineItem['id']
&& in_array($financialItem['financial_item.financial_account_id'], $salesTaxFinancialAccount, TRUE)
) {
// If we find a "Sales Tax" lineitem we record a tax entry in entityFiancncialTrxn
// @todo - this is expected to be broken - it should be fixed to
// a) have the getPayableLineItems add the amount to allocate for tax
// b) call EntityFinancialTrxn directly - per above.
// - see https://github.com/civicrm/civicrm-core/pull/14763
$entityParams = [
'contribution_total_amount' => $contribution['total_amount'],
'trxn_total_amount' => $params['total_amount'],
'trxn_id' => $trxn->id,
'line_item_amount' => $financialItem['tax_amount'],
$eftParams = [
'entity_table' => 'civicrm_financial_item',
'financial_trxn_id' => $trxn->id,
'entity_id' => $financialItem['financial_item.id'],
'amount' => $lineItem['tax_allocation'],
];
$eftParams['entity_id'] = $financialItem['financial_item.id'];
CRM_Contribute_BAO_Contribution::createProportionalEntry($entityParams, $eftParams);
civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
}
}
}
Expand Down Expand Up @@ -537,11 +531,12 @@ private static function updateContributionStatus(int $contributionID, string $st
* - if overrides have been passed in we use those amounts instead.
*
* @param $params
* @param $contribution
*
* @return array
* @throws \CRM_Core_Exception
*/
protected static function getPayableLineItems($params): array {
protected static function getPayableLineItems($params, $contribution): array {
$lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($params['contribution_id']);
$lineItemOverrides = [];
if (!empty($params['line_item'])) {
Expand All @@ -552,6 +547,7 @@ protected static function getPayableLineItems($params): array {
}
}
$outstandingBalance = CRM_Contribute_BAO_Contribution::getContributionBalance($params['contribution_id']);
$isPaymentCompletesContribution = self::isPaymentCompletesContribution($params['contribution_id'], $params['total_amount'], '');
if ($outstandingBalance !== 0.0) {
$ratio = $params['total_amount'] / $outstandingBalance;
}
Expand All @@ -572,13 +568,32 @@ protected static function getPayableLineItems($params): array {
}
else {
if (empty($lineItems[$lineItemID]['balance']) && !empty($ratio) && $params['total_amount'] < 0) {
$lineItems[$lineItemID]['allocation'] = $lineItem['subTotal'] * $ratio;
$lineItems[$lineItemID]['allocation'] = round($lineItem['subTotal'] * $ratio, 2);
}
elseif ($isPaymentCompletesContribution) {
$lineItems[$lineItemID]['allocation'] = $lineItems[$lineItemID]['balance'];
}
else {
$lineItems[$lineItemID]['allocation'] = $lineItems[$lineItemID]['balance'] * $ratio;
$lineItems[$lineItemID]['allocation'] = round($lineItems[$lineItemID]['balance'] * $ratio, 2);
}

if (!empty($lineItem['tax_amount'])) {
$lineItems[$lineItemID]['tax_allocation'] = round($lineItem['tax_amount'] * ($params['total_amount'] / $contribution['total_amount']), 2);
}

}
}

if (empty($lineItemOverrides) && !empty($ratio)) {
$totalTaxAllocation = array_sum(array_column($lineItems, 'tax_allocation'));
$totalAllocation = array_sum(array_column($lineItems, 'allocation'));
$total = $totalTaxAllocation + $totalAllocation;
$leftPayment = $params['total_amount'] - $total;

// assign any leftover amount, to the last lineitem
$lineItems[$lineItemID]['allocation'] += $leftPayment;
}

return $lineItems;
}

Expand Down Expand Up @@ -609,6 +624,16 @@ protected static function getAmountOfLineItemPaid($lineItemID) {
$paid += $entityFinancialTrxn['amount'];
}
}

$lineItem = \Civi\Api4\LineItem::get(FALSE)
->addWhere('id', '=', $lineItemID)
->execute()
->first();
if (!empty($lineItem['tax_amount']) && $paid > 0) {
$total = floatval($lineItem['line_total']);
$tax = floatval($lineItem['tax_amount']);
$paid = ($total * $paid) / ($tax + $total);
}
return (float) $paid;
}

Expand Down
38 changes: 37 additions & 1 deletion tests/phpunit/CRM/Contribute/Form/AdditionalPaymentTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,13 @@ class CRM_Contribute_Form_AdditionalPaymentTest extends CiviUnitTestCase {
*/
protected $paymentProcessorID;

/**
* Financial Type ID.
*
* @var int
*/
protected $_financialTypeID = 1;

/**
* Setup function.
*
Expand All @@ -86,7 +93,7 @@ public function setUp(): void {
'total_amount' => 100,
'currency' => 'USD',
'contact_id' => $this->_individualId,
'financial_type_id' => 1,
'financial_type_id' => $this->_financialTypeID,
];
$this->_processorParams = [
'domain_id' => 1,
Expand Down Expand Up @@ -342,6 +349,35 @@ public function testMultiplePaymentForPendingPayLaterContributionWithOneCreditCa
$this->checkResults([50, 20, 20, 10], 4);
}

/**
* Test that multiple payment has correct line item allocations.
*
* @throws \CRM_Core_Exception
*/
public function testMultiplePaymentForPendingPayLaterContributionHasCorrectionAllocation(): void {
$this->enableTaxAndInvoicing();
$this->addTaxAccountToFinancialType($this->_financialTypeID, ['tax_rate' => 20]);
$this->createPendingOrder(['amount' => 120]);

$this->submitPayment(60);
$this->submitPayment(30);
$result = $this->callAPISuccess('EntityFinancialTrxn', 'get', [
'version' => 4,
'where' => [
['entity_table', '=', 'civicrm_contribution'],
['entity_id', '=', $this->_contributionId],
],
'chain' => [
'line_items' => ['EntityFinancialTrxn', 'get', ['where' => [['financial_trxn_id', '=', '$financial_trxn_id'], ['id', '!=', '$id']]]],
],
])['values'];

// Assert that the line items have the correct allocatioins from the paid amount
foreach ($result as $entityFnTrxn) {
$this->assertEquals(round($entityFnTrxn['amount'], 2), round(array_sum(array_column($entityFnTrxn['line_items'], 'amount')), 2));
}
}

/**
* Function to submit payments for contribution.
*
Expand Down