/**
* Test getPartialPaymentTrxn function.
*/
public function testGetPartialPaymentTrxn()
{
$contributionTest = new CRM_Contribute_BAO_ContributionTest();
list($lineItems, $contribution) = $contributionTest->addParticipantWithContribution();
$contribution = (array) $contribution;
$params = array('contribution_id' => $contribution['id'], 'total_amount' => 100.0);
$trxn = CRM_Core_BAO_FinancialTrxn::getPartialPaymentTrxn($contribution, $params);
$this->assertEquals('100.00', $trxn->total_amount, 'Amount does not match.');
$totalPaymentAmount = CRM_Core_BAO_FinancialTrxn::getTotalPayments($contribution['id']);
$this->assertEquals('250.00', $totalPaymentAmount, 'Amount does not match.');
}
/**
* Test getTotalPayments function.
*/
public function testGetTotalPayments()
{
$contactId = $this->individualCreate();
$params = array('contact_id' => $contactId, 'currency' => 'USD', 'financial_type_id' => 1, 'contribution_status_id' => 2, 'payment_instrument_id' => 1, 'source' => 'STUDENT', 'is_pay_later' => 1, 'receive_date' => '20080522000000', 'receipt_date' => '20080522000000', 'non_deductible_amount' => 0.0, 'total_amount' => 200.0, 'fee_amount' => 5, 'net_amount' => 195, 'trxn_id' => '22ereerwwe4444yy', 'invoice_id' => '86ed39e9e9yy6ef6541621ce0eafe7eb81', 'thankyou_date' => '20080522');
$contribution = CRM_Contribute_BAO_Contribution::create($params);
$this->assertEquals($params['trxn_id'], $contribution->trxn_id);
$this->assertEquals($contactId, $contribution->contact_id);
$totalPaymentAmount = CRM_Core_BAO_FinancialTrxn::getTotalPayments($contribution->id);
$this->assertEquals(0, $totalPaymentAmount, 'Amount not matching.');
//update contribution amount
$params['id'] = $contribution->id;
$params['contribution_status_id'] = 1;
$contribution = CRM_Contribute_BAO_Contribution::create($params);
$this->assertEquals($params['trxn_id'], $contribution->trxn_id);
$this->assertEquals($params['contribution_status_id'], $contribution->contribution_status_id);
$totalPaymentAmount = CRM_Core_BAO_FinancialTrxn::getTotalPayments($contribution->id);
$this->assertEquals('200.00', $totalPaymentAmount, 'Amount not matching.');
}
/**
* Function records partial payment, complete's contribution if payment is fully paid
* and returns latest payment ie financial trxn
*
* @param array $contribution
* @param array $params
*
* @return CRM_Core_BAO_FinancialTrxn
*/
public static function getPartialPaymentTrxn($contribution, $params)
{
$trxn = CRM_Contribute_BAO_Contribution::recordPartialPayment($contribution, $params);
$paid = CRM_Core_BAO_FinancialTrxn::getTotalPayments($params['contribution_id']);
$total = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution_id'], 'total_amount');
$cmp = bccomp($total, $paid, 5);
if ($cmp == 0 || $cmp == -1) {
// If paid amount is greater or equal to total amount
civicrm_api3('Contribution', 'completetransaction', array('id' => $contribution['id']));
}
return $trxn;
}
/**
* Add a payment for a Contribution.
*
* @param array $params
* Input parameters.
*
* @throws API_Exception
* @return array
* Api result array
*/
function civicrm_api3_payment_create(&$params)
{
// Check if it is an update
if (CRM_Utils_Array::value('id', $params)) {
$amount = $params['total_amount'];
civicrm_api3('Payment', 'cancel', $params);
$params['total_amount'] = $amount;
}
// Get contribution
$contribution = civicrm_api3('Contribution', 'getsingle', array('id' => $params['contribution_id']));
if ($contribution['contribution_status'] != 'Partially paid') {
throw new API_Exception('Please select a contribution which has a partial payment');
} else {
$trxn = CRM_Contribute_BAO_Contribution::recordPartialPayment($contribution, $params);
$paid = CRM_Core_BAO_FinancialTrxn::getTotalPayments($params['contribution_id']);
$total = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution_id'], 'total_amount');
$cmp = bccomp($total, $paid, 5);
if ($cmp == 0 || $cmp == -1) {
// If paid amount is greater or equal to total amount
civicrm_api3('Contribution', 'completetransaction', array('id' => $contribution['id']));
}
}
if (CRM_Utils_Array::value('line_item', $params) && !empty($trxn)) {
foreach ($params['line_item'] as $values) {
foreach ($values as $id => $amount) {
$p = array('id' => $id);
$check = CRM_Price_BAO_LineItem::retrieve($p, $defaults);
if (empty($check)) {
throw new API_Exception('Please specify a valid Line Item.');
}
// get financial item
$sql = "SELECT fi.id\n FROM civicrm_financial_item fi\n INNER JOIN civicrm_line_item li ON li.id = fi.entity_id\n WHERE li.contribution_id = %1 AND li.id = %2";
$sqlParams = array(1 => array($params['contribution_id'], 'Integer'), 2 => array($id, 'Integer'));
$fid = CRM_Core_DAO::singleValueQuery($sql, $sqlParams);
// Record Entity Financial Trxn
$eftParams = array('entity_table' => 'civicrm_financial_item', 'financial_trxn_id' => $trxn->id, 'amount' => $amount, 'entity_id' => $fid);
civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
}
}
} elseif (!empty($trxn)) {
// Assign the lineitems proportionally
CRM_Contribute_BAO_Contribution::assignProportionalLineItems($params, $trxn, $contribution);
}
$values = array();
_civicrm_api3_object_to_array_unique_fields($trxn, $values[$trxn->id]);
return civicrm_api3_create_success($values, $params, 'Payment', 'create', $trxn);
}
