3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Core_BAO_FinancialTrxn
extends CRM_Financial_DAO_FinancialTrxn
{
21 * @return \CRM_Financial_DAO_FinancialTrxn
26 public function __construct() {
27 parent
::__construct();
31 * Takes an associative array and creates a financial transaction object.
33 * @param array $params
34 * (reference ) an assoc array of name/value pairs.
36 * @return CRM_Financial_DAO_FinancialTrxn
38 public static function create($params) {
39 $trxn = new CRM_Financial_DAO_FinancialTrxn();
40 $trxn->copyValues($params);
42 if (isset($params['fee_amount']) && is_numeric($params['fee_amount'])) {
43 if (!isset($params['total_amount'])) {
45 $params['total_amount'] = $trxn->total_amount
;
47 $trxn->net_amount
= $params['total_amount'] - $params['fee_amount'];
50 if (empty($params['id']) && !CRM_Utils_Rule
::currencyCode($trxn->currency
)) {
51 $trxn->currency
= CRM_Core_Config
::singleton()->defaultCurrency
;
56 if (!empty($params['id'])) {
57 // For an update entity financial transaction record will already exist. Return early.
61 // Save to entity_financial_trxn table.
62 $entityFinancialTrxnParams = [
63 'entity_table' => CRM_Utils_Array
::value('entity_table', $params, 'civicrm_contribution'),
64 'entity_id' => CRM_Utils_Array
::value('entity_id', $params, CRM_Utils_Array
::value('contribution_id', $params)),
65 'financial_trxn_id' => $trxn->id
,
66 'amount' => $params['total_amount'],
69 $entityTrxn = new CRM_Financial_DAO_EntityFinancialTrxn();
70 $entityTrxn->copyValues($entityFinancialTrxnParams);
76 * @param int $contributionId
77 * @param int $contributionFinancialTypeId
81 public static function getBalanceTrxnAmt($contributionId, $contributionFinancialTypeId = NULL) {
82 if (!$contributionFinancialTypeId) {
83 $contributionFinancialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_BAO_Contribution', $contributionId, 'financial_type_id');
85 $toFinancialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($contributionFinancialTypeId, 'Accounts Receivable Account is');
86 $q = "SELECT ft.id, ft.total_amount FROM civicrm_financial_trxn ft INNER JOIN civicrm_entity_financial_trxn eft ON (eft.financial_trxn_id = ft.id AND eft.entity_table = 'civicrm_contribution') WHERE eft.entity_id = %1 AND ft.to_financial_account_id = %2";
88 $p[1] = [$contributionId, 'Integer'];
89 $p[2] = [$toFinancialAccount, 'Integer'];
91 $balanceAmtDAO = CRM_Core_DAO
::executeQuery($q, $p);
93 if ($balanceAmtDAO->N
) {
94 $ret['total_amount'] = 0;
96 while ($balanceAmtDAO->fetch()) {
97 $ret['trxn_id'] = $balanceAmtDAO->id
;
98 $ret['total_amount'] +
= $balanceAmtDAO->total_amount
;
105 * Fetch object based on array of properties.
107 * @param array $params
108 * (reference ) an assoc array of name/value pairs.
109 * @param array $defaults
110 * (reference ) an assoc array to hold the flattened values.
112 * @return \CRM_Financial_DAO_FinancialTrxn
114 public static function retrieve(&$params, &$defaults = []) {
115 $financialItem = new CRM_Financial_DAO_FinancialTrxn();
116 $financialItem->copyValues($params);
117 if ($financialItem->find(TRUE)) {
118 CRM_Core_DAO
::storeValues($financialItem, $defaults);
119 return $financialItem;
125 * Given an entity_id and entity_table, check for corresponding entity_financial_trxn and financial_trxn record.
126 * NOTE: This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object.
129 * Id of the entity usually the contributionID.
130 * @param string $orderBy
131 * To get single trxn id for a entity table i.e last or first.
132 * @param bool $newTrxn
133 * @param string $whereClause
134 * Additional where parameters
135 * @param int $fromAccountID
138 * array of category id's the contact belongs to.
141 public static function getFinancialTrxnId($entity_id, $orderBy = 'ASC', $newTrxn = FALSE, $whereClause = '', $fromAccountID = NULL) {
142 $ids = ['entityFinancialTrxnId' => NULL, 'financialTrxnId' => NULL];
144 $params = [1 => [$entity_id, 'Integer']];
147 $condition = " AND ((ceft1.entity_table IS NOT NULL) OR (cft.payment_instrument_id IS NOT NULL AND ceft1.entity_table IS NULL)) ";
150 if ($fromAccountID) {
151 $condition .= " AND (cft.from_financial_account_id <> %2 OR cft.from_financial_account_id IS NULL)";
152 $params[2] = [$fromAccountID, 'Integer'];
155 $orderBy = CRM_Utils_Type
::escape($orderBy, 'String');
158 $query = "SELECT ceft.id, ceft.financial_trxn_id, cft.trxn_id FROM `civicrm_financial_trxn` cft
159 LEFT JOIN civicrm_entity_financial_trxn ceft
160 ON ceft.financial_trxn_id = cft.id AND ceft.entity_table = 'civicrm_contribution'
161 LEFT JOIN civicrm_entity_financial_trxn ceft1
162 ON ceft1.financial_trxn_id = cft.id AND ceft1.entity_table = 'civicrm_financial_item'
163 LEFT JOIN civicrm_financial_item cfi ON ceft1.entity_table = 'civicrm_financial_item' and cfi.id = ceft1.entity_id
164 WHERE ceft.entity_id = %1 AND (cfi.entity_table <> 'civicrm_financial_trxn' or cfi.entity_table is NULL)
167 ORDER BY cft.id {$orderBy}
170 $dao = CRM_Core_DAO
::executeQuery($query, $params);
172 $ids['entityFinancialTrxnId'] = $dao->id
;
173 $ids['financialTrxnId'] = $dao->financial_trxn_id
;
174 $ids['trxn_id'] = $dao->trxn_id
;
180 * Get the transaction id for the (latest) refund associated with a contribution.
182 * @param int $contributionID
185 public static function getRefundTransactionTrxnID($contributionID) {
186 $ids = self
::getRefundTransactionIDs($contributionID);
187 return isset($ids['trxn_id']) ?
$ids['trxn_id'] : NULL;
191 * Get the transaction id for the (latest) refund associated with a contribution.
193 * @param int $contributionID
196 public static function getRefundTransactionIDs($contributionID) {
197 $refundStatusID = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Refunded');
198 return self
::getFinancialTrxnId($contributionID, 'DESC', FALSE, " AND cft.status_id = $refundStatusID");
202 * Given an entity_id and entity_table, check for corresponding entity_financial_trxn and financial_trxn record.
203 * @todo This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object.
205 * @param int $entity_id
206 * Id of the entity usually the contactID.
209 * array of category id's the contact belongs to.
212 public static function getFinancialTrxnTotal($entity_id) {
214 SELECT (ft.amount+SUM(ceft.amount)) AS total FROM civicrm_entity_financial_trxn AS ft
215 LEFT JOIN civicrm_entity_financial_trxn AS ceft ON ft.financial_trxn_id = ceft.entity_id
216 WHERE ft.entity_table = 'civicrm_contribution' AND ft.entity_id = %1
219 $sqlParams = [1 => [$entity_id, 'Integer']];
220 return CRM_Core_DAO
::singleValueQuery($query, $sqlParams);
225 * Given an financial_trxn_id check for previous entity_financial_trxn.
227 * @param $financial_trxn_id
228 * Id of the latest payment.
232 * array of previous payments
235 public static function getPayments($financial_trxn_id) {
237 SELECT ef1.financial_trxn_id, sum(ef1.amount) amount
238 FROM civicrm_entity_financial_trxn ef1
239 LEFT JOIN civicrm_entity_financial_trxn ef2 ON ef1.financial_trxn_id = ef2.entity_id
240 WHERE ef2.financial_trxn_id =%1
241 AND ef2.entity_table = 'civicrm_financial_trxn'
242 AND ef1.entity_table = 'civicrm_financial_item'
243 GROUP BY ef1.financial_trxn_id
245 SELECT ef1.financial_trxn_id, ef1.amount
246 FROM civicrm_entity_financial_trxn ef1
247 LEFT JOIN civicrm_entity_financial_trxn ef2 ON ef1.entity_id = ef2.entity_id
248 WHERE ef2.financial_trxn_id =%1
249 AND ef2.entity_table = 'civicrm_financial_trxn'
250 AND ef1.entity_table = 'civicrm_financial_trxn'";
252 $sqlParams = [1 => [$financial_trxn_id, 'Integer']];
253 $dao = CRM_Core_DAO
::executeQuery($query, $sqlParams);
256 while ($dao->fetch()) {
257 $result[$i]['financial_trxn_id'] = $dao->financial_trxn_id
;
258 $result[$i]['amount'] = $dao->amount
;
262 if (empty($result)) {
263 $query = "SELECT sum( amount ) amount FROM civicrm_entity_financial_trxn WHERE financial_trxn_id =%1 AND entity_table = 'civicrm_financial_item'";
264 $sqlParams = [1 => [$financial_trxn_id, 'Integer']];
265 $dao = CRM_Core_DAO
::executeQuery($query, $sqlParams);
268 $result[0]['financial_trxn_id'] = $financial_trxn_id;
269 $result[0]['amount'] = $dao->amount
;
276 * Given an entity_id and entity_table, check for corresponding entity_financial_trxn and financial_trxn record.
277 * NOTE: This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object.
280 * Id of the entity usually the contactID.
281 * @param string $entity_table
282 * Name of the entity table usually 'civicrm_contact'.
285 * array of category id's the contact belongs to.
288 public static function getFinancialTrxnLineTotal($entity_id, $entity_table = 'civicrm_contribution') {
289 $query = "SELECT lt.price_field_value_id AS id, ft.financial_trxn_id,ft.amount AS amount FROM civicrm_entity_financial_trxn AS ft
290 LEFT JOIN civicrm_financial_item AS fi ON fi.id = ft.entity_id AND fi.entity_table = 'civicrm_line_item' AND ft.entity_table = 'civicrm_financial_item'
291 LEFT JOIN civicrm_line_item AS lt ON lt.id = fi.entity_id AND lt.entity_table = %2
292 WHERE lt.entity_id = %1 ";
294 $sqlParams = [1 => [$entity_id, 'Integer'], 2 => [$entity_table, 'String']];
295 $dao = CRM_Core_DAO
::executeQuery($query, $sqlParams);
296 while ($dao->fetch()) {
297 $result[$dao->financial_trxn_id
][$dao->id
] = $dao->amount
;
299 if (!empty($result)) {
308 * Delete financial transaction.
310 * @param int $entity_id
312 * TRUE on success, FALSE otherwise.
314 public static function deleteFinancialTrxn($entity_id) {
315 $query = "DELETE ceft1, cfi, ceft, cft FROM `civicrm_financial_trxn` cft
316 LEFT JOIN civicrm_entity_financial_trxn ceft
317 ON ceft.financial_trxn_id = cft.id AND ceft.entity_table = 'civicrm_contribution'
318 LEFT JOIN civicrm_entity_financial_trxn ceft1
319 ON ceft1.financial_trxn_id = cft.id AND ceft1.entity_table = 'civicrm_financial_item'
320 LEFT JOIN civicrm_financial_item cfi
321 ON ceft1.entity_table = 'civicrm_financial_item' and cfi.id = ceft1.entity_id
322 WHERE ceft.entity_id = %1";
323 CRM_Core_DAO
::executeQuery($query, [1 => [$entity_id, 'Integer']]);
328 * Create financial transaction for premium.
330 * @param array $params
332 * - financial_type_id
338 public static function createPremiumTrxn($params) {
339 if ((empty($params['financial_type_id']) ||
empty($params['contributionId'])) && empty($params['oldPremium'])) {
343 if (!empty($params['cost'])) {
344 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
345 $toFinancialAccountType = !empty($params['isDeleted']) ?
'Premiums Inventory Account is' : 'Cost of Sales Account is';
346 $fromFinancialAccountType = !empty($params['isDeleted']) ?
'Cost of Sales Account is' : 'Premiums Inventory Account is';
348 'to_financial_account_id' => CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['financial_type_id'], $toFinancialAccountType),
349 'from_financial_account_id' => CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['financial_type_id'], $fromFinancialAccountType),
350 'trxn_date' => date('YmdHis'),
351 'total_amount' => CRM_Utils_Array
::value('cost', $params) ?
$params['cost'] : 0,
352 'currency' => CRM_Utils_Array
::value('currency', $params),
353 'status_id' => array_search('Completed', $contributionStatuses),
354 'entity_table' => 'civicrm_contribution',
355 'entity_id' => $params['contributionId'],
357 CRM_Core_BAO_FinancialTrxn
::create($financialtrxn);
360 if (!empty($params['oldPremium'])) {
362 'id' => $params['oldPremium']['product_id'],
364 $productDetails = [];
365 CRM_Contribute_BAO_Product
::retrieve($premiumParams, $productDetails);
367 'cost' => CRM_Utils_Array
::value('cost', $productDetails),
368 'currency' => CRM_Utils_Array
::value('currency', $productDetails),
369 'financial_type_id' => CRM_Utils_Array
::value('financial_type_id', $productDetails),
370 'contributionId' => $params['oldPremium']['contribution_id'],
373 CRM_Core_BAO_FinancialTrxn
::createPremiumTrxn($params);
378 * Create financial trxn and items when fee is charged.
380 * @param array $params
381 * To create trxn entries.
385 public static function recordFees($params) {
386 $domainId = CRM_Core_Config
::domainID();
388 if (!empty($params['prevContribution'])) {
389 $amount = $params['prevContribution']->fee_amount
;
391 $amount = $params['fee_amount'] - $amount;
395 $contributionId = isset($params['contribution']->id
) ?
$params['contribution']->id
: $params['contribution_id'];
396 if (empty($params['financial_type_id'])) {
397 $financialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id', 'id');
400 $financialTypeId = $params['financial_type_id'];
402 $financialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($financialTypeId, 'Expense Account is');
404 $params['trxnParams']['from_financial_account_id'] = $params['to_financial_account_id'];
405 $params['trxnParams']['to_financial_account_id'] = $financialAccount;
406 $params['trxnParams']['total_amount'] = $amount;
407 $params['trxnParams']['fee_amount'] = $params['trxnParams']['net_amount'] = 0;
408 $params['trxnParams']['status_id'] = $params['contribution_status_id'];
409 $params['trxnParams']['contribution_id'] = $contributionId;
410 $params['trxnParams']['is_payment'] = FALSE;
411 $trxn = self
::create($params['trxnParams']);
412 if (empty($params['entity_id'])) {
413 $financialTrxnID = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($params['trxnParams']['contribution_id'], 'DESC');
414 $params['entity_id'] = $financialTrxnID['financialTrxnId'];
418 'financial_account_id' => $financialAccount,
419 'contact_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Domain', $domainId, 'contact_id'),
420 'created_date' => date('YmdHis'),
421 'transaction_date' => date('YmdHis'),
423 'description' => 'Fee',
424 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Financial_BAO_FinancialItem', 'status_id', 'Paid'),
425 'entity_table' => 'civicrm_financial_trxn',
426 'entity_id' => $params['entity_id'],
427 'currency' => $params['trxnParams']['currency'],
429 $trxnIDS['id'] = $trxn->id
;
430 CRM_Financial_BAO_FinancialItem
::create($fItemParams, NULL, $trxnIDS);
434 * get partial payment amount.
438 * This function basically calls CRM_Contribute_BAO_Contribution::getContributionBalance
439 * - just do that. If need be we could have a fn to get the contribution id but
440 * chances are the calling functions already know it anyway.
442 * @param int $entityId
443 * @param string $entityName
444 * @param int $lineItemTotal
448 public static function getPartialPaymentWithType($entityId, $entityName = 'participant', $lineItemTotal = NULL) {
449 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Contribute_BAO_Contribution::getContributionBalance');
451 if (empty($entityName)) {
455 // @todo - deprecate passing in entity & type - just figure out contribution id FIRST
456 if ($entityName == 'participant') {
457 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $entityId, 'contribution_id', 'participant_id');
459 elseif ($entityName == 'membership') {
460 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment', $entityId, 'contribution_id', 'membership_id');
463 $contributionId = $entityId;
465 $financialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
467 if ($contributionId && $financialTypeId) {
469 $paymentVal = CRM_Contribute_BAO_Contribution
::getContributionBalance($contributionId, $lineItemTotal);
471 if ($paymentVal < 0) {
472 $value['refund_due'] = $paymentVal;
474 elseif ($paymentVal > 0) {
475 $value['amount_owed'] = $paymentVal;
482 * @param int $contributionID
483 * @param bool $includeRefund
487 public static function getTotalPayments($contributionID, $includeRefund = FALSE) {
488 $statusIDs = [CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed')];
490 if ($includeRefund) {
491 $statusIDs[] = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Refunded');
494 $sql = "SELECT SUM(ft.total_amount) FROM civicrm_financial_trxn ft
495 INNER JOIN civicrm_entity_financial_trxn eft ON (eft.financial_trxn_id = ft.id AND eft.entity_table = 'civicrm_contribution')
496 WHERE eft.entity_id = %1 AND ft.is_payment = 1 AND ft.status_id IN (%2) ";
498 return CRM_Core_DAO
::singleValueQuery($sql, [
499 1 => [$contributionID, 'Integer'],
500 2 => [implode(',', $statusIDs), 'CommaSeparatedIntegers'],
505 * Get revenue amount for membership.
507 * @param array $lineItem
511 public static function getMembershipRevenueAmount($lineItem) {
513 $membershipDetail = civicrm_api3('Membership', 'getsingle', [
514 'id' => $lineItem['entity_id'],
516 if (empty($membershipDetail['end_date'])) {
517 return $revenueAmount;
520 $startDate = strtotime($membershipDetail['start_date']);
521 $endDate = strtotime($membershipDetail['end_date']);
522 $startYear = date('Y', $startDate);
523 $endYear = date('Y', $endDate);
524 $startMonth = date('m', $startDate);
525 $endMonth = date('m', $endDate);
527 $monthOfService = (($endYear - $startYear) * 12) +
($endMonth - $startMonth);
528 $startDateOfRevenue = $membershipDetail['start_date'];
529 $typicalPayment = round(($lineItem['line_total'] / $monthOfService), 2);
530 for ($i = 0; $i <= $monthOfService - 1; $i++
) {
531 $revenueAmount[$i]['amount'] = $typicalPayment;
533 $revenueAmount[$i]['amount'] -= (($typicalPayment * $monthOfService) - $lineItem['line_total']);
535 $revenueAmount[$i]['revenue_date'] = $startDateOfRevenue;
536 $startDateOfRevenue = date('Y-m', strtotime('+1 month', strtotime($startDateOfRevenue))) . '-01';
538 return $revenueAmount;
542 * Create transaction for deferred revenue.
544 * @param array $lineItems
546 * @param CRM_Contribute_BAO_Contribution $contributionDetails
548 * @param bool $update
550 * @param string $context
553 public static function createDeferredTrxn($lineItems, $contributionDetails, $update = FALSE, $context = NULL) {
554 if (empty($lineItems)) {
557 $revenueRecognitionDate = $contributionDetails->revenue_recognition_date
;
558 if (!CRM_Utils_System
::isNull($revenueRecognitionDate)) {
559 $statuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
561 && (CRM_Utils_Array
::value($contributionDetails->contribution_status_id
, $statuses) != 'Completed'
562 ||
(CRM_Utils_Array
::value($contributionDetails->contribution_status_id
, $statuses) != 'Pending'
563 && $contributionDetails->is_pay_later
)
569 'contribution_id' => $contributionDetails->id
,
570 'fee_amount' => '0.00',
571 'currency' => $contributionDetails->currency
,
572 'trxn_id' => $contributionDetails->trxn_id
,
573 'status_id' => $contributionDetails->contribution_status_id
,
574 'payment_instrument_id' => $contributionDetails->payment_instrument_id
,
575 'check_number' => $contributionDetails->check_number
,
578 $deferredRevenues = [];
579 foreach ($lineItems as $priceSetID => $lineItem) {
583 foreach ($lineItem as $key => $item) {
584 $lineTotal = !empty($item['deferred_line_total']) ?
$item['deferred_line_total'] : $item['line_total'];
585 if ($lineTotal <= 0 && !$update) {
588 $deferredRevenues[$key] = $item;
589 if ($context == 'changeFinancialType') {
590 $deferredRevenues[$key]['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_LineItem', $item['id'], 'financial_type_id');
592 if (in_array($item['entity_table'],
593 ['civicrm_participant', 'civicrm_contribution'])
595 $deferredRevenues[$key]['revenue'][] = [
596 'amount' => $lineTotal,
597 'revenue_date' => $revenueRecognitionDate,
602 $item['line_total'] = $lineTotal;
603 $deferredRevenues[$key]['revenue'] = self
::getMembershipRevenueAmount($item);
607 $accountRel = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Income Account is' "));
609 CRM_Utils_Hook
::alterDeferredRevenueItems($deferredRevenues, $contributionDetails, $update, $context);
611 foreach ($deferredRevenues as $key => $deferredRevenue) {
612 $results = civicrm_api3('EntityFinancialAccount', 'get', [
613 'entity_table' => 'civicrm_financial_type',
614 'entity_id' => $deferredRevenue['financial_type_id'],
615 'account_relationship' => ['IN' => ['Income Account is', 'Deferred Revenue Account is']],
617 if ($results['count'] != 2) {
620 foreach ($results['values'] as $result) {
621 if ($result['account_relationship'] == $accountRel) {
622 $trxnParams['from_financial_account_id'] = $result['financial_account_id'];
625 $trxnParams['to_financial_account_id'] = $result['financial_account_id'];
628 foreach ($deferredRevenue['revenue'] as $revenue) {
629 $trxnParams['total_amount'] = $trxnParams['net_amount'] = $revenue['amount'];
630 $trxnParams['trxn_date'] = CRM_Utils_Date
::isoToMysql($revenue['revenue_date']);
631 $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($trxnParams);
633 'entity_id' => $deferredRevenue['financial_item_id'],
634 'entity_table' => 'civicrm_financial_item',
635 'amount' => $revenue['amount'],
636 'financial_trxn_id' => $financialTxn->id
,
638 civicrm_api3('EntityFinancialTrxn', 'create', $entityParams);
645 * Update Credit Card Details in civicrm_financial_trxn table.
647 * @param int $contributionID
648 * @param int $panTruncation
649 * @param int $cardType
652 public static function updateCreditCardDetails($contributionID, $panTruncation, $cardType) {
653 $financialTrxn = civicrm_api3('EntityFinancialTrxn', 'get', [
654 'return' => ['financial_trxn_id.payment_processor_id', 'financial_trxn_id'],
655 'entity_table' => 'civicrm_contribution',
656 'entity_id' => $contributionID,
657 'financial_trxn_id.is_payment' => TRUE,
658 'options' => ['sort' => 'financial_trxn_id DESC', 'limit' => 1],
661 // In case of Contribution status is Pending From Incomplete Transaction or Failed there is no Financial Entries created for Contribution.
662 // Above api will return 0 count, in such case we won't update card type and pan truncation field.
663 if (!$financialTrxn['count']) {
667 $financialTrxn = $financialTrxn['values'][$financialTrxn['id']];
668 $paymentProcessorID = CRM_Utils_Array
::value('financial_trxn_id.payment_processor_id', $financialTrxn);
670 if ($paymentProcessorID) {
674 $financialTrxnId = $financialTrxn['financial_trxn_id'];
675 $trxnparams = ['id' => $financialTrxnId];
676 if (isset($cardType)) {
677 $trxnparams['card_type_id'] = $cardType;
679 if (isset($panTruncation)) {
680 $trxnparams['pan_truncation'] = $panTruncation;
682 civicrm_api3('FinancialTrxn', 'create', $trxnparams);
686 * The function is responsible for handling financial entries if payment instrument is changed
688 * @param array $inputParams
691 public static function updateFinancialAccountsOnPaymentInstrumentChange($inputParams) {
692 $prevContribution = $inputParams['prevContribution'];
693 $currentContribution = $inputParams['contribution'];
694 // ensure that there are all the information in updated contribution object identified by $currentContribution
695 $currentContribution->find(TRUE);
697 $deferredFinancialAccount = CRM_Utils_Array
::value('deferred_financial_account_id', $inputParams);
698 if (empty($deferredFinancialAccount)) {
699 $deferredFinancialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($prevContribution->financial_type_id
, 'Deferred Revenue Account is');
702 $lastFinancialTrxnId = self
::getFinancialTrxnId($prevContribution->id
, 'DESC', FALSE, NULL, $deferredFinancialAccount);
704 // there is no point to proceed as we can't find the last payment made
705 // @todo we should throw an exception here rather than return false.
706 if (empty($lastFinancialTrxnId['financialTrxnId'])) {
710 // If payment instrument is changed reverse the last payment
711 // in terms of reversing financial item and trxn
712 $lastFinancialTrxn = civicrm_api3('FinancialTrxn', 'getsingle', ['id' => $lastFinancialTrxnId['financialTrxnId']]);
713 unset($lastFinancialTrxn['id']);
714 $lastFinancialTrxn['trxn_date'] = $inputParams['trxnParams']['trxn_date'];
715 $lastFinancialTrxn['total_amount'] = -$inputParams['trxnParams']['total_amount'];
716 $lastFinancialTrxn['net_amount'] = -$inputParams['trxnParams']['net_amount'];
717 $lastFinancialTrxn['fee_amount'] = -$inputParams['trxnParams']['fee_amount'];
718 $lastFinancialTrxn['contribution_id'] = $prevContribution->id
;
719 foreach ([$lastFinancialTrxn, $inputParams['trxnParams']] as $financialTrxnParams) {
720 $trxn = CRM_Core_BAO_FinancialTrxn
::create($financialTrxnParams);
722 'total_amount' => $trxn->total_amount
,
723 'contribution_id' => $currentContribution->id
,
725 CRM_Contribute_BAO_Contribution
::assignProportionalLineItems($trxnParams, $trxn->id
, $prevContribution->total_amount
);
728 self
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $inputParams), $currentContribution, TRUE, 'changePaymentInstrument');
734 * Generate and assign an arbitrary value to a field of a test object.
736 * Always set is_payment to 1 as this is used for Payment api as well as FinancialTrxn.
738 * @param string $fieldName
739 * @param array $fieldDef
740 * @param int $counter
741 * The globally-unique ID of the test object.
743 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
744 if ($fieldName === 'is_payment') {
745 $this->is_payment
= 1;
748 parent
::assignTestValue($fieldName, $fieldDef, $counter);