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 +--------------------------------------------------------------------+
12 use Civi\Api4\ActivityContact
;
13 use Civi\Api4\Contribution
;
14 use Civi\Api4\PriceField
;
15 use Civi\Api4\PriceFieldValue
;
16 use Civi\Api4\PriceSet
;
19 * Test APIv3 civicrm_contribute_* functions
21 * @package CiviCRM_APIv3
22 * @subpackage API_Contribution
25 class api_v3_ContributionTest
extends CiviUnitTestCase
{
27 use CRMTraits_Profile_ProfileTrait
;
28 use CRMTraits_Custom_CustomDataTrait
;
29 use CRMTraits_Financial_OrderTrait
;
30 use CRMTraits_Financial_TaxTrait
;
31 use CRMTraits_Financial_PriceSetTrait
;
33 protected $_individualId;
34 protected $_contribution;
35 protected $_financialTypeId = 1;
36 protected $entity = 'Contribution';
39 protected $_pageParams = [];
42 * Payment processor ID (dummy processor).
46 protected $paymentProcessorID;
49 * Parameters to create payment processor.
53 protected $_processorParams = [];
56 * ID of created event.
68 * Should financials be checked after the test but before tear down.
72 protected $isValidateFinancialsOnPostAssert = TRUE;
77 public function setUp(): void
{
80 $this->_apiversion
= 3;
81 $this->_individualId
= $this->individualCreate();
83 'contact_id' => $this->_individualId
,
84 'receive_date' => '20120511',
85 'total_amount' => 100.00,
86 'financial_type_id' => $this->_financialTypeId
,
87 'non_deductible_amount' => 10.00,
89 'net_amount' => 95.00,
91 'contribution_status_id' => 1,
93 $this->_processorParams
= [
96 'payment_processor_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Financial_BAO_PaymentProcessor', 'payment_processor_type_id', 'Dummy'),
97 'financial_account_id' => 12,
100 'url_site' => 'http://dummy.com',
101 'url_recur' => 'http://dummy.com',
104 $this->paymentProcessorID
= $this->processorCreate();
105 $this->_pageParams
= [
106 'title' => 'Test Contribution Page',
107 'financial_type_id' => 1,
109 'financial_account_id' => 1,
110 'payment_processor' => $this->paymentProcessorID
,
112 'is_allow_other_amount' => 1,
114 'max_amount' => 1000,
119 * Clean up after each test.
121 * @throws \API_Exception
122 * @throws \CRM_Core_Exception
124 public function tearDown(): void
{
125 $this->quickCleanUpFinancialEntities();
126 $this->quickCleanup(['civicrm_uf_match'], TRUE);
127 $financialAccounts = $this->callAPISuccess('FinancialAccount', 'get', ['return' => 'name']);
128 foreach ($financialAccounts['values'] as $financialAccount) {
129 if ($financialAccount['name'] === 'Test Tax financial account ' ||
$financialAccount['name'] === 'Test taxable financial Type') {
130 $entityFinancialTypes = $this->callAPISuccess('EntityFinancialAccount', 'get', [
131 'financial_account_id' => $financialAccount['id'],
133 foreach ($entityFinancialTypes['values'] as $entityFinancialType) {
134 $this->callAPISuccess('EntityFinancialAccount', 'delete', ['id' => $entityFinancialType['id']]);
136 $this->callAPISuccess('FinancialAccount', 'delete', ['id' => $financialAccount['id']]);
139 $this->restoreUFGroupOne();
146 public function testGetContribution(): void
{
147 $this->enableTaxAndInvoicing();
149 'contact_id' => $this->_individualId
,
150 'receive_date' => '2010-01-20',
151 'total_amount' => 100.00,
152 'financial_type_id' => $this->_financialTypeId
,
153 'non_deductible_amount' => 10.00,
154 'fee_amount' => 5.00,
155 'net_amount' => 95.00,
157 'invoice_id' => 78910,
159 'contribution_status_id' => 'Completed',
161 $this->_contribution
= $this->callAPISuccess('contribution', 'create', $p);
164 'contribution_id' => $this->_contribution
['id'],
165 'return' => array_merge(['invoice_number', 'contribution_source'], array_keys($p)),
168 $contributions = $this->callAPIAndDocument('Contribution', 'get', $params, __FUNCTION__
, __FILE__
);
170 $this->assertEquals(1, $contributions['count']);
171 $contribution = $contributions['values'][$contributions['id']];
172 $this->assertEquals($this->_individualId
, $contribution['contact_id']);
173 $this->assertEquals(1, $contribution['financial_type_id']);
174 $this->assertEquals(100.00, $contribution['total_amount']);
175 $this->assertEquals(10.00, $contribution['non_deductible_amount']);
176 $this->assertEquals(5.00, $contribution['fee_amount']);
177 $this->assertEquals(95.00, $contribution['net_amount']);
178 $this->assertEquals(23456, $contribution['trxn_id']);
179 $this->assertEquals(78910, $contribution['invoice_id']);
180 $this->assertRegExp('/INV_\d+/', $contribution['invoice_number']);
181 $this->assertEquals('SSF', $contribution['contribution_source']);
182 $this->assertEquals('Completed', $contribution['contribution_status']);
183 // Create a second contribution - we are testing that 'id' gets the right contribution id (not the contact id).
184 $p['trxn_id'] = '3847';
185 $p['invoice_id'] = '3847';
187 $contribution2 = $this->callAPISuccess('contribution', 'create', $p);
189 // Now we have 2 - test getcount.
190 $contribution = $this->callAPISuccess('contribution', 'getcount');
191 $this->assertEquals(2, $contribution);
192 // Test id only format.
193 $contribution = $this->callAPISuccess('contribution', 'get', [
194 'id' => $this->_contribution
['id'],
195 'format.only_id' => 1,
197 $this->assertEquals($this->_contribution
['id'], $contribution, print_r($contribution, TRUE));
198 // Test id only format.
199 $contribution = $this->callAPISuccess('contribution', 'get', [
200 'id' => $contribution2['id'],
201 'format.only_id' => 1,
203 $this->assertEquals($contribution2['id'], $contribution);
205 $contribution = $this->callAPISuccess('contribution', 'get', [
206 'id' => $this->_contribution
['id'],
208 $this->assertEquals(1, $contribution['count']);
210 // Test get by contact id works.
211 $contribution = $this->callAPISuccess('contribution', 'get', ['contact_id' => $this->_individualId
]);
213 $this->assertEquals(2, $contribution['count']);
214 $this->callAPISuccess('Contribution', 'Delete', [
215 'id' => $this->_contribution
['id'],
217 $this->callAPISuccess('Contribution', 'Delete', [
218 'id' => $contribution2['id'],
223 * Test that test contributions can be retrieved.
225 * @throws \CRM_Core_Exception
227 public function testGetTestContribution(): void
{
228 $this->callAPISuccess('Contribution', 'create', array_merge($this->_params
, ['is_test' => 1]));
229 $this->callAPISuccessGetSingle('Contribution', ['is_test' => 1]);
233 * Test Creating a check contribution with original check_number field
235 * @throws \CRM_Core_Exception
237 public function testCreateCheckContribution(): void
{
238 $params = $this->_params
;
239 $params['contribution_check_number'] = 'bouncer';
240 $params['payment_instrument_id'] = 'Check';
241 $params['cancel_date'] = 'yesterday';
242 $params['receipt_date'] = 'yesterday';
243 $params['thankyou_date'] = 'yesterday';
244 $params['revenue_recognition_date'] = 'yesterday';
245 $params['amount_level'] = 'Unreasonable';
246 $params['cancel_reason'] = 'You lose sucker';
247 $params['creditnote_id'] = 'sudo rm -rf';
248 $address = $this->callAPISuccess('Address', 'create', [
249 'street_address' => 'Knockturn Alley',
250 'contact_id' => $this->_individualId
,
251 'location_type_id' => 'Home',
253 $params['address_id'] = $address['id'];
254 $contributionPage = $this->contributionPageCreate();
255 $params['contribution_page_id'] = $contributionPage['id'];
256 $params['campaign_id'] = $this->campaignCreate();
257 $contributionID = $this->contributionCreate($params);
258 $getResult = $this->callAPISuccess('Contribution', 'get', [
259 'id' => $contributionID,
260 'return' => 'check_number',
261 ])['values'][$contributionID];
262 $this->assertEquals('bouncer', $getResult['check_number']);
263 $entityFinancialTrxn = $this->callAPISuccess('EntityFinancialTrxn', 'get', [
264 'entity_id' => $contributionID,
265 'entity_table' => 'civicrm_contribution',
266 'return' => 'financial_trxn_id',
268 foreach ($entityFinancialTrxn['values'] as $eft) {
269 $financialTrxn = $this->callAPISuccess('FinancialTrxn', 'get', [
270 'id' => $eft['financial_trxn_id'],
271 'return' => 'check_number',
273 $this->assertEquals('bouncer', $financialTrxn['values'][$financialTrxn['id']]['check_number']);
278 * Test the 'return' param works for all fields.
280 public function testGetContributionReturnFunctionality(): void
{
281 $params = $this->_params
;
282 $params['contribution_check_number'] = 'bouncer';
283 $params['payment_instrument_id'] = 'Check';
284 $params['cancel_date'] = 'yesterday';
285 $params['receipt_date'] = 'yesterday';
286 $params['thankyou_date'] = 'yesterday';
287 $params['revenue_recognition_date'] = 'yesterday';
288 $params['amount_level'] = 'Unreasonable';
289 $params['cancel_reason'] = 'You lose sucker';
290 $params['creditnote_id'] = 'sudo rm -rf';
291 $address = $this->callAPISuccess('Address', 'create', [
292 'street_address' => 'Knockturn Alley',
293 'contact_id' => $this->_individualId
,
294 'location_type_id' => 'Home',
296 $params['address_id'] = $address['id'];
297 $contributionPage = $this->contributionPageCreate();
298 $params['contribution_page_id'] = $contributionPage['id'];
299 $contributionRecur = $this->callAPISuccess('ContributionRecur', 'create', [
300 'contact_id' => $this->_individualId
,
301 'frequency_interval' => 1,
304 $params['contribution_recur_id'] = $contributionRecur['id'];
306 $params['campaign_id'] = $this->campaignCreate();
308 $contributionID = $this->contributionCreate($params);
310 // update contribution with invoice number
311 $params = array_merge($params, [
312 'id' => $contributionID,
313 'invoice_number' => Civi
::settings()->get('invoice_prefix') . $contributionID,
315 'invoice_id' => 6789,
317 $contributionID = $this->contributionCreate($params);
319 $contribution = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID]);
320 $this->assertEquals('bouncer', $contribution['check_number']);
321 $this->assertEquals('bouncer', $contribution['contribution_check_number']);
323 $fields = CRM_Contribute_BAO_Contribution
::fields();
324 // Do not check for tax_amount as this test has not enabled invoicing
325 // & hence it is not reliable.
326 unset($fields['tax_amount']);
327 // Re-add these 2 to the fields to check. They were locked in but the metadata changed so we
328 // need to specify them.
329 $fields['address_id'] = $fields['contribution_address_id'];
330 $fields['check_number'] = $fields['contribution_check_number'];
333 'contribution_id', 'contribution_contact_id', 'financial_type_id', 'contribution_page_id',
334 'payment_instrument_id', 'receive_date', 'non_deductible_amount', 'total_amount',
335 'fee_amount', 'net_amount', 'trxn_id', 'invoice_id', 'currency', 'contribution_cancel_date', 'cancel_reason',
336 'receipt_date', 'thankyou_date', 'contribution_source', 'amount_level', 'contribution_recur_id',
337 'is_test', 'is_pay_later', 'contribution_status_id', 'address_id', 'check_number', 'contribution_campaign_id',
338 'creditnote_id', 'revenue_recognition_date', 'decoy',
340 $missingFields = array_diff($fieldsLockedIn, array_keys($fields));
341 // If any of the locked in fields disappear from the $fields array we need to make sure it is still
342 // covered as the test contract now guarantees them in the return array.
343 $this->assertEquals([28 => 'decoy'], $missingFields, 'A field which was covered by the test contract has changed.');
344 foreach ($fields as $fieldName => $fieldSpec) {
345 $contribution = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID, 'return' => $fieldName]);
346 $returnField = $fieldName;
347 if ($returnField === 'contribution_contact_id') {
348 $returnField = 'contact_id';
350 $this->assertTrue((!empty($contribution[$returnField]) ||
$contribution[$returnField] === "0"), $returnField);
352 $entityFinancialTrxn = $this->callAPISuccess('EntityFinancialTrxn', 'get', [
353 'entity_id' => $contributionID,
354 'entity_table' => 'civicrm_contribution',
355 'return' => 'financial_trxn_id',
357 foreach ($entityFinancialTrxn['values'] as $eft) {
358 $financialTrxn = $this->callAPISuccess('FinancialTrxn', 'get', ['id' => $eft['financial_trxn_id'], 'return' => 'check_number']);
359 $this->assertEquals('bouncer', $financialTrxn['values'][$financialTrxn['id']]['check_number']);
364 * Test cancel reason works as a filter.
366 * @throws \CRM_Core_Exception
368 public function testFilterCancelReason(): void
{
369 $params = $this->_params
;
370 $params['cancel_date'] = 'yesterday';
371 $params['cancel_reason'] = 'You lose sucker';
372 $this->callAPISuccess('Contribution', 'create', $params);
373 $params = $this->_params
;
374 $params['cancel_date'] = 'yesterday';
375 $params['cancel_reason'] = 'You are a winner';
376 $this->callAPISuccess('Contribution', 'create', $params);
377 $this->callAPISuccessGetCount('Contribution', ['cancel_reason' => 'You are a winner'], 1);
381 * We need to ensure previous tested api contract behaviour still works.
383 * @throws \CRM_Core_Exception
385 public function testGetContributionLegacyBehaviour(): void
{
387 'contact_id' => $this->_individualId
,
388 'receive_date' => '2010-01-20',
389 'total_amount' => 100.00,
390 'contribution_type_id' => $this->_financialTypeId
,
391 'non_deductible_amount' => 10.00,
392 'fee_amount' => 5.00,
393 'net_amount' => 95.00,
395 'invoice_id' => 78910,
397 'contribution_status_id' => 1,
399 $this->_contribution
= $this->callAPISuccess('Contribution', 'create', $p);
402 'contribution_id' => $this->_contribution
['id'],
403 'return' => array_keys($p),
405 $params['return'][] = 'financial_type_id';
406 $params['return'][] = 'contribution_source';
407 $contribution = $this->callAPISuccess('Contribution', 'get', $params);
409 $this->assertEquals(1, $contribution['count']);
410 $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId
);
411 $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], $this->_financialTypeId
);
412 $this->assertEquals($contribution['values'][$contribution['id']]['contribution_type_id'], $this->_financialTypeId
);
413 $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
414 $this->assertEquals($contribution['values'][$contribution['id']]['non_deductible_amount'], 10.00);
415 $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 5.00);
416 $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 95.00);
417 $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 23456);
418 $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 78910);
419 $this->assertEquals($contribution['values'][$contribution['id']]['contribution_source'], 'SSF');
420 $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed');
422 // Create a second contribution - we are testing that 'id' gets the right contribution id (not the contact id).
423 $p['trxn_id'] = '3847';
424 $p['invoice_id'] = '3847';
426 $contribution2 = $this->callAPISuccess('contribution', 'create', $p);
428 // now we have 2 - test getcount
429 $contribution = $this->callAPISuccess('contribution', 'getcount', []);
430 $this->assertEquals(2, $contribution);
431 //test id only format
432 $contribution = $this->callAPISuccess('contribution', 'get', [
433 'id' => $this->_contribution
['id'],
434 'format.only_id' => 1,
436 $this->assertEquals($this->_contribution
['id'], $contribution, print_r($contribution, TRUE));
437 //test id only format
438 $contribution = $this->callAPISuccess('contribution', 'get', [
439 'id' => $contribution2['id'],
440 'format.only_id' => 1,
442 $this->assertEquals($contribution2['id'], $contribution);
443 $contribution = $this->callAPISuccess('contribution', 'get', [
444 'id' => $this->_contribution
['id'],
447 $this->assertEquals(1, $contribution['count']);
448 // $this->assertEquals($this->_contribution['id'], $contribution['id'] ) ;
449 //test get by contact id works
450 $contribution = $this->callAPISuccess('contribution', 'get', ['contact_id' => $this->_individualId
]);
452 $this->assertEquals(2, $contribution['count']);
453 $this->callAPISuccess('Contribution', 'Delete', [
454 'id' => $this->_contribution
['id'],
456 $this->callAPISuccess('Contribution', 'Delete', [
457 'id' => $contribution2['id'],
462 * Create an contribution_id=FALSE and financial_type_id=Donation.
464 public function testCreateEmptyContributionIDUseDonation() {
466 'contribution_id' => FALSE,
469 'check_permissions' => FALSE,
470 'financial_type_id' => 'Donation',
472 $this->callAPISuccess('contribution', 'create', $params);
476 * Check with complete array + custom field.
478 * Note that the test is written on purpose without any
479 * variables specific to participant so it can be replicated into other entities
480 * and / or moved to the automated test suite
482 * @throws \CRM_Core_Exception
484 public function testCreateWithCustom(): void
{
485 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
487 $params = $this->_params
;
488 $params['custom_' . $ids['custom_field_id']] = "custom string";
490 $result = $this->callAPIAndDocument($this->entity
, 'create', $params, __FUNCTION__
, __FILE__
);
491 $this->assertEquals($result['id'], $result['values'][$result['id']]['id']);
492 $check = $this->callAPISuccess($this->entity
, 'get', [
493 'return.custom_' . $ids['custom_field_id'] => 1,
494 'id' => $result['id'],
496 $this->assertEquals('custom string', $check['values'][$check['id']]['custom_' . $ids['custom_field_id']]);
500 * Check with complete array + custom field.
502 * Note that the test is written on purpose without any
503 * variables specific to participant so it can be replicated into other
504 * entities and / or moved to the automated test suite
506 * @throws \CRM_Core_Exception
508 public function testCreateGetFieldsWithCustom(): void
{
509 $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, __FILE__
);
510 $idsContact = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, 'ContactTest.php');
511 $result = $this->callAPISuccess('Contribution', 'getfields', []);
512 $this->assertArrayHasKey('custom_' . $ids['custom_field_id'], $result['values']);
513 $this->assertArrayNotHasKey('custom_' . $idsContact['custom_field_id'], $result['values']);
514 $this->customFieldDelete($ids['custom_field_id']);
515 $this->customGroupDelete($ids['custom_group_id']);
516 $this->customFieldDelete($idsContact['custom_field_id']);
517 $this->customGroupDelete($idsContact['custom_group_id']);
521 * Test creating a contribution without skipLineItems.
523 * @throws \CRM_Core_Exception
525 public function testCreateContributionNoLineItems(): void
{
526 // Turn off this validation as this test results in invalid
527 // financial entities.
528 $this->isValidateFinancialsOnPostAssert
= FALSE;
530 'contact_id' => $this->_individualId
,
531 'receive_date' => '20120511',
532 'total_amount' => 100.00,
533 'financial_type_id' => $this->_financialTypeId
,
534 'payment_instrument_id' => 1,
535 'non_deductible_amount' => 10.00,
536 'fee_amount' => 50.00,
537 'net_amount' => 90.00,
539 'invoice_id' => 67890,
541 'contribution_status_id' => 1,
545 $contribution = $this->callAPISuccess('Contribution', 'create', $params);
546 $financialItems = $this->callAPISuccess('FinancialItem', 'get', ['return' => 'transaction_date']);
547 foreach ($financialItems['values'] as $financialItem) {
548 $this->assertEquals(date('Y-m-d H:i:s', strtotime($contribution['values'][$contribution['id']]['receive_date'])), date('Y-m-d H:i:s', strtotime($financialItem['transaction_date'])));
550 $this->callAPISuccessGetCount('LineItem', [
551 'entity_id' => $contribution['id'],
552 'entity_table' => 'civicrm_contribution',
558 * Test checks that passing in line items suppresses the create mechanism.
560 * @throws \CRM_Core_Exception
562 public function testCreateContributionChainedLineItems(): void
{
564 'contact_id' => $this->_individualId
,
565 'receive_date' => '20120511',
566 'total_amount' => 100.00,
567 'financial_type_id' => $this->_financialTypeId
,
568 'payment_instrument_id' => 1,
569 'non_deductible_amount' => 10.00,
570 'fee_amount' => 50.00,
571 'net_amount' => 90.00,
573 'invoice_id' => 67890,
575 'contribution_status_id' => 'Pending',
577 'api.line_item.create' => [
579 'price_field_id' => 1,
581 'line_total' => '20',
582 'unit_price' => '10',
585 'price_field_id' => 1,
587 'line_total' => '80',
588 'unit_price' => '80',
593 $description = 'Create Contribution with Nested Line Items.';
594 $subFile = 'CreateWithNestedLineItems';
595 $contribution = $this->callAPIAndDocument('Contribution', 'create', $params, __FUNCTION__
, __FILE__
, $description, $subFile);
597 $this->callAPISuccessGetCount('LineItem', [
598 'entity_id' => $contribution['id'],
599 'contribution_id' => $contribution['id'],
600 'entity_table' => 'civicrm_contribution',
606 * @throws \CRM_Core_Exception
608 public function testCreateContributionOffline(): void
{
610 'contact_id' => $this->_individualId
,
611 'receive_date' => '20120511',
612 'total_amount' => 100.00,
613 'financial_type_id' => 1,
615 'invoice_id' => 67890,
617 'contribution_status_id' => 1,
621 $contribution = $this->callAPISuccess('Contribution', 'create', $params)['values'][0];
622 $this->assertEquals($this->_individualId
, $contribution['contact_id']);
623 $this->assertEquals(100.00, $contribution['total_amount']);
624 $this->assertEquals(1, $contribution['financial_type_id']);
625 $this->assertEquals(12345, $contribution['trxn_id']);
626 $this->assertEquals(67890, $contribution['invoice_id']);
627 $this->assertEquals('SSF', $contribution['source']);
628 $this->assertEquals(1, $contribution['contribution_status_id']);
629 $lineItems = $this->callAPISuccess('LineItem', 'get', [
630 'entity_id' => $contribution['id'],
631 'contribution_id' => $contribution['id'],
632 'entity_table' => 'civicrm_contribution',
634 'return' => ['entity_id', 'contribution_id'],
636 $this->assertEquals(1, $lineItems['count']);
637 $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
638 $this->assertEquals($contribution['id'], $lineItems['values'][0]['contribution_id']);
639 $this->_checkFinancialRecords($contribution, 'offline');
640 $this->contributionGetnCheck($params, $contribution['id']);
644 * Test create with valid payment instrument.
646 * @throws \CRM_Core_Exception
648 public function testCreateContributionWithPaymentInstrument(): void
{
649 $params = $this->_params +
['payment_instrument' => 'EFT'];
650 $contribution = $this->callAPISuccess('contribution', 'create', $params);
651 $contribution = $this->callAPISuccess('contribution', 'get', [
653 'id' => $contribution['id'],
654 'return' => 'payment_instrument',
656 $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
657 $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
659 $this->callAPISuccess('Contribution', 'create', [
660 'id' => $contribution['id'],
661 'payment_instrument' => 'Credit Card',
663 $contribution = $this->callAPISuccess('Contribution', 'get', [
665 'id' => $contribution['id'],
666 'return' => 'payment_instrument',
668 $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
669 $this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
673 * @throws \CRM_Core_Exception
675 public function testGetContributionByPaymentInstrument(): void
{
676 $params = $this->_params +
['payment_instrument' => 'EFT'];
677 $params2 = $this->_params +
['payment_instrument' => 'Cash'];
678 $this->callAPISuccess('contribution', 'create', $params);
679 $this->callAPISuccess('contribution', 'create', $params2);
680 $contribution = $this->callAPISuccess('Contribution', 'get', [
682 'contribution_payment_instrument' => 'Cash',
683 'return' => 'payment_instrument',
685 $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
686 $this->assertEquals('Cash', $contribution['values'][0]['payment_instrument']);
687 $this->assertEquals(1, $contribution['count']);
688 $contribution = $this->callAPISuccess('Contribution', 'get', ['sequential' => 1, 'payment_instrument' => 'Cash', 'return' => 'payment_instrument']);
689 $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
690 $this->assertEquals('Cash', $contribution['values'][0]['payment_instrument']);
691 $this->assertEquals(1, $contribution['count']);
692 $contribution = $this->callAPISuccess('Contribution', 'get', [
694 'payment_instrument_id' => 5,
695 'return' => 'payment_instrument',
697 $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
698 $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
699 $this->assertEquals(1, $contribution['count']);
700 $contribution = $this->callAPISuccess('Contribution', 'get', [
702 'payment_instrument' => 'EFT',
703 'return' => 'payment_instrument',
705 $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
706 $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
707 $this->assertEquals(1, $contribution['count']);
708 $contribution = $this->callAPISuccess('contribution', 'create', [
709 'id' => $contribution['id'],
710 'payment_instrument' => 'Credit Card',
711 'return' => 'payment_instrument',
713 $contribution = $this->callAPISuccess('Contribution', 'get', [
715 'id' => $contribution['id'],
716 'return' => 'payment_instrument',
718 $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
719 $this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
720 $this->assertEquals(1, $contribution['count']);
724 * CRM-16227 introduces invoice_id as a parameter.
726 * @throws \CRM_Core_Exception
728 public function testGetContributionByInvoice(): void
{
729 $this->callAPISuccess('Contribution', 'create', array_merge($this->_params
, ['invoice_id' => 'curly']));
730 $this->callAPISuccess('Contribution', 'create', array_merge($this->_params
), ['invoice_id' => 'churlish']);
731 $this->callAPISuccessGetCount('Contribution', [], 2);
732 $this->callAPISuccessGetCount('Contribution', ['invoice_id' => 'curly'], 1);
736 * Check the credit note retrieval is case insensitive.
738 * @throws \CRM_Core_Exception
740 public function testGetCreditNoteCaseInsensitive(): void
{
741 $this->contributionCreate(['contact_id' => $this->_individualId
]);
742 $this->contributionCreate(['creditnote_id' => 'cN1234', 'contact_id' => $this->_individualId
, 'invoice_id' => 91011, 'trxn_id' => 456]);
743 $contribution = $this->callAPISuccess('Contribution', 'getsingle', ['creditnote_id' => 'CN1234', 'return' => 'creditnote_id']);
744 $this->assertEquals('cN1234', $contribution['creditnote_id']);
748 * Test retrieval by total_amount works.
750 * @throws \CRM_Core_Exception
752 public function testGetContributionByTotalAmount(): void
{
753 $this->callAPISuccess('Contribution', 'create', array_merge($this->_params
, ['total_amount' => '5']));
754 $this->callAPISuccess('Contribution', 'create', array_merge($this->_params
, ['total_amount' => '10']));
755 $this->callAPISuccessGetCount('Contribution', ['total_amount' => 10], 1);
756 $this->callAPISuccessGetCount('Contribution', ['total_amount' => ['>' => 6]], 1);
757 $this->callAPISuccessGetCount('Contribution', ['total_amount' => ['>' => 0]], 2);
758 $this->callAPISuccessGetCount('Contribution', ['total_amount' => ['>' => -5]], 2);
759 $this->callAPISuccessGetCount('Contribution', ['total_amount' => ['<' => 0]], 0);
760 $this->callAPISuccessGetCount('Contribution', [], 2);
764 * @dataProvider createLocalizedContributionDataProvider
766 * @param float|int|string $totalAmount
767 * @param string $decimalPoint
768 * @param string $thousandSeparator
769 * @param string $currency
770 * @param bool $expectedResult
772 * @throws \CRM_Core_Exception
774 public function testCreateLocalizedContribution($totalAmount, string $decimalPoint, string $thousandSeparator, string $currency, bool $expectedResult): void
{
775 $this->setDefaultCurrency($currency);
776 $this->setMonetaryDecimalPoint($decimalPoint);
777 $this->setMonetaryThousandSeparator($thousandSeparator);
780 'contact_id' => $this->_individualId
,
781 'receive_date' => '20120511',
782 'total_amount' => $totalAmount,
783 'financial_type_id' => $this->_financialTypeId
,
784 'contribution_status_id' => 1,
787 if ($expectedResult) {
788 $this->callAPISuccess('Contribution', 'create', $_params);
791 $this->callAPIFailure('Contribution', 'create', $_params);
798 public function createLocalizedContributionDataProvider(): array {
800 [10, '.', ',', 'USD', TRUE],
801 ['145.0E+3', '.', ',', 'USD', FALSE],
802 ['10', '.', ',', 'USD', TRUE],
803 [-10, '.', ',', 'USD', TRUE],
804 ['-10', '.', ',', 'USD', TRUE],
805 ['-10foo', '.', ',', 'USD', FALSE],
806 ['-10.0345619', '.', ',', 'USD', TRUE],
807 ['-10.010,4345619', '.', ',', 'USD', TRUE],
808 ['10.0104345619', '.', ',', 'USD', TRUE],
809 ['-0', '.', ',', 'USD', TRUE],
810 ['-.1', '.', ',', 'USD', TRUE],
811 ['.1', '.', ',', 'USD', TRUE],
812 // Test currency symbols too, default locale uses $, so if we wanted to test others we'd need to reconfigure locale
813 ['$1,234,567.89', '.', ',', 'USD', TRUE],
814 ['-$1,234,567.89', '.', ',', 'USD', TRUE],
815 ['$-1,234,567.89', '.', ',', 'USD', TRUE],
816 // This is the float format. Encapsulated in strings
817 ['1234567.89', '.', ',', 'USD', TRUE],
818 // This is the float format.
819 [1234567.89, '.', ',', 'USD', TRUE],
820 // Test EURO currency
821 ['€1,234,567.89', '.', ',', 'EUR', TRUE],
822 ['-€1,234,567.89', '.', ',', 'EUR', TRUE],
823 ['€-1,234,567.89', '.', ',', 'EUR', TRUE],
824 // This is the float format. Encapsulated in strings
825 ['1234567.89', '.', ',', 'EUR', TRUE],
826 // This is the float format.
827 [1234567.89, '.', ',', 'EUR', TRUE],
828 // Test Norwegian KR currency
829 ['kr1,234,567.89', '.', ',', 'NOK', TRUE],
830 ['kr 1,234,567.89', '.', ',', 'NOK', TRUE],
831 ['-kr1,234,567.89', '.', ',', 'NOK', TRUE],
832 ['-kr 1,234,567.89', '.', ',', 'NOK', TRUE],
833 ['kr-1,234,567.89', '.', ',', 'NOK', TRUE],
834 ['kr -1,234,567.89', '.', ',', 'NOK', TRUE],
835 // This is the float format. Encapsulated in strings
836 ['1234567.89', '.', ',', 'NOK', TRUE],
837 // This is the float format.
838 [1234567.89, '.', ',', 'NOK', TRUE],
839 // Test different localization options: , as decimal separator and dot as thousand separator
840 ['$1.234.567,89', ',', '.', 'USD', TRUE],
841 ['-$1.234.567,89', ',', '.', 'USD', TRUE],
842 ['$-1.234.567,89', ',', '.', 'USD', TRUE],
843 ['1.234.567,89', ',', '.', 'USD', TRUE],
844 // This is the float format. Encapsulated in strings
845 ['1234567.89', ',', '.', 'USD', TRUE],
846 // This is the float format.
847 [1234567.89, ',', '.', 'USD', TRUE],
848 ['$1,234,567.89', ',', '.', 'USD', FALSE],
849 ['-$1,234,567.89', ',', '.', 'USD', FALSE],
850 ['$-1,234,567.89', ',', '.', 'USD', FALSE],
851 // Now with a space as thousand separator
852 ['$1 234 567,89', ',', ' ', 'USD', TRUE],
853 ['-$1 234 567,89', ',', ' ', 'USD', TRUE],
854 ['$-1 234 567,89', ',', ' ', 'USD', TRUE],
855 ['1 234 567,89', ',', ' ', 'USD', TRUE],
856 // This is the float format. Encapsulated in strings
857 ['1234567.89', ',', ' ', 'USD', TRUE],
858 // This is the float format.
859 [1234567.89, ',', ' ', 'USD', TRUE],
864 * Create test with unique field name on source.
866 public function testCreateContributionSource() {
869 'contact_id' => $this->_individualId
,
870 'receive_date' => date('Ymd'),
871 'total_amount' => 100.00,
872 'financial_type_id' => $this->_financialTypeId
,
873 'payment_instrument_id' => 1,
874 'non_deductible_amount' => 10.00,
875 'fee_amount' => 50.00,
876 'net_amount' => 90.00,
878 'invoice_id' => 67890,
879 'contribution_source' => 'SSF',
880 'contribution_status_id' => 1,
883 $contribution = $this->callAPISuccess('contribution', 'create', $params);
884 $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
885 $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
889 * Create test with unique field name on source.
891 * @param string $thousandSeparator
892 * punctuation used to refer to thousands.
894 * @dataProvider getThousandSeparators
896 public function testCreateDefaultNow($thousandSeparator) {
897 $this->setCurrencySeparators($thousandSeparator);
898 $params = $this->_params
;
899 unset($params['receive_date'], $params['net_amount']);
901 $params['total_amount'] = $this->formatMoneyInput(5000.77);
902 $params['fee_amount'] = $this->formatMoneyInput(.77);
903 $params['skipCleanMoney'] = FALSE;
905 $contribution = $this->callAPISuccess('contribution', 'create', $params);
906 $contribution = $this->callAPISuccessGetSingle('contribution', ['id' => $contribution['id']]);
907 $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receive_date'])));
908 $this->assertEquals(5000.77, $contribution['total_amount'], 'failed to handle ' . $this->formatMoneyInput(5000.77));
909 $this->assertEquals(.77, $contribution['fee_amount']);
910 $this->assertEquals(5000, $contribution['net_amount']);
914 * Create test with unique field name on source.
916 public function testCreateContributionNullOutThankyouDate() {
918 $params = $this->_params
;
919 $params['thankyou_date'] = 'yesterday';
921 $contribution = $this->callAPISuccess('contribution', 'create', $params);
922 $contribution = $this->callAPISuccessGetSingle('contribution', ['id' => $contribution['id']]);
923 $this->assertEquals(date('Y-m-d', strtotime('yesterday')), date('Y-m-d', strtotime($contribution['thankyou_date'])));
925 $params['thankyou_date'] = 'null';
926 $contribution = $this->callAPISuccess('contribution', 'create', $params);
927 $this->assertTrue(empty($contribution['thankyou_date']));
931 * Create test with unique field name on source.
933 public function testCreateContributionSourceInvalidContact() {
937 'receive_date' => date('Ymd'),
938 'total_amount' => 100.00,
939 'financial_type_id' => $this->_financialTypeId
,
940 'payment_instrument_id' => 1,
941 'non_deductible_amount' => 10.00,
942 'fee_amount' => 50.00,
943 'net_amount' => 90.00,
945 'invoice_id' => 67890,
946 'contribution_source' => 'SSF',
947 'contribution_status_id' => 1,
950 $this->callAPIFailure('contribution', 'create', $params, 'contact_id is not valid : 999');
954 * Test note created correctly.
956 * @throws \CRM_Core_Exception
958 public function testCreateContributionWithNote(): void
{
959 $description = 'Demonstrates creating contribution with Note Entity.';
960 $subFile = 'ContributionCreateWithNote';
962 'contact_id' => $this->_individualId
,
963 'receive_date' => '2012-01-01',
964 'total_amount' => 100.00,
965 'financial_type_id' => $this->_financialTypeId
,
966 'payment_instrument_id' => 1,
967 'non_deductible_amount' => 10.00,
968 'fee_amount' => 50.00,
969 'net_amount' => 90.00,
971 'invoice_id' => 67890,
973 'contribution_status_id' => 1,
974 'note' => 'my contribution note',
977 $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__
, __FILE__
, $description, $subFile);
978 $result = $this->callAPISuccess('note', 'get', [
979 'entity_table' => 'civicrm_contribution',
980 'entity_id' => $contribution['id'],
984 $this->assertEquals('my contribution note', $result['values'][0]['note']);
985 $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
989 * @throws \CRM_Core_Exception
991 public function testCreateContributionWithNoteUniqueNameAliases(): void
{
993 'contact_id' => $this->_individualId
,
994 'receive_date' => '2012-01-01',
995 'total_amount' => 100.00,
996 'financial_type_id' => $this->_financialTypeId
,
997 'payment_instrument_id' => 1,
998 'non_deductible_amount' => 10.00,
999 'fee_amount' => 50.00,
1000 'net_amount' => 90.00,
1002 'invoice_id' => 67890,
1004 'contribution_status_id' => 1,
1005 'contribution_note' => 'my contribution note',
1008 $contribution = $this->callAPISuccess('contribution', 'create', $params);
1009 $result = $this->callAPISuccess('note', 'get', [
1010 'entity_table' => 'civicrm_contribution',
1011 'entity_id' => $contribution['id'],
1015 $this->assertEquals('my contribution note', $result['values'][0]['note']);
1019 * This is the test for creating soft credits.
1021 public function testCreateContributionWithSoftCredit() {
1022 $description = "Demonstrates creating contribution with SoftCredit.";
1023 $subfile = "ContributionCreateWithSoftCredit";
1024 $contact2 = $this->callAPISuccess('Contact', 'create', [
1025 'display_name' => 'superman',
1026 'contact_type' => 'Individual',
1029 'contact_id' => $contact2['id'],
1031 'soft_credit_type_id' => 3,
1034 $params = $this->_params +
['soft_credit' => [1 => $softParams]];
1035 $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
1036 $result = $this->callAPISuccess('contribution', 'get', ['return' => 'soft_credit', 'sequential' => 1]);
1038 $this->assertEquals($softParams['contact_id'], $result['values'][0]['soft_credit'][1]['contact_id']);
1039 $this->assertEquals($softParams['amount'], $result['values'][0]['soft_credit'][1]['amount']);
1040 $this->assertEquals($softParams['soft_credit_type_id'], $result['values'][0]['soft_credit'][1]['soft_credit_type']);
1042 $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
1043 $this->callAPISuccess('contact', 'delete', ['id' => $contact2['id']]);
1046 public function testCreateContributionWithSoftCreditDefaults() {
1047 $description = "Demonstrates creating contribution with Soft Credit defaults for amount and type.";
1048 $subfile = "ContributionCreateWithSoftCreditDefaults";
1049 $contact2 = $this->callAPISuccess('Contact', 'create', [
1050 'display_name' => 'superman',
1051 'contact_type' => 'Individual',
1053 $params = $this->_params +
[
1054 'soft_credit_to' => $contact2['id'],
1056 $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
1057 $result = $this->callAPISuccess('contribution', 'get', ['return' => 'soft_credit', 'sequential' => 1]);
1059 $this->assertEquals($contact2['id'], $result['values'][0]['soft_credit'][1]['contact_id']);
1060 // Default soft credit amount = contribution.total_amount
1061 $this->assertEquals($this->_params
['total_amount'], $result['values'][0]['soft_credit'][1]['amount']);
1062 $this->assertEquals(CRM_Core_OptionGroup
::getDefaultValue("soft_credit_type"), $result['values'][0]['soft_credit'][1]['soft_credit_type']);
1064 $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
1065 $this->callAPISuccess('contact', 'delete', ['id' => $contact2['id']]);
1069 * Test creating contribution with Soft Credit by passing in honor_contact_id.
1071 public function testCreateContributionWithHonoreeContact() {
1072 $description = "Demonstrates creating contribution with Soft Credit by passing in honor_contact_id.";
1073 $subfile = "ContributionCreateWithHonoreeContact";
1074 $contact2 = $this->callAPISuccess('Contact', 'create', [
1075 'display_name' => 'superman',
1076 'contact_type' => 'Individual',
1078 $params = $this->_params +
[
1079 'honor_contact_id' => $contact2['id'],
1081 $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__
, __FILE__
, $description, $subfile);
1082 $result = $this->callAPISuccess('contribution', 'get', ['return' => 'soft_credit', 'sequential' => 1]);
1084 $this->assertEquals($contact2['id'], $result['values'][0]['soft_credit'][1]['contact_id']);
1085 // Default soft credit amount = contribution.total_amount
1086 // Legacy mode in create api (honor_contact_id param) uses the standard "In Honor of" soft credit type
1087 $this->assertEquals($this->_params
['total_amount'], $result['values'][0]['soft_credit'][1]['amount']);
1088 $softCreditValueTypeID = $result['values'][0]['soft_credit'][1]['soft_credit_type'];
1089 $this->assertEquals('in_honor_of', CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $softCreditValueTypeID));
1091 $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
1092 $this->callAPISuccess('contact', 'delete', ['id' => $contact2['id']]);
1096 * Test using example code.
1098 public function testContributionCreateExample() {
1099 //make sure at least on page exists since there is a truncate in tear down
1100 $this->callAPISuccess('contribution_page', 'create', $this->_pageParams
);
1101 require_once 'api/v3/examples/Contribution/Create.ex.php';
1102 $result = contribution_create_example();
1103 $id = $result['id'];
1104 $expectedResult = contribution_create_expectedresult();
1105 $this->checkArrayEquals($expectedResult, $result);
1106 $this->contributionDelete($id);
1110 * Function tests that additional financial records are created when fee amount is recorded.
1112 public function testCreateContributionWithFee() {
1114 'contact_id' => $this->_individualId
,
1115 'receive_date' => '20120511',
1116 'total_amount' => 100.00,
1118 'financial_type_id' => 1,
1120 'invoice_id' => 67890,
1122 'contribution_status_id' => 1,
1125 $contribution = $this->callAPISuccess('contribution', 'create', $params);
1126 $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId
);
1127 $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
1128 $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 50.00);
1129 $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 50.00);
1130 $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
1131 $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
1132 $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
1133 $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
1134 $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
1136 $lineItems = $this->callAPISuccess('line_item', 'get', [
1138 'entity_id' => $contribution['id'],
1139 'entity_table' => 'civicrm_contribution',
1141 'return' => ['entity_id', 'contribution_id'],
1143 $this->assertEquals(1, $lineItems['count']);
1144 $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
1145 $this->assertEquals($contribution['id'], $lineItems['values'][0]['contribution_id']);
1146 $this->callAPISuccessGetCount('line_item', [
1148 'entity_id' => $contribution['id'],
1149 'contribution_id' => $contribution['id'],
1150 'entity_table' => 'civicrm_contribution',
1153 $this->_checkFinancialRecords($contribution, 'feeAmount');
1157 * Function tests that additional financial records are created when online
1158 * contribution is created.
1160 * @throws \CRM_Core_Exception
1161 * @throws \CiviCRM_API3_Exception
1163 public function testCreateContributionOnline(): void
{
1164 CRM_Financial_BAO_PaymentProcessor
::create($this->_processorParams
);
1165 $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams
);
1166 $this->assertAPISuccess($contributionPage);
1168 'contact_id' => $this->_individualId
,
1169 'receive_date' => '20120511',
1170 'total_amount' => 100.00,
1171 'financial_type_id' => 1,
1172 'contribution_page_id' => $contributionPage['id'],
1173 'payment_processor' => $this->paymentProcessorID
,
1175 'invoice_id' => 67890,
1177 'contribution_status_id' => 1,
1181 $contribution = $this->callAPISuccess('Contribution', 'create', $params);
1182 $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId
);
1183 $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
1184 $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
1185 $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
1186 $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
1187 $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
1188 $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
1189 $contribution['payment_instrument_id'] = $this->callAPISuccessGetValue('PaymentProcessor', [
1190 'id' => $this->paymentProcessorID
,
1191 'return' => 'payment_instrument_id',
1193 $this->_checkFinancialRecords($contribution, 'online');
1197 * Check handling of financial type.
1199 * In the interests of removing financial type / contribution type checks from
1200 * legacy format function lets test that the api is doing this for us
1202 public function testCreateInvalidFinancialType(): void
{
1203 $params = $this->_params
;
1204 $params['financial_type_id'] = 99999;
1205 $this->callAPIFailure($this->entity
, 'create', $params);
1209 * Check handling of financial type.
1211 * In the interests of removing financial type / contribution type checks from
1212 * legacy format function lets test that the api is doing this for us
1214 * @throws \CRM_Core_Exception
1216 public function testValidNamedFinancialType() {
1217 $params = $this->_params
;
1218 $params['financial_type_id'] = 'Donation';
1219 $this->callAPISuccess($this->entity
, 'create', $params);
1223 * Tests that additional financial records are created.
1225 * Checks when online contribution with pay later option is created
1227 * @throws \CRM_Core_Exception
1229 public function testCreateContributionPayLaterOnline(): void
{
1230 $this->_pageParams
['is_pay_later'] = 1;
1231 $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams
);
1232 $this->assertAPISuccess($contributionPage);
1234 'contact_id' => $this->_individualId
,
1235 'receive_date' => '20120511',
1236 'total_amount' => 100.00,
1237 'financial_type_id' => 1,
1238 'contribution_page_id' => $contributionPage['id'],
1240 'is_pay_later' => 1,
1241 'invoice_id' => 67890,
1243 'contribution_status_id' => 'Pending',
1247 $contribution = $this->callAPIAndDocument('Contribution', 'create', $params, __FUNCTION__
, __FILE__
);
1248 $contribution = $contribution['values'][$contribution['id']];
1249 $this->assertEquals($contribution['contact_id'], $this->_individualId
);
1250 $this->assertEquals($contribution['total_amount'], 100.00);
1251 $this->assertEquals($contribution['financial_type_id'], 1);
1252 $this->assertEquals($contribution['trxn_id'], 12345);
1253 $this->assertEquals($contribution['invoice_id'], 67890);
1254 $this->assertEquals($contribution['source'], 'SSF');
1255 $this->assertEquals($contribution['contribution_status_id'], 2);
1256 $this->_checkFinancialRecords($contribution, 'payLater');
1260 * Function tests that additional financial records are created for online contribution with pending option.
1262 public function testCreateContributionPendingOnline() {
1263 CRM_Financial_BAO_PaymentProcessor
::create($this->_processorParams
);
1264 $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams
);
1265 $this->assertAPISuccess($contributionPage);
1267 'contact_id' => $this->_individualId
,
1268 'receive_date' => '20120511',
1269 'total_amount' => 100.00,
1270 'financial_type_id' => 1,
1271 'contribution_page_id' => $contributionPage['id'],
1273 'invoice_id' => 67890,
1275 'contribution_status_id' => 2,
1278 $contribution = $this->callAPISuccess('contribution', 'create', $params);
1279 $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId
);
1280 $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
1281 $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
1282 $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
1283 $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
1284 $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
1285 $this->assertEquals(2, $contribution['values'][$contribution['id']]['contribution_status_id']);
1286 $this->_checkFinancialRecords($contribution, 'pending');
1290 * Test that BAO defaults work.
1292 * @throws \CRM_Core_Exception
1294 public function testCreateBAODefaults() {
1295 unset($this->_params
['contribution_source_id'], $this->_params
['payment_instrument_id']);
1296 $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params
);
1297 $contribution = $this->callAPISuccess('Contribution', 'getsingle', [
1298 'id' => $contribution['id'],
1299 'api.contribution.delete' => 1,
1300 'return' => ['contribution_status_id', 'payment_instrument'],
1302 $this->assertEquals(1, $contribution['contribution_status_id']);
1303 $this->assertEquals('Check', $contribution['payment_instrument']);
1304 $this->callAPISuccessGetCount('Contribution', ['id' => $contribution['id']], 0);
1308 * Test that getsingle can be chained with delete.
1310 * @throws CRM_Core_Exception
1312 public function testDeleteChainedGetSingle() {
1313 $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params
);
1314 $contribution = $this->callAPISuccess('Contribution', 'getsingle', [
1315 'id' => $contribution['id'],
1316 'api.contribution.delete' => 1,
1319 $this->callAPISuccessGetCount('Contribution', ['id' => $contribution['id']], 0);
1323 * Function tests that line items, financial records are updated when contribution amount is changed.
1325 * @throws \CRM_Core_Exception
1327 public function testCreateUpdateContributionChangeTotal() {
1328 $contribution = $this->callAPISuccess('contribution', 'create', $this->_params
);
1329 $lineItems = $this->callAPISuccess('line_item', 'getvalue', [
1331 'entity_id' => $contribution['id'],
1332 'entity_table' => 'civicrm_contribution',
1334 'return' => 'line_total',
1336 $this->assertEquals('100.00', $lineItems);
1337 $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
1338 // Financial trxn SUM = 100 + 5 (fee)
1339 $this->assertEquals('105.00', $trxnAmount);
1342 'id' => $contribution['id'],
1343 'total_amount' => '125',
1345 $contribution = $this->callAPISuccess('Contribution', 'create', $newParams);
1347 $lineItems = $this->callAPISuccess('line_item', 'getvalue', [
1349 'entity_id' => $contribution['id'],
1350 'entity_table' => 'civicrm_contribution',
1352 'return' => 'line_total',
1355 $this->assertEquals('125.00', $lineItems);
1356 $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
1358 // Financial trxn SUM = 125 + 5 (fee).
1359 $this->assertEquals('130.00', $trxnAmount);
1360 $this->assertEquals('125.00', $this->_getFinancialItemAmount($contribution['id']));
1364 * Function tests that line items, financial records are updated when pay later contribution is received.
1366 public function testCreateUpdateContributionPayLater() {
1368 'contact_id' => $this->_individualId
,
1369 'receive_date' => '2012-01-01',
1370 'total_amount' => 100.00,
1371 'financial_type_id' => $this->_financialTypeId
,
1372 'payment_instrument_id' => 1,
1373 'contribution_status_id' => 2,
1374 'is_pay_later' => 1,
1377 $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1379 $newParams = array_merge($contribParams, [
1380 'id' => $contribution['id'],
1381 'contribution_status_id' => 1,
1383 $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1384 $contribution = $contribution['values'][$contribution['id']];
1385 $this->assertEquals($contribution['contribution_status_id'], '1');
1386 $this->_checkFinancialItem($contribution['id'], 'paylater');
1387 $this->_checkFinancialTrxn($contribution, 'payLater');
1391 * Function tests that financial records are updated when Payment Instrument is changed.
1393 public function testCreateUpdateContributionPaymentInstrument() {
1394 $instrumentId = $this->_addPaymentInstrument();
1396 'contact_id' => $this->_individualId
,
1397 'total_amount' => 100.00,
1398 'financial_type_id' => $this->_financialTypeId
,
1399 'payment_instrument_id' => 4,
1400 'contribution_status_id' => 1,
1403 $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1405 $newParams = array_merge($contribParams, [
1406 'id' => $contribution['id'],
1407 'payment_instrument_id' => $instrumentId,
1409 $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1410 $this->assertAPISuccess($contribution);
1411 $this->checkFinancialTrxnPaymentInstrumentChange($contribution['id'], 4, $instrumentId);
1413 // cleanup - delete created payment instrument
1414 $this->_deletedAddedPaymentInstrument();
1418 * Function tests that financial records are updated when Payment Instrument is changed when amount is negative.
1420 public function testCreateUpdateNegativeContributionPaymentInstrument() {
1421 $instrumentId = $this->_addPaymentInstrument();
1423 'contact_id' => $this->_individualId
,
1424 'total_amount' => -100.00,
1425 'financial_type_id' => $this->_financialTypeId
,
1426 'payment_instrument_id' => 4,
1427 'contribution_status_id' => 1,
1430 $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1432 $newParams = array_merge($contribParams, [
1433 'id' => $contribution['id'],
1434 'payment_instrument_id' => $instrumentId,
1436 $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1437 $this->assertAPISuccess($contribution);
1438 $this->checkFinancialTrxnPaymentInstrumentChange($contribution['id'], 4, $instrumentId, -100);
1440 // cleanup - delete created payment instrument
1441 $this->_deletedAddedPaymentInstrument();
1445 * Function tests that financial records are added when Contribution is Refunded.
1447 * @throws \CRM_Core_Exception
1449 public function testCreateUpdateContributionRefund() {
1450 $contributionParams = [
1451 'contact_id' => $this->_individualId
,
1452 'receive_date' => '2012-01-01',
1453 'total_amount' => 100.00,
1454 'financial_type_id' => $this->_financialTypeId
,
1455 'payment_instrument_id' => 4,
1456 'contribution_status_id' => 1,
1457 'trxn_id' => 'original_payment',
1459 $contribution = $this->callAPISuccess('Contribution', 'create', $contributionParams);
1460 $newParams = array_merge($contributionParams, [
1461 'id' => $contribution['id'],
1462 'contribution_status_id' => 'Refunded',
1463 'cancel_date' => '2015-01-01 09:00',
1464 'refund_trxn_id' => 'the refund',
1467 $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1468 $this->_checkFinancialTrxn($contribution, 'refund');
1469 $this->_checkFinancialItem($contribution['id'], 'refund');
1470 $this->assertEquals('original_payment', $this->callAPISuccessGetValue('Contribution', [
1471 'id' => $contribution['id'],
1472 'return' => 'trxn_id',
1477 * Refund a contribution for a financial type with a contra account.
1479 * CRM-17951 the contra account is a financial account with a relationship to a
1480 * financial type. It is not always configured but should be reflected
1481 * in the financial_trxn & financial_item table if it is.
1483 * @throws \CRM_Core_Exception
1485 public function testCreateUpdateChargebackContributionDefaultAccount() {
1486 $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params
);
1487 $this->callAPISuccess('Contribution', 'create', [
1488 'id' => $contribution['id'],
1489 'contribution_status_id' => 'Chargeback',
1491 $this->callAPISuccessGetSingle('Contribution', ['contribution_status_id' => 'Chargeback']);
1493 $lineItems = $this->callAPISuccessGetSingle('LineItem', [
1494 'contribution_id' => $contribution['id'],
1495 'api.FinancialItem.getsingle' => ['amount' => ['<' => 0]],
1497 $this->assertEquals(1, $lineItems['api.FinancialItem.getsingle']['financial_account_id']);
1498 $this->callAPISuccessGetSingle('FinancialTrxn', [
1499 'total_amount' => -100,
1500 'status_id' => 'Chargeback',
1501 'to_financial_account_id' => 6,
1506 * Refund a contribution for a financial type with a contra account.
1508 * CRM-17951 the contra account is a financial account with a relationship to a
1509 * financial type. It is not always configured but should be reflected
1510 * in the financial_trxn & financial_item table if it is.
1512 * @throws \CRM_Core_Exception
1514 public function testCreateUpdateChargebackContributionCustomAccount() {
1515 $financialAccount = $this->callAPISuccess('FinancialAccount', 'create', [
1516 'name' => 'Chargeback Account',
1517 'is_active' => TRUE,
1520 $entityFinancialAccount = $this->callAPISuccess('EntityFinancialAccount', 'create', [
1521 'entity_id' => $this->_financialTypeId
,
1522 'entity_table' => 'civicrm_financial_type',
1523 'account_relationship' => 'Chargeback Account is',
1524 'financial_account_id' => 'Chargeback Account',
1527 $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params
);
1528 $this->callAPISuccess('Contribution', 'create', [
1529 'id' => $contribution['id'],
1530 'contribution_status_id' => 'Chargeback',
1532 $this->callAPISuccessGetSingle('Contribution', ['contribution_status_id' => 'Chargeback']);
1534 $lineItems = $this->callAPISuccessGetSingle('LineItem', [
1535 'contribution_id' => $contribution['id'],
1536 'api.FinancialItem.getsingle' => ['amount' => ['<' => 0]],
1538 $this->assertEquals($financialAccount['id'], $lineItems['api.FinancialItem.getsingle']['financial_account_id']);
1540 $this->callAPISuccess('Contribution', 'delete', ['id' => $contribution['id']]);
1541 $this->callAPISuccess('EntityFinancialAccount', 'delete', ['id' => $entityFinancialAccount['id']]);
1542 $this->callAPISuccess('FinancialAccount', 'delete', ['id' => $financialAccount['id']]);
1546 * Refund a contribution for a financial type with a contra account.
1548 * CRM-17951 the contra account is a financial account with a relationship to a
1549 * financial type. It is not always configured but should be reflected
1550 * in the financial_trxn & financial_item table if it is.
1552 public function testCreateUpdateRefundContributionConfiguredContraAccount() {
1553 $financialAccount = $this->callAPISuccess('FinancialAccount', 'create', [
1554 'name' => 'Refund Account',
1555 'is_active' => TRUE,
1558 $entityFinancialAccount = $this->callAPISuccess('EntityFinancialAccount', 'create', [
1559 'entity_id' => $this->_financialTypeId
,
1560 'entity_table' => 'civicrm_financial_type',
1561 'account_relationship' => 'Credit/Contra Revenue Account is',
1562 'financial_account_id' => 'Refund Account',
1565 $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params
);
1566 $this->callAPISuccess('Contribution', 'create', [
1567 'id' => $contribution['id'],
1568 'contribution_status_id' => 'Refunded',
1571 $lineItems = $this->callAPISuccessGetSingle('LineItem', [
1572 'contribution_id' => $contribution['id'],
1573 'api.FinancialItem.getsingle' => ['amount' => ['<' => 0]],
1575 $this->assertEquals($financialAccount['id'], $lineItems['api.FinancialItem.getsingle']['financial_account_id']);
1577 $this->callAPISuccess('Contribution', 'delete', ['id' => $contribution['id']]);
1578 $this->callAPISuccess('EntityFinancialAccount', 'delete', ['id' => $entityFinancialAccount['id']]);
1579 $this->callAPISuccess('FinancialAccount', 'delete', ['id' => $financialAccount['id']]);
1583 * Function tests that trxn_id is set when passed in.
1585 * Here we ensure that the civicrm_financial_trxn.trxn_id & the civicrm_contribution.trxn_id are set
1586 * when trxn_id is passed in.
1588 public function testCreateUpdateContributionRefundTrxnIDPassedIn() {
1589 $contributionParams = [
1590 'contact_id' => $this->_individualId
,
1591 'receive_date' => '2012-01-01',
1592 'total_amount' => 100.00,
1593 'financial_type_id' => $this->_financialTypeId
,
1594 'payment_instrument_id' => 4,
1595 'contribution_status_id' => 1,
1596 'trxn_id' => 'original_payment',
1598 $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
1599 $newParams = array_merge($contributionParams, [
1600 'id' => $contribution['id'],
1601 'contribution_status_id' => 'Refunded',
1602 'cancel_date' => '2015-01-01 09:00',
1603 'trxn_id' => 'the refund',
1606 $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1607 $this->_checkFinancialTrxn($contribution, 'refund');
1608 $this->_checkFinancialItem($contribution['id'], 'refund');
1609 $this->assertEquals('the refund', $this->callAPISuccessGetValue('Contribution', [
1610 'id' => $contribution['id'],
1611 'return' => 'trxn_id',
1616 * Function tests that trxn_id is set when passed in.
1618 * Here we ensure that the civicrm_contribution.trxn_id is set
1619 * when trxn_id is passed in but if refund_trxn_id is different then that
1620 * is kept for the refund transaction.
1622 public function testCreateUpdateContributionRefundRefundAndTrxnIDPassedIn() {
1623 $contributionParams = [
1624 'contact_id' => $this->_individualId
,
1625 'receive_date' => '2012-01-01',
1626 'total_amount' => 100.00,
1627 'financial_type_id' => $this->_financialTypeId
,
1628 'payment_instrument_id' => 4,
1629 'contribution_status_id' => 1,
1630 'trxn_id' => 'original_payment',
1632 $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
1633 $newParams = array_merge($contributionParams, [
1634 'id' => $contribution['id'],
1635 'contribution_status_id' => 'Refunded',
1636 'cancel_date' => '2015-01-01 09:00',
1637 'trxn_id' => 'cont id',
1638 'refund_trxn_id' => 'the refund',
1641 $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1642 $this->_checkFinancialTrxn($contribution, 'refund');
1643 $this->_checkFinancialItem($contribution['id'], 'refund');
1644 $this->assertEquals('cont id', $this->callAPISuccessGetValue('Contribution', [
1645 'id' => $contribution['id'],
1646 'return' => 'trxn_id',
1651 * Function tests that refund_trxn_id is set when passed in empty.
1653 * Here we ensure that the civicrm_contribution.trxn_id is set
1654 * when trxn_id is passed in but if refund_trxn_id isset but empty then that
1655 * is kept for the refund transaction.
1657 public function testCreateUpdateContributionRefundRefundNullTrxnIDPassedIn() {
1658 $contributionParams = [
1659 'contact_id' => $this->_individualId
,
1660 'receive_date' => '2012-01-01',
1661 'total_amount' => 100.00,
1662 'financial_type_id' => $this->_financialTypeId
,
1663 'payment_instrument_id' => 4,
1664 'contribution_status_id' => 1,
1665 'trxn_id' => 'original_payment',
1667 $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
1668 $newParams = array_merge($contributionParams, [
1669 'id' => $contribution['id'],
1670 'contribution_status_id' => 'Refunded',
1671 'cancel_date' => '2015-01-01 09:00',
1672 'trxn_id' => 'cont id',
1673 'refund_trxn_id' => '',
1676 $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1677 $this->_checkFinancialTrxn($contribution, 'refund', NULL, ['trxn_id' => NULL]);
1678 $this->_checkFinancialItem($contribution['id'], 'refund');
1679 $this->assertEquals('cont id', $this->callAPISuccessGetValue('Contribution', [
1680 'id' => $contribution['id'],
1681 'return' => 'trxn_id',
1686 * Function tests invalid contribution status change.
1688 public function testCreateUpdateContributionInValidStatusChange() {
1691 'receive_date' => '2012-01-01',
1692 'total_amount' => 100.00,
1693 'financial_type_id' => 1,
1694 'payment_instrument_id' => 1,
1695 'contribution_status_id' => 1,
1697 $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1698 $newParams = array_merge($contribParams, [
1699 'id' => $contribution['id'],
1700 'contribution_status_id' => 2,
1702 $this->callAPIFailure('contribution', 'create', $newParams, ts('Cannot change contribution status from Completed to Pending.'));
1707 * Function tests that financial records are added when Pending Contribution is Canceled.
1709 * @throws \CRM_Core_Exception
1711 public function testCreateUpdateContributionCancelPending() {
1713 'contact_id' => $this->_individualId
,
1714 'receive_date' => '2012-01-01',
1715 'total_amount' => 100.00,
1716 'financial_type_id' => $this->_financialTypeId
,
1717 'payment_instrument_id' => 1,
1718 'contribution_status_id' => 2,
1719 'is_pay_later' => 1,
1722 $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1723 $newParams = array_merge($contribParams, [
1724 'id' => $contribution['id'],
1725 'contribution_status_id' => 3,
1726 'cancel_date' => '2012-02-02 09:00',
1728 //Check if trxn_date is same as cancel_date.
1730 'trxn_date' => '2012-02-02 09:00:00',
1732 $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1733 $this->_checkFinancialTrxn($contribution, 'cancelPending', NULL, $checkTrxnDate);
1734 $this->_checkFinancialItem($contribution['id'], 'cancelPending');
1738 * Function tests that financial records are added when Financial Type is Changed.
1740 * @throws \CRM_Core_Exception
1742 public function testCreateUpdateContributionChangeFinancialType() {
1744 'contact_id' => $this->_individualId
,
1745 'receive_date' => '2012-01-01',
1746 'total_amount' => 100.00,
1747 'financial_type_id' => 1,
1748 'payment_instrument_id' => 1,
1749 'contribution_status_id' => 1,
1752 $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1753 $newParams = array_merge($contribParams, [
1754 'id' => $contribution['id'],
1755 'financial_type_id' => 3,
1757 $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1758 $this->_checkFinancialTrxn($contribution, 'changeFinancial');
1759 $this->_checkFinancialItem($contribution['id'], 'changeFinancial');
1763 * Function tets that financial records are correctly added when financial type is changed
1765 * @throws \CRM_Core_Exception
1767 public function testCreateUpdateContributionWithFeeAmountChangeFinancialType() {
1769 'contact_id' => $this->_individualId
,
1770 'receive_date' => '2012-01-01',
1771 'total_amount' => 100.00,
1772 'fee_amount' => 0.57,
1773 'financial_type_id' => 1,
1774 'payment_instrument_id' => 1,
1775 'contribution_status_id' => 1,
1778 $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1779 $newParams = array_merge($contribParams, [
1780 'id' => $contribution['id'],
1781 'financial_type_id' => 3,
1783 $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1784 $this->_checkFinancialTrxn($contribution, 'changeFinancial', NULL, ['fee_amount' => '-0.57', 'net_amount' => '-99.43']);
1785 $this->_checkFinancialItem($contribution['id'], 'changeFinancial');
1789 * Test that update does not change status id CRM-15105.
1791 public function testCreateUpdateWithoutChangingPendingStatus() {
1792 $contribution = $this->callAPISuccess('contribution', 'create', array_merge($this->_params
, ['contribution_status_id' => 2]));
1793 $this->callAPISuccess('contribution', 'create', ['id' => $contribution['id'], 'source' => 'new source']);
1794 $contribution = $this->callAPISuccess('contribution', 'getsingle', [
1795 'id' => $contribution['id'],
1796 'api.contribution.delete' => 1,
1798 $this->assertEquals(2, $contribution['contribution_status_id']);
1802 * Test Updating a Contribution.
1804 * CHANGE: we require the API to do an incremental update
1806 public function testCreateUpdateContribution() {
1807 $contributionID = $this->contributionCreate([
1808 'contact_id' => $this->_individualId
,
1809 'trxn_id' => 212355,
1810 'financial_type_id' => $this->_financialTypeId
,
1811 'invoice_id' => 'old_invoice',
1814 'contribution_id' => $contributionID,
1816 $original = $this->callAPISuccess('contribution', 'get', $old_params);
1817 $this->assertEquals($original['id'], $contributionID);
1818 //set up list of old params, verify
1820 //This should not be required on update:
1821 $old_contact_id = $original['values'][$contributionID]['contact_id'];
1822 $old_payment_instrument = $original['values'][$contributionID]['instrument_id'];
1823 $old_fee_amount = $original['values'][$contributionID]['fee_amount'];
1824 $old_source = $original['values'][$contributionID]['contribution_source'];
1826 $old_trxn_id = $original['values'][$contributionID]['trxn_id'];
1827 $old_invoice_id = $original['values'][$contributionID]['invoice_id'];
1829 //check against values in CiviUnitTestCase::createContribution()
1830 $this->assertEquals($old_contact_id, $this->_individualId
);
1831 $this->assertEquals($old_fee_amount, 5.00);
1832 $this->assertEquals($old_source, 'SSF');
1833 $this->assertEquals($old_trxn_id, 212355);
1834 $this->assertEquals($old_invoice_id, 'old_invoice');
1836 'id' => $contributionID,
1837 'contact_id' => $this->_individualId
,
1838 'total_amount' => 105.00,
1839 'fee_amount' => 7.00,
1840 'financial_type_id' => $this->_financialTypeId
,
1841 'non_deductible_amount' => 22.00,
1842 'contribution_status_id' => 1,
1843 'note' => 'Donating for Noble Cause',
1846 $contribution = $this->callAPISuccess('contribution', 'create', $params);
1849 'contribution_id' => $contribution['id'],
1851 $contribution = $this->callAPISuccessGetSingle('contribution', $new_params);
1853 $this->assertEquals($contribution['contact_id'], $this->_individualId
);
1854 $this->assertEquals($contribution['total_amount'], 105.00);
1855 $this->assertEquals($contribution['financial_type_id'], $this->_financialTypeId
);
1856 $this->assertEquals($contribution['financial_type'], 'Donation');
1857 $this->assertEquals($contribution['instrument_id'], $old_payment_instrument);
1858 $this->assertEquals($contribution['non_deductible_amount'], 22.00);
1859 $this->assertEquals($contribution['fee_amount'], 7.00);
1860 $this->assertEquals($contribution['trxn_id'], $old_trxn_id);
1861 $this->assertEquals($contribution['invoice_id'], $old_invoice_id);
1862 $this->assertEquals($contribution['contribution_source'], $old_source);
1863 $this->assertEquals($contribution['contribution_status'], 'Completed');
1865 $this->assertEquals($contribution['net_amount'], $contribution['total_amount'] - $contribution['fee_amount']);
1868 'contribution_id' => $contributionID,
1870 $result = $this->callAPISuccess('contribution', 'delete', $params);
1871 $this->assertAPISuccess($result);
1875 * Check that net_amount is updated when a contribution is updated.
1877 * Update fee amount AND total amount, just fee amount, just total amount
1878 * and neither to check that net_amount is keep updated.
1880 public function testUpdateContributionNetAmountVariants() {
1881 $contributionID = $this->contributionCreate(['contact_id' => $this->individualCreate()]);
1883 $this->callAPISuccess('Contribution', 'create', [
1884 'id' => $contributionID,
1885 'total_amount' => 90,
1888 $contribution = $this->callAPISuccessGetSingle('Contribution', [
1889 'id' => $contributionID,
1890 'return' => ['net_amount', 'fee_amount', 'total_amount'],
1892 $this->assertEquals(6, $contribution['fee_amount']);
1893 $this->assertEquals(90, $contribution['total_amount']);
1894 $this->assertEquals(84, $contribution['net_amount']);
1896 $this->callAPISuccess('Contribution', 'create', [
1897 'id' => $contributionID,
1900 $contribution = $this->callAPISuccessGetSingle('Contribution', [
1901 'id' => $contributionID,
1902 'return' => ['net_amount', 'fee_amount', 'total_amount'],
1904 $this->assertEquals(3, $contribution['fee_amount']);
1905 $this->assertEquals(90, $contribution['total_amount']);
1906 $this->assertEquals(87, $contribution['net_amount']);
1908 $this->callAPISuccess('Contribution', 'create', [
1909 'id' => $contributionID,
1910 'total_amount' => 200,
1912 $contribution = $this->callAPISuccessGetSingle('Contribution', [
1913 'id' => $contributionID,
1914 'return' => ['net_amount', 'fee_amount', 'total_amount'],
1916 $this->assertEquals(3, $contribution['fee_amount']);
1917 $this->assertEquals(200, $contribution['total_amount']);
1918 $this->assertEquals(197, $contribution['net_amount']);
1920 $this->callAPISuccess('Contribution', 'create', [
1921 'id' => $contributionID,
1922 'payment_instrument' => 'Cash',
1924 $contribution = $this->callAPISuccessGetSingle('Contribution', [
1925 'id' => $contributionID,
1926 'return' => ['net_amount', 'fee_amount', 'total_amount'],
1928 $this->assertEquals(3, $contribution['fee_amount']);
1929 $this->assertEquals(200, $contribution['total_amount']);
1930 $this->assertEquals(197, $contribution['net_amount']);
1934 * Attempt (but fail) to delete a contribution without parameters.
1936 public function testDeleteEmptyParamsContribution() {
1938 $this->callAPIFailure('contribution', 'delete', $params);
1941 public function testDeleteWrongParamContribution() {
1943 'contribution_source' => 'SSF',
1945 $this->callAPIFailure('contribution', 'delete', $params);
1948 public function testDeleteContribution() {
1949 $contributionID = $this->contributionCreate([
1950 'contact_id' => $this->_individualId
,
1951 'financial_type_id' => $this->_financialTypeId
,
1954 'id' => $contributionID,
1956 $this->callAPIAndDocument('contribution', 'delete', $params, __FUNCTION__
, __FILE__
);
1960 * Test civicrm_contribution_search with empty params.
1962 * All available contributions expected.
1964 public function testSearchEmptyParams() {
1968 'contact_id' => $this->_individualId
,
1969 'receive_date' => date('Ymd'),
1970 'total_amount' => 100.00,
1971 'financial_type_id' => $this->_financialTypeId
,
1972 'non_deductible_amount' => 10.00,
1973 'fee_amount' => 5.00,
1974 'net_amount' => 95.00,
1976 'invoice_id' => 78910,
1978 'contribution_status_id' => 1,
1980 $contribution = $this->callAPISuccess('contribution', 'create', $p);
1982 $result = $this->callAPISuccess('contribution', 'get', $params);
1983 // We're taking the first element.
1984 $res = $result['values'][$contribution['id']];
1986 $this->assertEquals($p['contact_id'], $res['contact_id']);
1987 $this->assertEquals($p['total_amount'], $res['total_amount']);
1988 $this->assertEquals($p['financial_type_id'], $res['financial_type_id']);
1989 $this->assertEquals($p['net_amount'], $res['net_amount']);
1990 $this->assertEquals($p['non_deductible_amount'], $res['non_deductible_amount']);
1991 $this->assertEquals($p['fee_amount'], $res['fee_amount']);
1992 $this->assertEquals($p['trxn_id'], $res['trxn_id']);
1993 $this->assertEquals($p['invoice_id'], $res['invoice_id']);
1994 $this->assertEquals($p['source'], $res['contribution_source']);
1995 // contribution_status_id = 1 => Completed
1996 $this->assertEquals('Completed', $res['contribution_status']);
1998 $this->contributionDelete($contribution['id']);
2002 * Test civicrm_contribution_search. Success expected.
2004 public function testSearch() {
2006 'contact_id' => $this->_individualId
,
2007 'receive_date' => date('Ymd'),
2008 'total_amount' => 100.00,
2009 'financial_type_id' => $this->_financialTypeId
,
2010 'non_deductible_amount' => 10.00,
2011 'contribution_status_id' => 1,
2013 $contribution1 = $this->callAPISuccess('contribution', 'create', $p1);
2016 'contact_id' => $this->_individualId
,
2017 'receive_date' => date('Ymd'),
2018 'total_amount' => 200.00,
2019 'financial_type_id' => $this->_financialTypeId
,
2020 'non_deductible_amount' => 20.00,
2021 'trxn_id' => 5454565,
2022 'invoice_id' => 1212124,
2023 'fee_amount' => 50.00,
2024 'net_amount' => 60.00,
2025 'contribution_status_id' => 2,
2027 $contribution2 = $this->callAPISuccess('contribution', 'create', $p2);
2030 'contribution_id' => $contribution2['id'],
2032 $result = $this->callAPISuccess('contribution', 'get', $params);
2033 $res = $result['values'][$contribution2['id']];
2035 $this->assertEquals($p2['contact_id'], $res['contact_id']);
2036 $this->assertEquals($p2['total_amount'], $res['total_amount']);
2037 $this->assertEquals($p2['financial_type_id'], $res['financial_type_id']);
2038 $this->assertEquals($p2['net_amount'], $res['net_amount']);
2039 $this->assertEquals($p2['non_deductible_amount'], $res['non_deductible_amount']);
2040 $this->assertEquals($p2['fee_amount'], $res['fee_amount']);
2041 $this->assertEquals($p2['trxn_id'], $res['trxn_id']);
2042 $this->assertEquals($p2['invoice_id'], $res['invoice_id']);
2043 $this->assertEquals(CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending'), $res['contribution_status_id']);
2045 $this->contributionDelete($contribution1['id']);
2046 $this->contributionDelete($contribution2['id']);
2050 * Test completing a transaction via the API.
2052 * Note that we are creating a logged in user because email goes out from
2055 public function testCompleteTransaction() {
2056 $mut = new CiviMailUtils($this, TRUE);
2057 $this->swapMessageTemplateForTestTemplate();
2058 $this->createLoggedInUser();
2059 $params = array_merge($this->_params
, ['contribution_status_id' => 2]);
2060 $contribution = $this->callAPISuccess('contribution', 'create', $params);
2061 $this->callAPISuccess('contribution', 'completetransaction', [
2062 'id' => $contribution['id'],
2064 $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id']]);
2065 $this->assertEquals('SSF', $contribution['contribution_source']);
2066 $this->assertEquals('Completed', $contribution['contribution_status']);
2067 $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receipt_date'])));
2068 $mut->checkMailLog([
2069 'email:::anthony_anderson@civicrm.org',
2073 'receive_date:::' . date('Ymd', strtotime($contribution['receive_date'])),
2074 "receipt_date:::\n",
2075 'title:::Contribution',
2076 'contributionStatus:::Completed',
2079 $this->revertTemplateToReservedTemplate();
2083 * Test completing a transaction via the API with a non-USD transaction.
2085 public function testCompleteTransactionEuro() {
2086 $mut = new CiviMailUtils($this, TRUE);
2087 $this->swapMessageTemplateForTestTemplate();
2088 $this->createLoggedInUser();
2089 $params = array_merge($this->_params
, ['contribution_status_id' => 2, 'currency' => 'EUR']);
2090 $contribution = $this->callAPISuccess('contribution', 'create', $params);
2092 $this->callAPISuccess('contribution', 'completetransaction', [
2093 'id' => $contribution['id'],
2096 $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id']]);
2097 $this->assertEquals('SSF', $contribution['contribution_source']);
2098 $this->assertEquals('Completed', $contribution['contribution_status']);
2099 $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receipt_date'])));
2101 $entityFinancialTransactions = $this->getFinancialTransactionsForContribution($contribution['id']);
2102 $entityFinancialTransaction = reset($entityFinancialTransactions);
2103 $financialTrxn = $this->callAPISuccessGetSingle('FinancialTrxn', ['id' => $entityFinancialTransaction['financial_trxn_id']]);
2104 $this->assertEquals('EUR', $financialTrxn['currency']);
2106 $mut->checkMailLog([
2107 'email:::anthony_anderson@civicrm.org',
2111 'receive_date:::' . date('Ymd', strtotime($contribution['receive_date'])),
2112 "receipt_date:::\n",
2113 'title:::Contribution',
2114 'contributionStatus:::Completed',
2117 $this->revertTemplateToReservedTemplate();
2121 * Test to ensure mail is sent for pay later
2123 * @throws \CRM_Core_Exception
2124 * @throws \API_Exception
2126 public function testPayLater(): void
{
2127 $mut = new CiviMailUtils($this, TRUE);
2128 $this->swapMessageTemplateForTestTemplate();
2129 $this->createLoggedInUser();
2130 $contributionPageID = $this->createQuickConfigContributionPage();
2133 'id' => $contributionPageID,
2134 'price_' . $this->ids
['PriceField']['basic'] => $this->ids
['PriceFieldValue']['basic'],
2135 'contact_id' => $this->_individualId
,
2136 'email-5' => 'anthony_anderson@civicrm.org',
2137 'payment_processor_id' => 0,
2138 'currencyID' => 'USD',
2139 'is_pay_later' => 1,
2140 'invoiceID' => 'f28e1ddc86f8c4a0ff5bcf46393e4bc8',
2141 'description' => 'Online Contribution: Help Support CiviCRM!',
2143 $this->callAPISuccess('ContributionPage', 'submit', $params);
2145 $mut->checkMailLog([
2147 'email:::anthony_anderson@civicrm.org',
2148 'pay_later_receipt:::This is a pay later receipt',
2149 'contributionPageId:::' . $contributionPageID,
2150 'title:::Test Contribution Page',
2154 $this->revertTemplateToReservedTemplate();
2158 * Test to check whether contact billing address is used when no contribution address
2160 public function testBillingAddress() {
2161 $mut = new CiviMailUtils($this, TRUE);
2162 $this->swapMessageTemplateForTestTemplate();
2163 $this->createLoggedInUser();
2165 //Scenario 1: When Contact don't have any address
2166 $params = array_merge($this->_params
, ['contribution_status_id' => 2]);
2167 $contribution = $this->callAPISuccess('contribution', 'create', $params);
2168 $this->callAPISuccess('contribution', 'completetransaction', [
2169 'id' => $contribution['id'],
2171 $mut->checkMailLog([
2175 // Scenario 2: Contribution using address
2176 $address = $this->callAPISuccess('address', 'create', [
2177 'street_address' => 'contribution billing st',
2178 'location_type_id' => 2,
2179 'contact_id' => $this->_params
['contact_id'],
2181 $params = array_merge($this->_params
, [
2182 'contribution_status_id' => 2,
2183 'address_id' => $address['id'],
2186 $contribution = $this->callAPISuccess('contribution', 'create', $params);
2187 $this->callAPISuccess('contribution', 'completetransaction', [
2188 'id' => $contribution['id'],
2190 $mut->checkMailLog([
2191 'address:::contribution billing st',
2194 // Scenario 3: Contribution wtth no address but contact has a billing address
2195 $this->callAPISuccess('address', 'create', [
2196 'id' => $address['id'],
2197 'street_address' => 'is billing st',
2198 'contact_id' => $this->_params
['contact_id'],
2200 $params = array_merge($this->_params
, ['contribution_status_id' => 2]);
2201 $contribution = $this->callAPISuccess('contribution', 'create', $params);
2202 $this->callAPISuccess('contribution', 'completetransaction', [
2203 'id' => $contribution['id'],
2205 $mut->checkMailLog([
2206 'address:::is billing st',
2210 $this->revertTemplateToReservedTemplate();
2214 * Test completing a transaction via the API.
2216 * Note that we are creating a logged in user because email goes out from
2219 public function testCompleteTransactionFeeAmount() {
2220 $this->createLoggedInUser();
2221 $params = array_merge($this->_params
, ['contribution_status_id' => 2]);
2222 $contribution = $this->callAPISuccess('contribution', 'create', $params);
2223 $this->callAPISuccess('contribution', 'completetransaction', [
2224 'id' => $contribution['id'],
2225 'fee_amount' => '.56',
2226 'trxn_id' => '7778888',
2228 $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id'], 'sequential' => 1]);
2229 $this->assertEquals('Completed', $contribution['contribution_status']);
2230 $this->assertEquals('7778888', $contribution['trxn_id']);
2231 $this->assertEquals('0.56', $contribution['fee_amount']);
2232 $this->assertEquals('99.44', $contribution['net_amount']);
2236 * CRM-19126 Add test to verify when complete transaction is called tax
2237 * amount is not changed.
2239 * We start of with a pending contribution.
2240 * - total_amount (input) = 100
2241 * - total_amount post save (based on tax being added) = 105
2244 * - non_deductible_amount = 10
2247 * - sum of (calculated) line items = 105
2249 * Note the fee_amount should really be set when the payment is received
2250 * and whatever the non_deductible amount is, it is ignored.
2252 * The fee amount when the payment comes in is 6 rather than 5. The net_amount
2253 * and fee_amount should change, but not the total_amount or
2256 * @param string $thousandSeparator
2257 * punctuation used to refer to thousands.
2259 * @throws \API_Exception
2260 * @throws \CRM_Core_Exception
2261 * @dataProvider getThousandSeparators
2263 public function testCheckTaxAmount(string $thousandSeparator): void
{
2264 $this->setCurrencySeparators($thousandSeparator);
2265 $this->createFinancialTypeWithSalesTax();
2266 $financialTypeId = $this->ids
['FinancialType']['taxable'];
2268 $contributionID = $this->callAPISuccess('Order', 'create',
2269 array_merge($this->_params
, ['financial_type_id' => $financialTypeId])
2271 $contributionPrePayment = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID, 'return' => ['tax_amount', 'total_amount']]);
2272 $this->validateAllContributions();
2273 $this->callAPISuccess('Contribution', 'completetransaction', [
2274 'id' => $contributionID,
2275 'trxn_id' => '777788888',
2276 'fee_amount' => '6.00',
2279 $contributionPostPayment = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID, 'return' => ['tax_amount', 'fee_amount', 'net_amount']]);
2280 $this->assertEquals(4.76, $contributionPrePayment['tax_amount']);
2281 $this->assertEquals(4.76, $contributionPostPayment['tax_amount']);
2282 $this->assertEquals('6.00', $contributionPostPayment['fee_amount']);
2283 $this->assertEquals('94.00', $contributionPostPayment['net_amount']);
2284 $this->validateAllContributions();
2285 $this->validateAllPayments();
2289 * Test repeat contribution successfully creates line item.
2291 * @throws \CRM_Core_Exception
2293 public function testRepeatTransaction(): void
{
2294 $originalContribution = $this->setUpRepeatTransaction([], 'single');
2295 $this->callAPISuccess('contribution', 'repeattransaction', [
2296 'original_contribution_id' => $originalContribution['id'],
2297 'contribution_status_id' => 'Completed',
2301 'entity_id' => $originalContribution['id'],
2309 'financial_type_id',
2310 'deductible_amount',
2311 'price_field_value_id',
2315 $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2316 'entity_id' => $originalContribution['id'],
2318 $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2319 'entity_id' => $originalContribution['id'] +
1,
2321 unset($lineItem1['values'][0]['id'], $lineItem1['values'][0]['entity_id']);
2322 unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2323 $this->assertEquals($lineItem1['values'][0], $lineItem2['values'][0]);
2324 $this->_checkFinancialRecords([
2325 'id' => $originalContribution['id'] +
1,
2326 'payment_instrument_id' => $this->callAPISuccessGetValue('PaymentProcessor', [
2327 'id' => $originalContribution['payment_processor_id'],
2328 'return' => 'payment_instrument_id',
2334 * Test custom data is copied over from the template transaction.
2336 * (Over time various discussions have deemed this to be the most recent one, allowing
2337 * users to alter custom data going forwards. This is implemented for line items already.
2339 * @throws \API_Exception
2340 * @throws \CRM_Core_Exception
2342 public function testRepeatTransactionWithCustomData(): void
{
2343 $this->createCustomGroupWithFieldOfType(['extends' => 'Contribution', 'name' => 'Repeat'], 'text');
2344 $originalContribution = $this->setUpRepeatTransaction([], 'single', [$this->getCustomFieldName('text') => 'first']);
2345 $this->callAPISuccess('contribution', 'repeattransaction', [
2346 'contribution_recur_id' => $originalContribution['contribution_recur_id'],
2347 'contribution_status_id' => 'Completed',
2348 'trxn_id' => 'my_trxn',
2351 $contribution = Contribution
::get()
2352 ->addWhere('trxn_id', '=', 'my_trxn')
2353 ->addSelect('Custom_Group.Enter_text_here')
2355 ->execute()->first();
2356 $this->assertEquals('first', $contribution['Custom_Group.Enter_text_here']);
2358 Contribution
::update()->setValues(['Custom_Group.Enter_text_here' => 'second'])->addWhere('id', '=', $contribution['id'])->execute();
2360 $this->callAPISuccess('contribution', 'repeattransaction', [
2361 'original_contribution_id' => $originalContribution['id'],
2362 'contribution_status_id' => 'Completed',
2363 'trxn_id' => 'number_3',
2366 $contribution = Contribution
::get()
2367 ->addWhere('trxn_id', '=', 'number_3')
2368 ->setSelect(['id', 'Custom_Group.Enter_text_here'])
2369 ->execute()->first();
2370 $this->assertEquals('second', $contribution['Custom_Group.Enter_text_here']);
2374 * Test repeat contribution successfully creates line items (plural).
2376 * @throws \CRM_Core_Exception
2378 public function testRepeatTransactionLineItems(): void
{
2380 $originalContribution = $this->setUpRepeatTransaction([], 'multiple');
2381 $this->callAPISuccess('contribution', 'repeattransaction', [
2382 'original_contribution_id' => $originalContribution['id'],
2383 'contribution_status_id' => 'Completed',
2388 'entity_id' => $originalContribution['id'],
2396 'financial_type_id',
2397 'deductible_amount',
2398 'price_field_value_id',
2402 $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2403 'entity_id' => $originalContribution['id'],
2404 'options' => ['sort' => 'qty'],
2406 $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2407 'entity_id' => $originalContribution['id'] +
1,
2408 'options' => ['sort' => 'qty'],
2411 // unset id and entity_id for all of them to be able to compare the lineItems:
2412 unset($lineItem1[0]['id'], $lineItem1[0]['entity_id']);
2413 unset($lineItem2[0]['id'], $lineItem2[0]['entity_id']);
2414 $this->assertEquals($lineItem1[0], $lineItem2[0]);
2416 unset($lineItem1[1]['id'], $lineItem1[1]['entity_id']);
2417 unset($lineItem2[1]['id'], $lineItem2[1]['entity_id']);
2418 $this->assertEquals($lineItem1[1], $lineItem2[1]);
2420 // CRM-19309 so in future we also want to:
2421 // check that financial_line_items have been created for entity_id 3 and 4;
2423 $this->callAPISuccessGetCount('FinancialItem', ['description' => 'Sales Tax', 'amount' => 0], 0);
2427 * Test repeat contribution successfully creates is_test transaction.
2429 * @throws \CRM_Core_Exception
2431 public function testRepeatTransactionIsTest(): void
{
2432 $this->_params
['is_test'] = 1;
2433 $originalContribution = $this->setUpRepeatTransaction(['is_test' => 1], 'single');
2435 $this->callAPISuccess('contribution', 'repeattransaction', [
2436 'original_contribution_id' => $originalContribution['id'],
2437 'contribution_status_id' => 'Completed',
2438 'trxn_id' => '1234',
2440 $this->callAPISuccessGetCount('Contribution', ['contribution_test' => 1], 2);
2444 * Test repeat contribution passed in status.
2446 * @throws \CRM_Core_Exception
2448 public function testRepeatTransactionPassedInStatus(): void
{
2449 $originalContribution = $this->setUpRepeatTransaction([], 'single');
2451 $this->callAPISuccess('contribution', 'repeattransaction', [
2452 'original_contribution_id' => $originalContribution['id'],
2453 'contribution_status_id' => 'Pending',
2456 $this->callAPISuccessGetCount('Contribution', ['contribution_status_id' => 2], 1);
2460 * Test repeat contribution accepts recur_id instead of
2461 * original_contribution_id.
2463 * @throws \CRM_Core_Exception
2465 public function testRepeatTransactionAcceptRecurID(): void
{
2466 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2467 'contact_id' => $this->_individualId
,
2468 'installments' => '12',
2469 'frequency_interval' => '1',
2471 'contribution_status_id' => 1,
2472 'start_date' => '2012-01-01 00:00:00',
2473 'currency' => 'USD',
2474 'frequency_unit' => 'month',
2475 'payment_processor_id' => $this->paymentProcessorID
,
2477 $this->callAPISuccess('contribution', 'create', array_merge(
2479 ['contribution_recur_id' => $contributionRecur['id']])
2482 $this->callAPISuccess('contribution', 'repeattransaction', [
2483 'contribution_recur_id' => $contributionRecur['id'],
2484 'contribution_status_id' => 'Completed',
2491 * CRM-19873 Test repeattransaction if contribution_recur_id is a test.
2493 * @throws \CRM_Core_Exception
2495 public function testRepeatTransactionTestRecurId() {
2496 $contributionRecur = $this->callAPISuccess('ContributionRecur', 'create', [
2497 'contact_id' => $this->_individualId
,
2498 'frequency_interval' => '1',
2500 'contribution_status_id' => 1,
2501 'start_date' => '2017-01-01 00:00:00',
2502 'currency' => 'USD',
2503 'frequency_unit' => 'month',
2504 'payment_processor_id' => $this->paymentProcessorID
,
2507 $this->callAPISuccess('contribution', 'create', array_merge(
2510 'contribution_recur_id' => $contributionRecur['id'],
2515 $repeatedContribution = $this->callAPISuccess('contribution', 'repeattransaction', [
2516 'contribution_recur_id' => $contributionRecur['id'],
2517 'contribution_status_id' => 'Completed',
2518 'trxn_id' => 'magic_number',
2521 $this->assertEquals($contributionRecur['values'][1]['is_test'], $repeatedContribution['values'][2]['is_test']);
2525 * CRM-19945 Tests that Contribute.repeattransaction renews a membership when contribution status=Completed
2527 * @throws \CRM_Core_Exception
2529 public function testRepeatTransactionMembershipRenewCompletedContribution(): void
{
2530 [$originalContribution, $membership] = $this->setUpAutoRenewMembership();
2532 $this->callAPISuccess('Contribution', 'repeattransaction', [
2533 'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2534 'contribution_status_id' => 'Failed',
2537 $this->callAPISuccess('membership', 'create', [
2538 'id' => $membership['id'],
2539 'end_date' => 'yesterday',
2540 'status_id' => 'Expired',
2543 $contribution = $this->callAPISuccess('Contribution', 'repeattransaction', [
2544 'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2545 'contribution_status_id' => 'Completed',
2546 'trxn_id' => 'bobsled',
2549 $membershipStatusId = $this->callAPISuccess('membership', 'getvalue', [
2550 'id' => $membership['id'],
2551 'return' => 'status_id',
2554 $membership = $this->callAPISuccess('membership', 'get', [
2555 'id' => $membership['id'],
2558 $this->assertEquals('New', CRM_Core_PseudoConstant
::getName('CRM_Member_BAO_Membership', 'status_id', $membershipStatusId));
2560 $lineItem = $this->callAPISuccessGetSingle('LineItem', ['contribution_id' => $contribution['id']]);
2561 $this->assertEquals('civicrm_membership', $lineItem['entity_table']);
2562 $this->callAPISuccessGetCount('MembershipPayment', ['membership_id' => $membership['id']]);
2566 * This is one of those tests that locks in existing behaviour.
2568 * I feel like correct behaviour is arguable & has been discussed in the past. However, if the membership has
2569 * a date which says it should be expired then the result of repeattransaction is to push that date
2570 * to be one membership term from 'now' with status 'new'.
2572 public function testRepeattransactionRenewMembershipOldMembership() {
2573 $entities = $this->setUpAutoRenewMembership();
2574 $newStatusID = CRM_Core_PseudoConstant
::getKey('CRM_Member_BAO_Membership', 'status_id', 'New');
2575 $membership = $this->callAPISuccess('Membership', 'create', [
2576 'id' => $entities[1]['id'],
2577 'join_date' => '4 months ago',
2578 'start_date' => '3 months ago',
2579 'end_date' => '2 months ago',
2581 $membership = $membership['values'][$membership['id']];
2583 // This status does not appear to be calculated at all and is set to 'new'. Feels like a bug.
2584 $this->assertEquals($newStatusID, $membership['status_id']);
2586 // So it seems renewing this expired membership results in it's new status being current and it being pushed to a future date
2587 $this->callAPISuccess('Contribution', 'repeattransaction', ['original_contribution_id' => $entities[0]['id'], 'contribution_status_id' => 'Completed']);
2588 $membership = $this->callAPISuccessGetSingle('Membership', ['id' => $membership['id']]);
2589 // If this date calculation winds up being flakey the spirit of the test would be maintained by just checking
2590 // date is greater than today.
2591 $this->assertEquals(date('Y-m-d', strtotime('+ 1 month -1 day')), $membership['end_date']);
2592 $this->assertEquals($newStatusID, $membership['membership_type_id']);
2596 * CRM-19945 Tests that Contribute.repeattransaction DOES NOT renew a membership when contribution status=Failed
2598 * @dataProvider contributionStatusProvider
2600 * @throws \CRM_Core_Exception
2602 public function testRepeatTransactionMembershipRenewContributionNotCompleted($contributionStatus): void
{
2603 // Completed status should renew so we don't test that here
2604 // In Progress status was never actually intended to be available for contributions.
2605 // Partially paid is not valid.
2606 if (in_array($contributionStatus['name'], ['Completed', 'In Progress', 'Partially paid'])) {
2609 [$originalContribution, $membership] = $this->setUpAutoRenewMembership();
2611 $this->callAPISuccess('Contribution', 'repeattransaction', [
2612 'original_contribution_id' => $originalContribution['id'],
2613 'contribution_status_id' => 'Completed',
2616 $this->callAPISuccess('membership', 'create', [
2617 'id' => $membership['id'],
2618 'end_date' => 'yesterday',
2619 'status_id' => 'Expired',
2622 $contribution = $this->callAPISuccess('contribution', 'repeattransaction', [
2623 'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2624 'contribution_status_id' => $contributionStatus['name'],
2625 'trxn_id' => 'bobsled',
2628 $updatedMembership = $this->callAPISuccess('membership', 'getsingle', ['id' => $membership['id']]);
2630 $dateTime = new DateTime('yesterday');
2631 $this->assertEquals($dateTime->format('Y-m-d'), $updatedMembership['end_date']);
2632 $this->assertEquals(CRM_Core_PseudoConstant
::getKey('CRM_Member_BAO_Membership', 'status_id', 'Expired'), $updatedMembership['status_id']);
2634 $lineItem = $this->callAPISuccessGetSingle('LineItem', ['contribution_id' => $contribution['id']]);
2635 $this->assertEquals('civicrm_membership', $lineItem['entity_table']);
2636 $this->callAPISuccessGetCount('MembershipPayment', ['membership_id' => $membership['id']]);
2640 * Dataprovider provides contribution status as [optionvalue=>contribution_status_name]
2641 * FIXME: buildOptions seems to die in CRM_Core_Config::_construct when in test mode.
2644 * @throws \CiviCRM_API3_Exception
2646 public function contributionStatusProvider() {
2647 $contributionStatuses = civicrm_api3('OptionValue', 'get', [
2648 'return' => ["id", "name"],
2649 'option_group_id' => "contribution_status",
2651 foreach ($contributionStatuses['values'] as $statusName) {
2652 $statuses[] = [$statusName];
2658 * CRM-16397 test appropriate action if total amount has changed for single
2661 * @throws \CRM_Core_Exception
2663 public function testRepeatTransactionAlteredAmount(): void
{
2664 $paymentProcessorID = $this->paymentProcessorCreate();
2665 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2666 'contact_id' => $this->_individualId
,
2667 'installments' => '12',
2668 'frequency_interval' => '1',
2670 'contribution_status_id' => 1,
2671 'start_date' => '2012-01-01 00:00:00',
2672 'currency' => 'USD',
2673 'frequency_unit' => 'month',
2674 'payment_processor_id' => $paymentProcessorID,
2676 $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2679 'contribution_recur_id' => $contributionRecur['id'],
2683 $this->callAPISuccess('contribution', 'repeattransaction', [
2684 'original_contribution_id' => $originalContribution['id'],
2685 'contribution_status_id' => 'Completed',
2687 'total_amount' => '400',
2692 'entity_id' => $originalContribution['id'],
2700 'financial_type_id',
2701 'deductible_amount',
2702 'price_field_value_id',
2706 $this->callAPISuccessGetSingle('contribution', [
2707 'total_amount' => 400,
2709 'net_amount' => 350,
2711 $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2712 'entity_id' => $originalContribution['id'],
2714 $expectedLineItem = array_merge(
2715 $lineItem1['values'][0], [
2716 'line_total' => '400.00',
2717 'unit_price' => '400.00',
2721 $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2722 'entity_id' => $originalContribution['id'] +
1,
2725 unset($expectedLineItem['id'], $expectedLineItem['entity_id'], $lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2726 $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2730 * Test financial_type_id override behaviour with a single line item.
2732 * CRM-17718 a passed in financial_type_id is allowed to override the
2733 * original contribution where there is only one line item.
2735 * @throws \CRM_Core_Exception
2737 public function testRepeatTransactionPassedInFinancialType() {
2738 $originalContribution = $this->setUpRecurringContribution();
2740 $this->callAPISuccess('Contribution', 'repeattransaction', [
2741 'original_contribution_id' => $originalContribution['id'],
2742 'contribution_status_id' => 'Completed',
2744 'financial_type_id' => 2,
2747 'entity_id' => $originalContribution['id'],
2755 'financial_type_id',
2756 'deductible_amount',
2757 'price_field_value_id',
2762 $this->callAPISuccessGetSingle('Contribution', [
2763 'total_amount' => 100,
2764 'financial_type_id' => 2,
2766 $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2767 'entity_id' => $originalContribution['id'],
2769 $expectedLineItem = array_merge(
2770 $lineItem1['values'][0], [
2771 'line_total' => '100.00',
2772 'unit_price' => '100.00',
2773 'financial_type_id' => 2,
2774 'contribution_type_id' => 2,
2777 $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2778 'entity_id' => $originalContribution['id'] +
1,
2780 unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
2781 unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2782 $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2786 * Test Contribution with Order api.
2788 * @throws \CRM_Core_Exception|\CiviCRM_API3_Exception
2790 public function testContributionOrder() {
2791 $this->createContributionAndMembershipOrder();
2792 $contribution = $this->callAPISuccess('contribution', 'get')['values'][$this->ids
['Contribution'][0]];
2793 $this->assertEquals('Pending Label**', $contribution['contribution_status']);
2794 $membership = $this->callAPISuccessGetSingle('Membership', ['contact_id' => $this->ids
['Contact']['order']]);
2796 $this->callAPISuccess('Payment', 'create', [
2797 'contribution_id' => $this->ids
['Contribution'][0],
2798 'payment_instrument_id' => 'Check',
2799 'total_amount' => 300,
2801 $contribution = $this->callAPISuccess('contribution', 'get')['values'][$this->ids
['Contribution'][0]];
2802 $this->assertEquals('Completed', $contribution['contribution_status']);
2804 $lineItem = $this->callAPISuccess('LineItem', 'get', [
2806 'contribution_id' => $this->ids
['Contribution'][0],
2808 $this->assertCount(2, $lineItem);
2809 $this->assertEquals($this->ids
['Contribution'][0], $lineItem[0]['entity_id']);
2810 $this->assertEquals('civicrm_contribution', $lineItem[0]['entity_table']);
2811 $this->assertEquals($this->ids
['Contribution'][0], $lineItem[0]['contribution_id']);
2812 $this->assertEquals($this->ids
['Contribution'][0], $lineItem[1]['contribution_id']);
2813 $this->assertEquals('100.00', $lineItem[0]['line_total']);
2814 $this->assertEquals('200.00', $lineItem[1]['line_total']);
2815 $this->assertEquals($membership['id'], $lineItem[1]['entity_id']);
2816 $this->assertEquals('civicrm_membership', $lineItem[1]['entity_table']);
2820 * Test financial_type_id override behaviour with a single line item.
2822 * CRM-17718 a passed in financial_type_id is not allowed to override the
2823 * original contribution where there is more than one line item.
2825 * @throws \CRM_Core_Exception
2827 public function testRepeatTransactionPassedInFinancialTypeTwoLineItems(): void
{
2828 $this->_params
= $this->getParticipantOrderParams();
2829 $originalContribution = $this->setUpRecurringContribution();
2831 $this->callAPISuccess('Contribution', 'repeattransaction', [
2832 'original_contribution_id' => $originalContribution['id'],
2833 'contribution_status_id' => 'Completed',
2834 'trxn_id' => 'repeat',
2835 'financial_type_id' => 2,
2838 // Retrieve the new contribution and note the financial type passed in has been ignored.
2839 $contribution = $this->callAPISuccessGetSingle('Contribution', [
2840 'trxn_id' => 'repeat',
2842 $this->assertEquals(4, $contribution['financial_type_id']);
2844 $lineItems = $this->callAPISuccess('line_item', 'get', [
2845 'entity_id' => $contribution['id'],
2847 foreach ($lineItems as $lineItem) {
2848 $this->assertNotEquals(2, $lineItem['financial_type_id']);
2853 * CRM-17718 test appropriate action if financial type has changed for single
2856 * @throws \CRM_Core_Exception
2858 public function testRepeatTransactionUpdatedFinancialType(): void
{
2859 $originalContribution = $this->setUpRecurringContribution([], ['financial_type_id' => 2]);
2861 $this->callAPISuccess('contribution', 'repeattransaction', [
2862 'contribution_recur_id' => $originalContribution['id'],
2863 'contribution_status_id' => 'Completed',
2867 'entity_id' => $originalContribution['id'],
2875 'financial_type_id',
2876 'deductible_amount',
2877 'price_field_value_id',
2882 $this->callAPISuccessGetSingle('contribution', [
2883 'total_amount' => 100,
2884 'financial_type_id' => 2,
2886 $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2887 'entity_id' => $originalContribution['id'],
2889 $expectedLineItem = array_merge(
2891 'line_total' => '100.00',
2892 'unit_price' => '100.00',
2893 'financial_type_id' => 2,
2894 'contribution_type_id' => 2,
2898 $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2899 'entity_id' => $originalContribution['id'] +
1,
2901 unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
2902 unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2903 $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2907 * CRM-16397 test appropriate action if campaign has been passed in.
2909 public function testRepeatTransactionPassedInCampaign() {
2910 $paymentProcessorID = $this->paymentProcessorCreate();
2911 $campaignID = $this->campaignCreate();
2912 $campaignID2 = $this->campaignCreate();
2913 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2914 'contact_id' => $this->_individualId
,
2915 'installments' => '12',
2916 'frequency_interval' => '1',
2918 'contribution_status_id' => 1,
2919 'start_date' => '2012-01-01 00:00:00',
2920 'currency' => 'USD',
2921 'frequency_unit' => 'month',
2922 'payment_processor_id' => $paymentProcessorID,
2924 $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2927 'contribution_recur_id' => $contributionRecur['id'],
2928 'campaign_id' => $campaignID,
2932 $this->callAPISuccess('contribution', 'repeattransaction', [
2933 'original_contribution_id' => $originalContribution['id'],
2934 'contribution_status_id' => 'Completed',
2936 'campaign_id' => $campaignID2,
2939 $this->callAPISuccessGetSingle('contribution', [
2940 'total_amount' => 100,
2941 'campaign_id' => $campaignID2,
2946 * CRM-17718 campaign stored on contribution recur gets priority.
2948 * This reflects the fact we permit people to update them.
2950 * @throws \CRM_Core_Exception
2952 public function testRepeatTransactionUpdatedCampaign(): void
{
2953 $paymentProcessorID = $this->paymentProcessorCreate();
2954 $campaignID = $this->campaignCreate();
2955 $campaignID2 = $this->campaignCreate();
2956 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2957 'contact_id' => $this->_individualId
,
2958 'installments' => '12',
2959 'frequency_interval' => '1',
2961 'contribution_status_id' => 1,
2962 'start_date' => '2012-01-01 00:00:00',
2963 'currency' => 'USD',
2964 'frequency_unit' => 'month',
2965 'payment_processor_id' => $paymentProcessorID,
2966 'campaign_id' => $campaignID,
2968 $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2971 'contribution_recur_id' => $contributionRecur['id'],
2972 'campaign_id' => $campaignID2,
2976 $this->callAPISuccess('contribution', 'repeattransaction', [
2977 'original_contribution_id' => $originalContribution['id'],
2978 'contribution_status_id' => 'Completed',
2982 $this->callAPISuccessGetSingle('Contribution', [
2983 'total_amount' => 100,
2984 'campaign_id' => $campaignID,
2989 * CRM-20685 Repeattransaction produces incorrect Financial Type ID (in
2990 * specific circumstance) - if number of lineItems = 1.
2992 * This case happens when the line item & contribution do not have the same
2993 * type in his initiating transaction.
2995 * @throws \CRM_Core_Exception
2997 public function testRepeatTransactionUpdatedFinancialTypeAndNotEquals(): void
{
2998 $originalContribution = $this->setUpRecurringContribution([], ['financial_type_id' => 2]);
2999 // This will made the trick to get the not equals behaviour.
3000 $this->callAPISuccess('line_item', 'create', ['id' => 1, 'financial_type_id' => 4]);
3001 $this->callAPISuccess('contribution', 'repeattransaction', [
3002 'contribution_recur_id' => $originalContribution['id'],
3003 'contribution_status_id' => 'Completed',
3007 'entity_id' => $originalContribution['id'],
3015 'financial_type_id',
3016 'deductible_amount',
3017 'price_field_value_id',
3021 $this->callAPISuccessGetSingle('contribution', [
3022 'total_amount' => 100,
3023 'financial_type_id' => 2,
3025 $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
3026 'entity_id' => $originalContribution['id'],
3028 $expectedLineItem = array_merge(
3029 $lineItem1['values'][0], [
3030 'line_total' => '100.00',
3031 'unit_price' => '100.00',
3032 'financial_type_id' => 4,
3033 'contribution_type_id' => 4,
3037 $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
3038 'entity_id' => $originalContribution['id'] +
1,
3040 $this->callAPISuccess('line_item', 'create', ['id' => 1, 'financial_type_id' => 1]);
3041 unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
3042 unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
3043 $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
3047 * Test completing a transaction does not 'mess' with net amount (CRM-15960).
3049 public function testCompleteTransactionNetAmountOK() {
3050 $this->createLoggedInUser();
3051 $params = array_merge($this->_params
, ['contribution_status_id' => 2]);
3052 unset($params['net_amount']);
3053 $contribution = $this->callAPISuccess('contribution', 'create', $params);
3054 $this->callAPISuccess('contribution', 'completetransaction', [
3055 'id' => $contribution['id'],
3057 $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id']]);
3058 $this->assertEquals('Completed', $contribution['contribution_status']);
3059 $this->assertTrue(($contribution['total_amount'] - $contribution['net_amount']) == $contribution['fee_amount']);
3063 * CRM-14151 - Test completing a transaction via the API.
3065 public function testCompleteTransactionWithReceiptDateSet() {
3066 $this->swapMessageTemplateForTestTemplate();
3067 $mut = new CiviMailUtils($this, TRUE);
3068 $this->createLoggedInUser();
3069 $params = array_merge($this->_params
, ['contribution_status_id' => 2, 'receipt_date' => 'now']);
3070 $contribution = $this->callAPISuccess('contribution', 'create', $params);
3071 $this->callAPISuccess('contribution', 'completetransaction', ['id' => $contribution['id'], 'trxn_date' => date('Y-m-d')]);
3072 $contribution = $this->callAPISuccess('contribution', 'get', ['id' => $contribution['id'], 'sequential' => 1]);
3073 $this->assertEquals('Completed', $contribution['values'][0]['contribution_status']);
3074 // Make sure receive_date is original date and make sure payment date is today
3075 $this->assertEquals('2012-05-11', date('Y-m-d', strtotime($contribution['values'][0]['receive_date'])));
3076 $payment = $this->callAPISuccess('payment', 'get', ['contribution_id' => $contribution['id'], 'sequential' => 1]);
3077 $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($payment['values'][0]['trxn_date'])));
3078 $mut->checkMailLog([
3079 'Receipt - Contribution',
3080 'receipt_date:::' . date('Ymd'),
3083 $this->revertTemplateToReservedTemplate();
3087 * CRM-1960 - Test to ensure that completetransaction respects the is_email_receipt setting
3089 public function testCompleteTransactionWithEmailReceiptInput() {
3090 $contributionPage = $this->createReceiptableContributionPage();
3092 $this->_params
['contribution_page_id'] = $contributionPage['id'];
3093 $params = array_merge($this->_params
, ['contribution_status_id' => 2]);
3094 $contribution = $this->callAPISuccess('contribution', 'create', $params);
3095 // Complete the transaction overriding is_email_receipt to = FALSE
3096 $this->callAPISuccess('contribution', 'completetransaction', [
3097 'id' => $contribution['id'],
3098 'trxn_date' => date('2011-04-09'),
3099 'trxn_id' => 'kazam',
3100 'is_email_receipt' => 0,
3102 // Check if a receipt was issued
3103 $receipt_date = $this->callAPISuccess('Contribution', 'getvalue', ['id' => $contribution['id'], 'return' => 'receipt_date']);
3104 $this->assertEquals('', $receipt_date);
3108 * Test that $is_recur is assigned to the receipt.
3110 public function testCompleteTransactionForRecurring() {
3111 $this->mut
= new CiviMailUtils($this, TRUE);
3112 $this->swapMessageTemplateForTestTemplate();
3113 $recurring = $this->setUpRecurringContribution();
3114 $contributionPage = $this->createReceiptableContributionPage(['is_recur' => TRUE, 'recur_frequency_unit' => 'month', 'recur_interval' => 1]);
3116 $this->_params
['contribution_page_id'] = $contributionPage['id'];
3117 $this->_params
['contribution_recur_id'] = $recurring['id'];
3119 $contribution = $this->setUpForCompleteTransaction();
3121 $this->callAPISuccess('contribution', 'completetransaction', [
3122 'id' => $contribution['id'],
3123 'trxn_date' => date('2011-04-09'),
3124 'trxn_id' => 'kazam',
3125 'is_email_receipt' => 1,
3128 $this->mut
->checkMailLog([
3130 'cancelSubscriptionUrl:::' . CIVICRM_UF_BASEURL
,
3133 $this->revertTemplateToReservedTemplate();
3137 * CRM-19710 - Test to ensure that completetransaction respects the input for
3138 * is_email_receipt setting.
3140 * If passed in it will override the default from contribution page.
3142 * @throws \CRM_Core_Exception
3144 public function testCompleteTransactionWithEmailReceiptInputTrue(): void
{
3145 $mut = new CiviMailUtils($this, TRUE);
3146 $this->createLoggedInUser();
3147 $contributionPageParams = ['is_email_receipt' => 0];
3148 // Create a Contribution Page with is_email_receipt = FALSE
3149 $contributionPageID = $this->createQuickConfigContributionPage($contributionPageParams);
3150 $this->_params
['contribution_page_id'] = $contributionPageID;
3151 $params = array_merge($this->_params
, ['contribution_status_id' => 2, 'receipt_date' => 'now']);
3152 $contribution = $this->callAPISuccess('contribution', 'create', $params);
3153 // Complete the transaction overriding is_email_receipt to = TRUE
3154 $this->callAPISuccess('contribution', 'completetransaction', [
3155 'id' => $contribution['id'],
3156 'is_email_receipt' => 1,
3158 $mut->checkMailLog([
3159 'Contribution Information',
3165 * Complete the transaction using the template with all the possible.
3167 public function testCompleteTransactionWithTestTemplate() {
3168 $this->swapMessageTemplateForTestTemplate();
3169 $contribution = $this->setUpForCompleteTransaction();
3170 $this->callAPISuccess('contribution', 'completetransaction', [
3171 'id' => $contribution['id'],
3172 'trxn_date' => date('2011-04-09'),
3173 'trxn_id' => 'kazam',
3175 $receive_date = $this->callAPISuccess('Contribution', 'getvalue', ['id' => $contribution['id'], 'return' => 'receive_date']);
3176 $this->mut
->checkMailLog([
3177 'email:::anthony_anderson@civicrm.org',
3181 'receive_date:::' . date('Ymd', strtotime($receive_date)),
3182 'receipt_date:::' . date('Ymd'),
3183 'title:::Contribution',
3185 'contactID:::' . $this->_params
['contact_id'],
3186 'contributionID:::' . $contribution['id'],
3187 'financialTypeId:::1',
3188 'financialTypeName:::Donation',
3191 $this->revertTemplateToReservedTemplate();
3195 * Complete the transaction using the template with all the possible.
3197 public function testCompleteTransactionContributionPageFromAddress() {
3198 $contributionPage = $this->callAPISuccess('ContributionPage', 'create', [
3199 'receipt_from_name' => 'Mickey Mouse',
3200 'receipt_from_email' => 'mickey@mouse.com',
3201 'title' => "Test Contribution Page",
3202 'financial_type_id' => 1,
3203 'currency' => 'NZD',
3204 'goal_amount' => 50,
3205 'is_pay_later' => 1,
3206 'is_monetary' => TRUE,
3207 'is_email_receipt' => TRUE,
3209 $this->_params
['contribution_page_id'] = $contributionPage['id'];
3210 $contribution = $this->setUpForCompleteTransaction();
3211 $this->callAPISuccess('contribution', 'completetransaction', ['id' => $contribution['id']]);
3212 $this->mut
->checkMailLog([
3220 * Test completing first transaction in a recurring series.
3222 * The status should be set to 'in progress' and the next scheduled payment date calculated.
3224 * @dataProvider getScheduledDateData
3226 * @param array $dataSet
3228 * @throws \Exception
3230 public function testCompleteTransactionSetStatusToInProgress($dataSet) {
3231 $paymentProcessorID = $this->paymentProcessorCreate();
3232 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
3233 'contact_id' => $this->_individualId
,
3234 'installments' => '2',
3235 'frequency_interval' => '1',
3237 'contribution_status_id' => 'Pending',
3238 'start_date' => '2012-01-01 00:00:00',
3239 'currency' => 'USD',
3240 'frequency_unit' => 'month',
3241 'payment_processor_id' => $paymentProcessorID,
3242 ], $dataSet['data']));
3243 $contribution = $this->callAPISuccess('contribution', 'create', array_merge(
3246 'contribution_recur_id' => $contributionRecur['id'],
3247 'contribution_status_id' => 'Pending',
3248 'receive_date' => $dataSet['receive_date'],
3251 $this->callAPISuccess('Contribution', 'completetransaction', [
3252 'id' => $contribution,
3253 'receive_date' => $dataSet['receive_date'],
3255 $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
3256 'id' => $contributionRecur['id'],
3257 'return' => ['next_sched_contribution_date', 'contribution_status_id'],
3259 $this->assertEquals(5, $contributionRecur['contribution_status_id']);
3260 $this->assertEquals($dataSet['expected'], $contributionRecur['next_sched_contribution_date']);
3261 $this->callAPISuccess('Contribution', 'create', array_merge(
3264 'contribution_recur_id' => $contributionRecur['id'],
3265 'contribution_status_id' => 'Completed',
3268 $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
3269 'id' => $contributionRecur['id'],
3270 'return' => ['contribution_status_id'],
3272 $this->assertEquals(1, $contributionRecur['contribution_status_id']);
3276 * Get dates for testing.
3280 public function getScheduledDateData() {
3282 $result[]['2016-08-31-1-month'] = [
3284 'start_date' => '2016-08-31',
3285 'frequency_interval' => 1,
3286 'frequency_unit' => 'month',
3288 'receive_date' => '2016-08-31',
3289 'expected' => '2016-10-01 00:00:00',
3291 $result[]['2012-01-01-1-month'] = [
3293 'start_date' => '2012-01-01',
3294 'frequency_interval' => 1,
3295 'frequency_unit' => 'month',
3297 'receive_date' => '2012-01-01',
3298 'expected' => '2012-02-01 00:00:00',
3300 $result[]['2012-01-01-1-month'] = [
3302 'start_date' => '2012-01-01',
3303 'frequency_interval' => 1,
3304 'frequency_unit' => 'month',
3306 'receive_date' => '2012-02-29',
3307 'expected' => '2012-03-29 00:00:00',
3309 $result['receive_date_includes_time']['2012-01-01-1-month'] = [
3311 'start_date' => '2012-01-01',
3312 'frequency_interval' => 1,
3313 'frequency_unit' => 'month',
3314 'next_sched_contribution_date' => '2012-02-29',
3316 'receive_date' => '2012-02-29 16:00:00',
3317 'expected' => '2012-03-29 00:00:00',
3323 * Test completing a pledge with the completeTransaction api..
3325 * Note that we are creating a logged in user because email goes out from
3328 public function testCompleteTransactionUpdatePledgePayment() {
3329 $this->swapMessageTemplateForTestTemplate();
3330 $mut = new CiviMailUtils($this, TRUE);
3331 $mut->clearMessages();
3332 $this->createLoggedInUser();
3333 $contributionID = $this->createPendingPledgeContribution();
3334 $this->callAPISuccess('contribution', 'completetransaction', [
3335 'id' => $contributionID,
3336 'trxn_date' => '1 Feb 2013',
3338 $pledge = $this->callAPISuccessGetSingle('Pledge', [
3339 'id' => $this->_ids
['pledge'],
3341 $this->assertEquals('Completed', $pledge['pledge_status']);
3343 $status = $this->callAPISuccessGetValue('PledgePayment', [
3344 'pledge_id' => $this->_ids
['pledge'],
3345 'return' => 'status_id',
3347 $this->assertEquals(1, $status);
3348 $mut->checkMailLog([
3350 // The `receive_date` should remain as it was created.
3351 // TODO: the latest payment transaction date (and maybe other details,
3352 // such as amount and payment instrument) would be a useful token to make
3354 'receive_date:::20120511000000',
3355 "receipt_date:::\n",
3358 $this->revertTemplateToReservedTemplate();
3362 * Test completing a transaction with an event via the API.
3364 * Note that we are creating a logged in user because email goes out from
3367 * @throws \CRM_Core_Exception
3369 public function testCompleteTransactionWithParticipantRecord(): void
{
3370 $mut = new CiviMailUtils($this, TRUE);
3371 $mut->clearMessages();
3372 $this->_individualId
= $this->createLoggedInUser();
3373 $this->_params
['source'] = 'Online Event Registration: Annual CiviCRM meet';
3374 $contributionID = $this->createPendingParticipantContribution();
3375 $this->createJoinedProfile(['entity_id' => $this->_ids
['event']['test'], 'entity_table' => 'civicrm_event']);
3376 $this->createJoinedProfile(['entity_id' => $this->_ids
['event']['test'], 'entity_table' => 'civicrm_event', 'weight' => 2], ['name' => 'post_1', 'title' => 'title_post_2', 'frontend_title' => 'public 2']);
3377 $this->createJoinedProfile(['entity_id' => $this->_ids
['event']['test'], 'entity_table' => 'civicrm_event', 'weight' => 3], ['name' => 'post_2', 'title' => 'title_post_3', 'frontend_title' => 'public 3']);
3378 $this->eliminateUFGroupOne();
3380 $this->callAPISuccess('contribution', 'completetransaction', ['id' => $contributionID]);
3381 $contribution = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID, 'return' => ['contribution_source']]);
3382 $this->assertEquals('Online Event Registration: Annual CiviCRM meet', $contribution['contribution_source']);
3383 $participantStatus = $this->callAPISuccessGetValue('participant', [
3384 'id' => $this->_ids
['participant'],
3385 'return' => 'participant_status_id',
3387 $this->assertEquals(1, $participantStatus);
3389 //Assert only three activities are created.
3390 $activities = $this->callAPISuccess('Activity', 'get', [
3391 'contact_id' => $this->_individualId
,
3394 $this->assertCount(3, $activities);
3395 $activityNames = array_count_values(CRM_Utils_Array
::collect('activity_name', $activities));
3396 // record two activities before and after completing payment for Event registration
3397 $this->assertEquals(2, $activityNames['Event Registration']);
3398 // update the original 'Contribution' activity created after completing payment
3399 $this->assertEquals(1, $activityNames['Contribution']);
3401 $mut->checkMailLog([
3402 'Annual CiviCRM meet',
3404 'This is a confirmation that your registration has been received and your status has been updated to Registered.',
3405 'First Name: Logged In',
3409 ], ['Back end title', 'title_post_2', 'title_post_3']);
3414 * Test membership is renewed when transaction completed.
3416 * @throws \API_Exception
3418 public function testCompleteTransactionMembershipPriceSet(): void
{
3419 $this->createPriceSetWithPage('membership');
3420 $this->createInitialPaidMembership();
3421 $membership = $this->callAPISuccess('Membership', 'getsingle', [
3422 'id' => $this->getMembershipID(),
3423 'status_id' => 'Grace',
3424 'return' => ['end_date'],
3426 $this->assertEquals(date('Y-m-d', strtotime('yesterday')), $membership['end_date']);
3428 $this->createSubsequentPendingMembership();
3429 $this->callAPISuccess('Payment', 'create', [
3430 'contribution_id' => $this->getContributionID('second'),
3431 'total_amount' => 20,
3433 $membership = $this->callAPISuccess('membership', 'getsingle', ['id' => $this->_ids
['membership']]);
3434 $this->assertEquals(date('Y-m-d', strtotime('yesterday + 2 year')), $membership['end_date']);
3435 $logs = $this->callAPISuccess('MembershipLog', 'get', [
3436 'membership_id' => $this->getMembershipID(),
3438 $this->assertEquals(4, $logs['count']);
3439 //Assert only three activities are created.
3440 $activityNames = (array) ActivityContact
::get(FALSE)
3441 ->addWhere('contact_id', '=', $this->_ids
['contact'])
3442 ->addSelect('activity_id.activity_type_id:name')->execute()->indexBy('activity_id.activity_type_id:name');
3443 $this->assertArrayHasKey('Contribution', $activityNames);
3444 $this->assertArrayHasKey('Membership Signup', $activityNames);
3445 $this->assertArrayHasKey('Change Membership Status', $activityNames);
3449 * Test if renewal activity is create after changing Pending contribution to
3450 * Completed via offline
3452 * @throws \CRM_Core_Exception|\CiviCRM_API3_Exception
3454 public function testPendingToCompleteContribution(): void
{
3455 $this->createPriceSetWithPage('membership');
3456 $this->setUpPendingContribution($this->_ids
['price_field_value'][0]);
3457 $this->callAPISuccess('membership', 'getsingle', ['id' => $this->_ids
['membership']]);
3458 // Case 1: Assert that Membership Signup Activity is created on Pending to Completed Contribution via backoffice
3459 $activity = $this->callAPISuccess('Activity', 'get', [
3460 'activity_type_id' => 'Membership Signup',
3461 'source_record_id' => $this->_ids
['membership'],
3462 'status_id' => 'Scheduled',
3464 $this->assertEquals(1, $activity['count']);
3465 $_REQUEST['id'] = $this->getContributionID();
3466 $_REQUEST['action'] = 'update';
3467 // change pending contribution to completed
3468 /* @var CRM_Contribute_Form_Contribution $form */
3469 $form = $this->getFormObject('CRM_Contribute_Form_Contribution', [
3470 'total_amount' => 20,
3473 'financial_type_id' => 1,
3474 'contact_id' => $this->_individualId
,
3475 'contribution_status_id' => 1,
3476 'billing_middle_name' => '',
3477 'billing_last_name' => 'Adams',
3478 'billing_street_address-5' => '790L Lincoln St S',
3479 'billing_city-5' => 'Mary knoll',
3480 'billing_state_province_id-5' => 1031,
3481 'billing_postal_code-5' => 10545,
3482 'billing_country_id-5' => 1228,
3483 'frequency_interval' => 1,
3484 'frequency_unit' => 'month',
3485 'installments' => '',
3486 'hidden_AdditionalDetail' => 1,
3487 'hidden_Premium' => 1,
3488 'from_email_address' => '"civi45" <civi45@civicrm.com>',
3489 'payment_processor_id' => $this->paymentProcessorID
,
3490 'currency' => 'USD',
3491 'contribution_page_id' => $this->_ids
['contribution_page'],
3492 'source' => 'Membership Signup and Renewal',
3495 $form->postProcess();
3497 // Case 2: After successful payment for Pending backoffice there are three activities created
3498 // 2.a Update status of existing Scheduled Membership Signup (created in step 1) to Completed
3499 $activity = $this->callAPISuccess('Activity', 'get', [
3500 'activity_type_id' => 'Membership Signup',
3501 'source_record_id' => $this->getMembershipID(),
3502 'status_id' => 'Completed',
3504 $this->assertEquals(1, $activity['count']);
3505 // 2.b Contribution activity created to record successful payment
3506 $activity = $this->callAPISuccess('Activity', 'get', [
3507 'activity_type_id' => 'Contribution',
3508 'source_record_id' => $this->getContributionID(),
3509 'status_id' => 'Completed',
3511 $this->assertEquals(1, $activity['count']);
3513 // 2.c 'Change membership type' activity created to record Membership status change from Grace to Current
3514 $activity = $this->callAPISuccess('Activity', 'get', [
3515 'activity_type_id' => 'Change Membership Status',
3516 'source_record_id' => $this->getMembershipID(),
3517 'status_id' => 'Completed',
3519 $this->assertEquals(1, $activity['count']);
3520 $this->assertEquals('Status changed from Pending to New', $activity['values'][$activity['id']]['subject']);
3521 $membershipLogs = $this->callAPISuccess('MembershipLog', 'get', ['sequential' => 1])['values'];
3522 $this->assertEquals('Pending', CRM_Core_PseudoConstant
::getName('CRM_Member_BAO_Membership', 'status_id', $membershipLogs[0]['status_id']));
3523 $this->assertEquals('New', CRM_Core_PseudoConstant
::getName('CRM_Member_BAO_Membership', 'status_id', $membershipLogs[1]['status_id']));
3524 //Create another pending contribution for renewal
3525 $this->setUpPendingContribution($this->_ids
['price_field_value'][0], 'second', [], ['entity_id' => $this->getMembershipID()], ['id' => $this->getMembershipID()]);
3527 //Update it to Failed.
3528 $form->_params
['id'] = $this->getContributionID('second');
3529 $form->_params
['contribution_status_id'] = 4;
3531 $form->testSubmit($form->_params
, CRM_Core_Action
::UPDATE
);
3532 //Existing membership should not get updated to expired.
3533 $membership = $this->callAPISuccess('Membership', 'getsingle', ['id' => $this->_ids
['membership']]);
3534 $this->assertNotEquals(4, $membership['status_id']);
3538 * Test membership is renewed for 2 terms when transaction completed based on the line item having 2 terms as qty.
3540 * Also check that altering the qty for the most recent contribution results in repeattransaction picking it up.
3542 public function testCompleteTransactionMembershipPriceSetTwoTerms(): void
{
3543 $this->createPriceSetWithPage('membership');
3544 $this->createInitialPaidMembership();
3545 $this->createSubsequentPendingMembership();
3547 $this->callAPISuccess('Payment', 'create', [
3548 'contribution_id' => $this->getContributionID('second'),
3549 'total_amount' => 20,
3552 $membership = $this->callAPISuccessGetSingle('membership', ['id' => $this->getMembershipID()]);
3553 $this->assertEquals(date('Y-m-d', strtotime('yesterday + 2 years')), $membership['end_date']);
3555 $paymentProcessorID = $this->paymentProcessorAuthorizeNetCreate();
3557 $contributionRecurID = $this->callAPISuccess('ContributionRecur', 'create', ['contact_id' => $membership['contact_id'], 'payment_processor_id' => $paymentProcessorID, 'amount' => 20, 'frequency_interval' => 1])['id'];
3558 $this->callAPISuccess('Contribution', 'create', ['id' => $this->getContributionID(), 'contribution_recur_id' => $contributionRecurID]);
3559 $this->callAPISuccess('contribution', 'repeattransaction', ['contribution_recur_id' => $contributionRecurID, 'contribution_status_id' => 'Completed']);
3560 $membership = $this->callAPISuccessGetSingle('membership', ['id' => $this->getMembershipID()]);
3561 $this->assertEquals(date('Y-m-d', strtotime('yesterday + 4 years')), $membership['end_date']);
3563 // Update the most recent contribution to have a qty of 1 in it's line item and then repeat, expecting just 1 year to be added.
3564 $contribution = Contribution
::get()->setOrderBy(['id' => 'DESC'])->setSelect(['id'])->execute()->first();
3565 CRM_Core_DAO
::executeQuery('UPDATE civicrm_line_item SET price_field_value_id = ' . $this->_ids
['price_field_value'][0] . ' WHERE contribution_id = ' . $contribution['id']);
3566 $this->callAPISuccess('contribution', 'repeattransaction', ['contribution_recur_id' => $contributionRecurID, 'contribution_status_id' => 'Completed']);
3567 $membership = $this->callAPISuccessGetSingle('membership', ['id' => $this->_ids
['membership']]);
3568 $this->assertEquals(date('Y-m-d', strtotime('yesterday + 5 years')), $membership['end_date']);
3571 public function cleanUpAfterPriceSets() {
3572 $this->quickCleanUpFinancialEntities();
3573 $this->contactDelete($this->_ids
['contact']);
3577 * Set up a pending transaction with a specific price field id.
3579 * @param int $priceFieldValueID
3580 * @param string $key
3581 * @param array $contributionParams
3582 * @param array $lineParams
3583 * @param array $membershipParams
3585 public function setUpPendingContribution(int $priceFieldValueID, string $key = 'first', array $contributionParams = [], array $lineParams = [], array $membershipParams = []): void
{
3586 $contactID = $this->individualCreate();
3587 $membershipParams = array_merge([
3588 'contact_id' => $contactID,
3589 'membership_type_id' => $this->_ids
['membership_type'],
3590 ], $membershipParams);
3591 if ($key === 'first') {
3592 // If we want these after the initial we will set them.
3593 $membershipParams['start_date'] = 'yesterday - 1 year';
3594 $membershipParams['end_date'] = 'yesterday';
3595 $membershipParams['join_date'] = 'yesterday - 1 year';
3597 $contribution = $this->callAPISuccess('Order', 'create', array_merge([
3599 'contact_id' => $contactID,
3600 'receive_date' => date('Ymd'),
3601 'total_amount' => 20.00,
3602 'financial_type_id' => 1,
3603 'payment_instrument_id' => 'Credit Card',
3604 'non_deductible_amount' => 10.00,
3606 'contribution_page_id' => $this->_ids
['contribution_page'],
3611 'price_field_id' => $this->_ids
['price_field'][0],
3613 'entity_table' => 'civicrm_membership',
3616 'financial_type_id' => 1,
3617 'price_field_value_id' => $priceFieldValueID,
3620 'params' => $membershipParams,
3623 ], $contributionParams));
3625 $this->_ids
['contact'] = $contactID;
3626 $this->ids
['contribution'][$key] = $contribution['id'];
3627 $this->_ids
['membership'] = $this->callAPISuccessGetValue('MembershipPayment', ['return' => 'membership_id', 'contribution_id' => $contribution['id']]);
3631 * Test sending a mail via the API.
3633 * @throws \CRM_Core_Exception
3635 public function testSendMail(): void
{
3636 $mut = new CiviMailUtils($this, TRUE);
3637 $orderParams = $this->_params
;
3638 $orderParams['contribution_status_id'] = 'Pending';
3639 $orderParams['api.PaymentProcessor.pay'] = [
3640 'payment_processor_id' => $this->paymentProcessorID
,
3641 'credit_card_type' => 'Visa',
3642 'credit_card_number' => 41111111111111,
3646 $order = $this->callAPISuccess('Order', 'create', $orderParams);
3647 $this->callAPISuccess('Payment', 'create', ['total_amount' => 5, 'is_send_notification' => 0, 'order_id' => $order['id']]);
3648 $address = $this->callAPISuccess('Address', 'create', ['contribution_id' => $order['id'], 'name' => 'bob', 'contact_id' => 1, 'street_address' => 'blah']);
3649 $this->callAPISuccess('Contribution', 'create', ['id' => $order['id'], 'address_id' => $address['id']]);
3650 $this->callAPISuccess('contribution', 'sendconfirmation', [
3651 'id' => $order['id'],
3652 'receipt_from_email' => 'api@civicrm.org',
3654 $mut->checkMailLog([
3656 'Contribution Information',
3661 $this->checkCreditCardDetails($mut, $order['id']);
3663 $tplVars = CRM_Core_Smarty
::singleton()->get_template_vars();
3664 $this->assertEquals('bob', $tplVars['billingName']);
3668 * Test sending a mail via the API.
3669 * This simulates webform_civicrm using pay later contribution page
3671 * @throws \CRM_Core_Exception
3672 * @throws \CiviCRM_API3_Exception
3674 public function testSendConfirmationPayLater(): void
{
3675 $mut = new CiviMailUtils($this, TRUE);
3676 // Create contribution page
3678 'title' => 'Webform Contributions',
3679 'financial_type_id' => 1,
3680 'contribution_type_id' => 1,
3681 'is_confirm_enabled' => 1,
3682 'is_pay_later' => 1,
3683 'pay_later_text' => 'I will send payment by cheque',
3684 'pay_later_receipt' => 'Send your cheque payable to "CiviCRM LLC" to the office',
3686 $contributionPage = $this->callAPISuccess('ContributionPage', 'create', $pageParams);
3688 // Create pay later contribution
3689 $contribution = $this->callAPISuccess('Order', 'create', [
3690 'contact_id' => $this->_individualId
,
3691 'financial_type_id' => 1,
3692 'is_pay_later' => 1,
3693 'contribution_status_id' => 2,
3694 'contribution_page_id' => $contributionPage['id'],
3695 'total_amount' => '10.00',
3700 'entity_table' => 'civicrm_contribution',
3701 'label' => 'My lineitem label',
3703 'unit_price' => '10.00',
3704 'line_total' => '10.00',
3713 civicrm_api3('contribution', 'sendconfirmation', [
3714 'id' => $contribution['id'],
3715 'receipt_from_email' => 'api@civicrm.org',
3718 catch (Exception
$e) {
3719 // Need to figure out how to stop this some other day
3720 // We don't care about the Payment Processor because this is Pay Later
3721 // The point of this test is to check we get the pay_later version of the mail
3722 if ($e->getMessage() !== "Undefined variable: CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage") {
3727 // Retrieve mail & check it has the pay_later_receipt info
3728 $mut->getMostRecentEmail('raw');
3729 $mut->checkMailLog([
3731 $pageParams['pay_later_receipt'],
3735 $this->checkReceiptDetails($mut, $contributionPage['id'], $contribution['id'], $pageParams);
3740 * Check credit card details in sent mail via API
3742 * @param CiviMailUtils $mut
3743 * @param int $contributionID Contribution ID
3745 * @throws \CRM_Core_Exception
3747 public function checkCreditCardDetails($mut, $contributionID) {
3748 $this->callAPISuccess('contribution', 'create', $this->_params
);
3749 $this->callAPISuccess('contribution', 'sendconfirmation', [
3750 'id' => $contributionID,
3751 'receipt_from_email' => 'api@civicrm.org',
3752 'payment_processor_id' => $this->paymentProcessorID
,
3754 $mut->checkMailLog([
3756 'Billing Name and Address',
3758 'anthony_anderson@civicrm.org',
3765 * Check receipt details in sent mail via API
3767 * @param CiviMailUtils $mut
3768 * @param int $pageID Page ID
3769 * @param int $contributionID Contribution ID
3770 * @param array $pageParams
3772 * @throws \CRM_Core_Exception
3774 public function checkReceiptDetails($mut, $pageID, $contributionID, $pageParams): void
{
3776 'receipt_from_name' => 'Page FromName',
3777 'receipt_from_email' => 'page_from@email.com',
3778 'cc_receipt' => 'page_cc@email.com',
3779 'receipt_text' => 'Page Receipt Text',
3780 'pay_later_receipt' => $pageParams['pay_later_receipt'],
3783 'receipt_from_name' => 'Custom FromName',
3784 'receipt_from_email' => 'custom_from@email.com',
3785 'cc_receipt' => 'custom_cc@email.com',
3786 'receipt_text' => 'Test Custom Receipt Text',
3787 'pay_later_receipt' => 'Mail your check to test@example.com within 3 business days.',
3789 $this->callAPISuccess('ContributionPage', 'create', array_merge([
3791 'is_email_receipt' => 1,
3794 $this->callAPISuccess('contribution', 'sendconfirmation', array_merge([
3795 'id' => $contributionID,
3796 'payment_processor_id' => $this->paymentProcessorID
,
3797 ], $customReceipt));
3799 //Verify if custom receipt details are present in email.
3800 //Page receipt details shouldn't be included.
3801 $mut->checkMailLog(array_values($customReceipt), array_values($pageReceipt));
3805 * Test sending a mail via the API.
3807 public function testSendMailEvent() {
3808 $mut = new CiviMailUtils($this, TRUE);
3809 $contribution = $this->callAPISuccess('contribution', 'create', $this->_params
);
3810 $event = $this->eventCreate([
3811 'is_email_confirm' => 1,
3812 'confirm_from_email' => 'test@civicrm.org',
3814 $this->_eventID
= $event['id'];
3815 $participantParams = [
3816 'contact_id' => $this->_individualId
,
3817 'event_id' => $this->_eventID
,
3820 // to ensure it matches later on
3821 'register_date' => '2007-07-21 00:00:00',
3822 'source' => 'Online Event Registration: API Testing',
3825 $participant = $this->callAPISuccess('participant', 'create', $participantParams);
3826 $this->callAPISuccess('participant_payment', 'create', [
3827 'participant_id' => $participant['id'],
3828 'contribution_id' => $contribution['id'],
3830 $this->callAPISuccess('contribution', 'sendconfirmation', [
3831 'id' => $contribution['id'],
3832 'receipt_from_email' => 'api@civicrm.org',
3835 $mut->checkMailLog([
3836 'Annual CiviCRM meet',
3838 'To: "Mr. Anthony Anderson II" <anthony_anderson@civicrm.org>',
3844 * This function does a GET & compares the result against the $params.
3846 * Use as a double check on Creates.
3848 * @param array $params
3850 * @param bool $delete
3852 * @throws \CRM_Core_Exception
3854 public function contributionGetnCheck(array $params, int $id, bool $delete = TRUE): void
{
3855 $contribution = $this->callAPISuccess('Contribution', 'Get', [
3857 'return' => array_merge(['contribution_source'], array_keys($params)),
3860 $this->callAPISuccess('contribution', 'delete', ['id' => $id]);
3862 $this->assertAPISuccess($contribution, 0);
3863 $values = $contribution['values'][$contribution['id']];
3864 $params['receive_date'] = date('Y-m-d H:i:s', strtotime($params['receive_date']));
3865 // this is not returned in id format
3866 unset($params['payment_instrument_id']);
3867 $params['contribution_source'] = $params['source'];
3868 unset($params['source'], $params['sequential']);
3869 foreach ($params as $key => $value) {
3870 $this->assertEquals($value, $values[$key], $key . " value: $value doesn't match " . print_r($values, TRUE));
3875 * Create a pending contribution & linked pending pledge record.
3877 * @throws \CRM_Core_Exception
3879 public function createPendingPledgeContribution() {
3881 $pledgeID = $this->pledgeCreate(['contact_id' => $this->_individualId
, 'installments' => 1, 'amount' => 500]);
3882 $this->_ids
['pledge'] = $pledgeID;
3883 $contribution = $this->callAPISuccess('Contribution', 'create', array_merge($this->_params
, [
3884 'contribution_status_id' => 'Pending',
3885 'total_amount' => 500,
3887 $paymentID = $this->callAPISuccessGetValue('PledgePayment', [
3888 'options' => ['limit' => 1],
3891 $this->callAPISuccess('PledgePayment', 'create', [
3893 'contribution_id' =>
3894 $contribution['id'],
3895 'status_id' => 'Pending',
3896 'scheduled_amount' => 500,
3899 return $contribution['id'];
3903 * Create a pending contribution & linked pending participant record (along
3906 * @throws \CRM_Core_Exception
3908 public function createPendingParticipantContribution() {
3909 $this->_ids
['event']['test'] = $this->eventCreate(['is_email_confirm' => 1, 'confirm_from_email' => 'test@civicrm.org'])['id'];
3910 $participantID = $this->participantCreate(['event_id' => $this->_ids
['event']['test'], 'status_id' => 6, 'contact_id' => $this->_individualId
]);
3911 $this->_ids
['participant'] = $participantID;
3912 $params = array_merge($this->_params
, ['contact_id' => $this->_individualId
, 'contribution_status_id' => 2, 'financial_type_id' => 'Event Fee']);
3913 $contribution = $this->callAPISuccess('contribution', 'create', $params);
3914 $this->callAPISuccess('participant_payment', 'create', [
3915 'contribution_id' => $contribution['id'],
3916 'participant_id' => $participantID,
3918 $this->callAPISuccess('line_item', 'get', [
3919 'entity_id' => $contribution['id'],
3920 'entity_table' => 'civicrm_contribution',
3921 'api.line_item.create' => [
3922 'entity_id' => $participantID,
3923 'entity_table' => 'civicrm_participant',
3926 return $contribution['id'];
3930 * Get financial transaction amount.
3932 * @param int $contId
3934 * @return null|string
3936 public function _getFinancialTrxnAmount($contId) {
3938 SUM( ft.total_amount ) AS total
3939 FROM civicrm_financial_trxn AS ft
3940 LEFT JOIN civicrm_entity_financial_trxn AS ceft ON ft.id = ceft.financial_trxn_id
3941 WHERE ceft.entity_table = 'civicrm_contribution'
3942 AND ceft.entity_id = {$contId}";
3944 return CRM_Core_DAO
::singleValueQuery($query);
3948 * @param int $contId
3950 * @return null|string
3952 public function _getFinancialItemAmount($contId) {
3953 $lineItem = key(CRM_Price_BAO_LineItem
::getLineItems($contId, 'contribution'));
3956 FROM civicrm_financial_item
3957 WHERE entity_table = 'civicrm_line_item'
3958 AND entity_id = {$lineItem}";
3959 return CRM_Core_DAO
::singleValueQuery($query);
3963 * @param int $contId
3966 public function _checkFinancialItem($contId, $context) {
3967 if ($context !== 'paylater') {
3969 'entity_id' => $contId,
3970 'entity_table' => 'civicrm_contribution',
3972 $trxn = current(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($params, TRUE));
3974 'financial_trxn_id' => $trxn['financial_trxn_id'],
3975 'entity_table' => 'civicrm_financial_item',
3977 $entityTrxn = current(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($entityParams));
3979 'id' => $entityTrxn['entity_id'],
3982 if ($context === 'paylater') {
3983 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($contId, 'contribution');
3984 foreach ($lineItems as $key => $item) {
3986 'entity_id' => $key,
3987 'entity_table' => 'civicrm_line_item',
3989 $compareParams = ['status_id' => 1];
3990 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
3993 elseif ($context === 'refund') {
3996 'financial_account_id' => 1,
4000 elseif ($context === 'cancelPending') {
4003 'financial_account_id' => 1,
4007 elseif ($context === 'changeFinancial') {
4008 $lineKey = key(CRM_Price_BAO_LineItem
::getLineItems($contId, 'contribution'));
4010 'entity_id' => $lineKey,
4014 'financial_account_id' => 1,
4016 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
4018 'financial_account_id' => 3,
4019 'entity_id' => $lineKey,
4025 if ($context !== 'paylater') {
4026 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
4031 * Check correct financial transaction entries were created for the change in payment instrument.
4033 * @param int $contributionID
4034 * @param int $originalInstrumentID
4035 * @param int $newInstrumentID
4036 * @param int $amount
4038 public function checkFinancialTrxnPaymentInstrumentChange($contributionID, $originalInstrumentID, $newInstrumentID, $amount = 100) {
4040 $entityFinancialTrxns = $this->getFinancialTransactionsForContribution($contributionID);
4042 $originalTrxnParams = [
4043 'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($originalInstrumentID),
4044 'payment_instrument_id' => $originalInstrumentID,
4045 'amount' => $amount,
4049 $reversalTrxnParams = [
4050 'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($originalInstrumentID),
4051 'payment_instrument_id' => $originalInstrumentID,
4052 'amount' => -$amount,
4057 'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($newInstrumentID),
4058 'payment_instrument_id' => $newInstrumentID,
4059 'amount' => $amount,
4063 foreach ([$originalTrxnParams, $reversalTrxnParams, $newTrxnParams] as $index => $transaction) {
4064 $entityFinancialTrxn = $entityFinancialTrxns[$index];
4065 $this->assertEquals($entityFinancialTrxn['amount'], $transaction['amount']);
4067 $financialTrxn = $this->callAPISuccessGetSingle('FinancialTrxn', [
4068 'id' => $entityFinancialTrxn['financial_trxn_id'],
4070 $this->assertEquals($transaction['status_id'], $financialTrxn['status_id']);
4071 $this->assertEquals($transaction['amount'], $financialTrxn['total_amount']);
4072 $this->assertEquals($transaction['amount'], $financialTrxn['net_amount']);
4073 $this->assertEquals(0, $financialTrxn['fee_amount']);
4074 $this->assertEquals($transaction['payment_instrument_id'], $financialTrxn['payment_instrument_id']);
4075 $this->assertEquals($transaction['to_financial_account_id'], $financialTrxn['to_financial_account_id']);
4078 $this->assertEquals(1, $financialTrxn['is_payment']);
4079 $this->assertEquals('USD', $financialTrxn['currency']);
4080 $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($financialTrxn['trxn_date'])));
4085 * Check financial transaction.
4087 * @todo break this down into sensible functions - most calls to it only use a few lines out of the big if.
4089 * @param array $contribution
4090 * @param string $context
4091 * @param int $instrumentId
4092 * @param array $extraParams
4094 public function _checkFinancialTrxn($contribution, $context, $instrumentId = NULL, $extraParams = []) {
4095 $financialTrxns = $this->getFinancialTransactionsForContribution($contribution['id']);
4096 $trxn = array_pop($financialTrxns);
4099 'id' => $trxn['financial_trxn_id'],
4101 if ($context === 'payLater') {
4104 'from_financial_account_id' => CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($contribution['financial_type_id'], 'Accounts Receivable Account is'),
4107 elseif ($context === 'refund') {
4109 'to_financial_account_id' => 6,
4110 'total_amount' => -100,
4112 'trxn_date' => '2015-01-01 09:00:00',
4113 'trxn_id' => 'the refund',
4116 elseif ($context === 'cancelPending') {
4118 'to_financial_account_id' => 7,
4119 'total_amount' => -100,
4123 elseif ($context === 'changeFinancial' ||
$context === 'paymentInstrument') {
4124 // @todo checkFinancialTrxnPaymentInstrumentChange instead for paymentInstrument.
4125 // It does the same thing with greater readability.
4126 // @todo remove handling for
4129 'entity_id' => $contribution['id'],
4130 'entity_table' => 'civicrm_contribution',
4133 $trxn = current(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($entityParams));
4135 'id' => $trxn['financial_trxn_id'],
4137 if (empty($extraParams)) {
4139 'total_amount' => -100,
4143 elseif ($context !== 'changeFinancial') {
4145 'total_amount' => 100,
4149 if ($context === 'paymentInstrument') {
4150 $compareParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($instrumentId);
4151 $compareParams['payment_instrument_id'] = $instrumentId;
4154 $compareParams['to_financial_account_id'] = 12;
4156 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams1, array_merge($compareParams, $extraParams));
4157 $compareParams['total_amount'] = 100;
4158 // Reverse the extra params now that we will be checking the new positive transaction.
4159 if ($context === 'changeFinancial' && !empty($extraParams)) {
4160 foreach ($extraParams as $param => $value) {
4161 $extraParams[$param] = 0 - $value;
4166 $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $params, array_merge($compareParams, $extraParams));
4172 public function _addPaymentInstrument() {
4173 $gId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'payment_instrument', 'id', 'name');
4175 'option_group_id' => $gId,
4176 'label' => 'Test Card',
4177 'name' => 'Test Card',
4182 $optionValue = $this->callAPISuccess('option_value', 'create', $optionParams);
4183 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
4184 $financialParams = [
4185 'entity_table' => 'civicrm_option_value',
4186 'entity_id' => $optionValue['id'],
4187 'account_relationship' => $relationTypeId,
4188 'financial_account_id' => 7,
4190 CRM_Financial_BAO_FinancialTypeAccount
::add($financialParams);
4191 $this->assertNotEmpty($optionValue['values'][$optionValue['id']]['value']);
4192 return $optionValue['values'][$optionValue['id']]['value'];
4195 public function _deletedAddedPaymentInstrument() {
4196 $result = $this->callAPISuccess('OptionValue', 'get', [
4197 'option_group_id' => 'payment_instrument',
4198 'name' => 'Test Card',
4202 if ($id = CRM_Utils_Array
::value('id', $result)) {
4203 $this->callAPISuccess('OptionValue', 'delete', ['id' => $id]);
4208 * Set up the basic recurring contribution for tests.
4210 * @param array $generalParams
4211 * Parameters that can be merged into the recurring AND the contribution.
4213 * @param array $recurParams
4214 * Parameters to merge into the recur only.
4217 * @throws \CRM_Core_Exception
4219 protected function setUpRecurringContribution($generalParams = [], $recurParams = []) {
4220 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
4221 'contact_id' => $this->_individualId
,
4222 'installments' => '12',
4223 'frequency_interval' => '1',
4225 'contribution_status_id' => 1,
4226 'start_date' => '2012-01-01 00:00:00',
4227 'currency' => 'USD',
4228 'frequency_unit' => 'month',
4229 'payment_processor_id' => $this->paymentProcessorID
,
4230 ], $generalParams, $recurParams));
4231 $contributionParams = array_merge(
4234 'contribution_recur_id' => $contributionRecur['id'],
4235 'contribution_status_id' => 'Pending',
4237 $contributionParams['api.Payment.create'] = ['total_amount' => $contributionParams['total_amount']];
4238 $originalContribution = $this->callAPISuccess('Order', 'create', $contributionParams);
4239 return $originalContribution;
4243 * Set up a basic auto-renew membership for tests.
4245 * @param array $generalParams
4246 * Parameters that can be merged into the recurring AND the contribution.
4248 * @param array $recurParams
4249 * Parameters to merge into the recur only.
4252 * @throws \CRM_Core_Exception
4254 protected function setUpAutoRenewMembership($generalParams = [], $recurParams = []) {
4255 $newContact = $this->callAPISuccess('Contact', 'create', [
4256 'contact_type' => 'Individual',
4257 'sort_name' => 'McTesterson, Testy',
4258 'display_name' => 'Testy McTesterson',
4259 'preferred_language' => 'en_US',
4260 'preferred_mail_format' => 'Both',
4261 'first_name' => 'Testy',
4262 'last_name' => 'McTesterson',
4263 'contact_is_deleted' => '0',
4265 'email' => 'tmctesterson@example.com',
4268 $membershipType = $this->callAPISuccess('MembershipType', 'create', [
4269 'domain_id' => 'Default Domain Name',
4270 'member_of_contact_id' => 1,
4271 'financial_type_id' => 'Member Dues',
4272 'duration_unit' => 'month',
4273 'duration_interval' => 1,
4274 'period_type' => 'rolling',
4275 'name' => 'Standard Member',
4276 'minimum_fee' => 100,
4278 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
4279 'contact_id' => $newContact['id'],
4280 'installments' => '12',
4281 'frequency_interval' => '1',
4283 'contribution_status_id' => 1,
4284 'start_date' => '2012-01-01 00:00:00',
4285 'currency' => 'USD',
4286 'frequency_unit' => 'month',
4287 'payment_processor_id' => $this->paymentProcessorID
,
4288 ], $generalParams, $recurParams));
4290 $originalContribution = $this->callAPISuccess('Order', 'create', array_merge(
4293 'contact_id' => $newContact['id'],
4294 'contribution_recur_id' => $contributionRecur['id'],
4295 'financial_type_id' => 'Member Dues',
4296 'api.Payment.create' => ['total_amount' => 100, 'payment_instrument_id' => 'Credit card'],
4297 'invoice_id' => 2345,
4302 'membership_type_id' => $membershipType['id'],
4303 'financial_type_id' => 'Member Dues',
4304 'line_total' => $generalParams['total_amount'] ??
100,
4308 'contact_id' => $newContact['id'],
4309 'contribution_recur_id' => $contributionRecur['id'],
4310 'membership_type_id' => $membershipType['id'],
4317 $lineItem = $this->callAPISuccess('LineItem', 'getsingle', []);
4318 $this->assertEquals('civicrm_membership', $lineItem['entity_table']);
4319 $membership = $this->callAPISuccess('Membership', 'getsingle', ['id' => $lineItem['entity_id']]);
4320 $this->callAPISuccess('LineItem', 'getsingle', []);
4321 $this->callAPISuccessGetCount('MembershipPayment', ['membership_id' => $membership['id']], 1);
4323 return [$originalContribution, $membership];
4327 * Set up a repeat transaction.
4329 * @param array $recurParams
4330 * @param string $flag
4331 * @param array $contributionParams
4335 protected function setUpRepeatTransaction(array $recurParams, $flag, array $contributionParams = []) {
4336 $paymentProcessorID = $this->paymentProcessorCreate();
4337 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
4338 'contact_id' => $this->_individualId
,
4339 'installments' => '12',
4340 'frequency_interval' => '1',
4342 'contribution_status_id' => 1,
4343 'start_date' => '2012-01-01 00:00:00',
4344 'currency' => 'USD',
4345 'frequency_unit' => 'month',
4346 'payment_processor_id' => $paymentProcessorID,
4349 $originalContribution = '';
4350 if ($flag === 'multiple') {
4351 // CRM-19309 create a contribution + also add in line_items (plural):
4352 $this->createContributionWithTwoLineItemsAgainstPriceSet([
4353 'contact_id' => $this->_individualId
,
4354 'contribution_recur_id' => $contributionRecur['id'],
4356 $originalContribution = $this->callAPISuccessGetSingle('Contribution', ['contribution_recur_id' => $contributionRecur['id'], 'return' => 'id']);
4358 elseif ($flag === 'single') {
4359 $params = array_merge($this->_params
, ['contribution_recur_id' => $contributionRecur['id']]);
4360 $params = array_merge($params, $contributionParams);
4361 $originalContribution = $this->callAPISuccess('Order', 'create', $params);
4362 // Note the saved contribution amount will include tax.
4363 $this->callAPISuccess('Payment', 'create', [
4364 'contribution_id' => $originalContribution['id'],
4365 'total_amount' => $originalContribution['values'][$originalContribution['id']]['total_amount'],
4368 $originalContribution['contribution_recur_id'] = $contributionRecur['id'];
4369 $originalContribution['payment_processor_id'] = $paymentProcessorID;
4370 return $originalContribution;
4374 * Common set up routine.
4377 * @throws \CRM_Core_Exception
4379 protected function setUpForCompleteTransaction(): array {
4380 $this->mut
= new CiviMailUtils($this, TRUE);
4381 $this->createLoggedInUser();
4382 $params = array_merge($this->_params
, ['contribution_status_id' => 2, 'receipt_date' => 'now']);
4383 return $this->callAPISuccess('Contribution', 'create', $params);
4387 * Test repeat contribution uses the Payment Processor' payment_instrument setting.
4389 * @throws \CRM_Core_Exception
4391 public function testRepeatTransactionWithNonCreditCardDefault() {
4392 $contributionRecur = $this->callAPISuccess('ContributionRecur', 'create', [
4393 'contact_id' => $this->_individualId
,
4394 'installments' => '12',
4395 'frequency_interval' => '1',
4397 'contribution_status_id' => 1,
4398 'start_date' => '2012-01-01 00:00:00',
4399 'currency' => 'USD',
4400 'frequency_unit' => 'month',
4401 'payment_processor_id' => $this->paymentProcessorID
,
4403 $contribution1 = $this->callAPISuccess('contribution', 'create', array_merge(
4405 ['contribution_recur_id' => $contributionRecur['id'], 'payment_instrument_id' => 2])
4407 $contribution2 = $this->callAPISuccess('contribution', 'repeattransaction', [
4408 'contribution_status_id' => 'Completed',
4409 'trxn_id' => 'blah',
4410 'original_contribution_id' => $contribution1,
4412 $this->assertEquals('Debit Card', CRM_Contribute_PseudoConstant
::getLabel('CRM_Contribute_BAO_Contribution', 'payment_instrument_id', $contribution2['values'][$contribution2['id']]['payment_instrument_id']));
4416 * CRM-20008 Tests repeattransaction creates pending membership.
4418 * @throws \CRM_Core_Exception
4420 public function testRepeatTransactionMembershipCreatePendingContribution(): void
{
4421 [$originalContribution, $membership] = $this->setUpAutoRenewMembership();
4422 $this->callAPISuccess('membership', 'create', [
4423 'id' => $membership['id'],
4424 'end_date' => 'yesterday',
4425 'status_id' => 'Expired',
4427 $repeatedContribution = $this->callAPISuccess('contribution', 'repeattransaction', [
4428 'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
4429 'contribution_status_id' => 'Pending',
4432 $membershipStatusId = $this->callAPISuccess('membership', 'getvalue', [
4433 'id' => $membership['id'],
4434 'return' => 'status_id',
4437 // Let's see if the membership payments got created while we're at it.
4438 $membershipPayments = $this->callAPISuccess('MembershipPayment', 'get', [
4439 'membership_id' => $membership['id'],
4441 $this->assertEquals(2, $membershipPayments['count']);
4443 $this->assertEquals('Expired', CRM_Core_PseudoConstant
::getLabel('CRM_Member_BAO_Membership', 'status_id', $membershipStatusId));
4444 $this->callAPISuccess('Contribution', 'completetransaction', ['id' => $repeatedContribution['id']]);
4445 $membership = $this->callAPISuccessGetSingle('membership', [
4446 'id' => $membership['id'],
4447 'return' => 'status_id, end_date',
4449 $this->assertEquals('New', CRM_Core_PseudoConstant
::getName('CRM_Member_BAO_Membership', 'status_id', $membership['status_id']));
4450 $this->assertEquals(date('Y-m-d', strtotime('yesterday + 1 month')), $membership['end_date']);
4454 * Test sending a mail via the API.
4456 * @throws \CRM_Core_Exception
4458 public function testSendMailWithAPISetFromDetails() {
4459 $mut = new CiviMailUtils($this, TRUE);
4460 $contribution = $this->callAPISuccess('contribution', 'create', $this->_params
);
4461 $this->callAPISuccess('contribution', 'sendconfirmation', [
4462 'id' => $contribution['id'],
4463 'receipt_from_email' => 'api@civicrm.org',
4464 'receipt_from_name' => 'CiviCRM LLC',
4466 $mut->checkMailLog([
4467 'From: CiviCRM LLC <api@civicrm.org>',
4468 'Contribution Information',
4476 * Test sending a mail via the API.
4478 public function testSendMailWithNoFromSetFallToDomain() {
4479 $this->createLoggedInUser();
4480 $mut = new CiviMailUtils($this, TRUE);
4481 $contribution = $this->callAPISuccess('contribution', 'create', $this->_params
);
4482 $this->callAPISuccess('contribution', 'sendconfirmation', [
4483 'id' => $contribution['id'],
4485 $domain = $this->callAPISuccess('domain', 'getsingle', ['id' => 1]);
4486 $mut->checkMailLog([
4487 'From: ' . $domain['from_name'] . ' <' . $domain['from_email'] . '>',
4488 'Contribution Information',
4496 * Test sending a mail via the API.
4498 * @throws \CRM_Core_Exception
4500 public function testSendMailWithRepeatTransactionAPIFalltoDomain() {
4501 $this->createLoggedInUser();
4502 $mut = new CiviMailUtils($this, TRUE);
4503 $contribution = $this->setUpRepeatTransaction([], 'single');
4504 $this->callAPISuccess('contribution', 'repeattransaction', [
4505 'contribution_status_id' => 'Completed',
4507 'original_contribution_id' => $contribution,
4509 $domain = $this->callAPISuccess('domain', 'getsingle', ['id' => 1]);
4510 $mut->checkMailLog([
4511 'From: ' . $domain['from_name'] . ' <' . $domain['from_email'] . '>',
4512 'Contribution Information',
4521 * Test sending a mail via the API.
4523 * @throws \CRM_Core_Exception
4525 public function testSendMailWithRepeatTransactionAPIFalltoContributionPage() {
4526 $mut = new CiviMailUtils($this, TRUE);
4527 $contributionPage = $this->contributionPageCreate(['receipt_from_name' => 'CiviCRM LLC', 'receipt_from_email' => 'contributionpage@civicrm.org', 'is_email_receipt' => 1]);
4528 $paymentProcessorID = $this->paymentProcessorCreate();
4529 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
4530 'contact_id' => $this->_individualId
,
4531 'installments' => '12',
4532 'frequency_interval' => '1',
4534 'contribution_status_id' => 1,
4535 'start_date' => '2012-01-01 00:00:00',
4536 'currency' => 'USD',
4537 'frequency_unit' => 'month',
4538 'payment_processor_id' => $paymentProcessorID,
4540 $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
4543 'contribution_recur_id' => $contributionRecur['id'],
4544 'contribution_page_id' => $contributionPage['id'],
4547 $this->callAPISuccess('Contribution', 'repeattransaction', [
4548 'contribution_status_id' => 'Completed',
4550 'original_contribution_id' => $originalContribution,
4553 $mut->checkMailLog([
4554 'From: CiviCRM LLC <contributionpage@civicrm.org>',
4555 'Contribution Information',
4563 * Test sending a mail via the API.
4565 * @throws \CRM_Core_Exception
4567 public function testSendMailWithRepeatTransactionAPIFalltoSystemFromNoDefaultFrom(): void
{
4568 $mut = new CiviMailUtils($this, TRUE);
4569 $originalContribution = $this->setUpRepeatTransaction([], 'single');
4570 $fromEmail = $this->callAPISuccess('optionValue', 'get', ['is_default' => 1, 'option_group_id' => 'from_email_address', 'sequential' => 1]);
4571 foreach ($fromEmail['values'] as $from) {
4572 $this->callAPISuccess('optionValue', 'create', ['is_default' => 0, 'id' => $from['id']]);
4574 $domain = $this->callAPISuccess('domain', 'getsingle', ['id' => CRM_Core_Config
::domainID()]);
4575 $this->callAPISuccess('contribution', 'repeattransaction', [
4576 'contribution_status_id' => 'Completed',
4578 'original_contribution_id' => $originalContribution,
4580 $mut->checkMailLog([
4581 'From: ' . $domain['name'] . ' <' . $domain['domain_email'] . '>',
4582 'Contribution Information',
4590 * Create a Contribution Page with is_email_receipt = TRUE.
4592 * @param array $params
4593 * Params to overwrite with.
4597 protected function createReceiptableContributionPage($params = []) {
4598 $contributionPage = $this->callAPISuccess('ContributionPage', 'create', array_merge([
4599 'receipt_from_name' => 'Mickey Mouse',
4600 'receipt_from_email' => 'mickey@mouse.com',
4601 'title' => "Test Contribution Page",
4602 'financial_type_id' => 1,
4603 'currency' => 'CAD',
4604 'is_monetary' => TRUE,
4605 'is_email_receipt' => TRUE,
4607 return $contributionPage;
4611 * function to test card_type and pan truncation.
4613 * @throws \CRM_Core_Exception
4615 public function testCardTypeAndPanTruncation() {
4616 $creditCardTypeIDs = array_flip(CRM_Financial_DAO_FinancialTrxn
::buildOptions('card_type_id'));
4617 $contactId = $this->individualCreate();
4619 'contact_id' => $contactId,
4620 'receive_date' => '2016-01-20',
4621 'total_amount' => 100,
4622 'financial_type_id' => 1,
4623 'payment_instrument' => 'Credit Card',
4624 'card_type_id' => $creditCardTypeIDs['Visa'],
4625 'pan_truncation' => 4567,
4627 $contribution = $this->callAPISuccess('contribution', 'create', $params);
4628 $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($contribution['id'], 'DESC');
4629 $financialTrxn = $this->callAPISuccessGetSingle(
4632 'id' => $lastFinancialTrxnId['financialTrxnId'],
4633 'return' => ['card_type_id', 'pan_truncation'],
4636 $this->assertEquals(CRM_Utils_Array
::value('card_type_id', $financialTrxn), $creditCardTypeIDs['Visa']);
4637 $this->assertEquals(CRM_Utils_Array
::value('pan_truncation', $financialTrxn), 4567);
4639 'id' => $contribution['id'],
4640 'pan_truncation' => 2345,
4641 'card_type_id' => $creditCardTypeIDs['Amex'],
4643 $this->callAPISuccess('contribution', 'create', $params);
4644 $financialTrxn = $this->callAPISuccessGetSingle(
4647 'id' => $lastFinancialTrxnId['financialTrxnId'],
4648 'return' => ['card_type_id', 'pan_truncation'],
4651 $this->assertEquals(CRM_Utils_Array
::value('card_type_id', $financialTrxn), $creditCardTypeIDs['Amex']);
4652 $this->assertEquals(CRM_Utils_Array
::value('pan_truncation', $financialTrxn), 2345);
4656 * Test repeat contribution uses non default currency
4658 * @see https://issues.civicrm.org/jira/projects/CRM/issues/CRM-20678
4659 * @throws \CRM_Core_Exception
4661 public function testRepeatTransactionWithDifferenceCurrency() {
4662 $originalContribution = $this->setUpRepeatTransaction(['currency' => 'AUD'], 'single', ['currency' => 'AUD']);
4663 $contribution = $this->callAPISuccess('Contribution', 'repeattransaction', [
4664 'original_contribution_id' => $originalContribution['id'],
4665 'contribution_status_id' => 'Completed',
4668 $this->assertEquals('AUD', $contribution['values'][$contribution['id']]['currency']);
4672 * Get the financial items for the contribution.
4674 * @param int $contributionID
4677 * Array of associated financial items.
4679 protected function getFinancialTransactionsForContribution($contributionID) {
4681 'entity_id' => $contributionID,
4682 'entity_table' => 'civicrm_contribution',
4684 // @todo the following function has naming errors & has a weird signature & appears to
4685 // only be called from test classes. Move into test suite & maybe just use api
4686 // from this function.
4687 return array_merge(CRM_Financial_BAO_FinancialItem
::retrieveEntityFinancialTrxn($trxnParams));
4691 * Test getunique api call for Contribution entity
4693 public function testContributionGetUnique() {
4694 $result = $this->callAPIAndDocument($this->entity
, 'getunique', [], __FUNCTION__
, __FILE__
);
4695 $this->assertEquals(2, $result['count']);
4696 $this->assertEquals(['trxn_id'], $result['values']['UI_contrib_trxn_id']);
4697 $this->assertEquals(['invoice_id'], $result['values']['UI_contrib_invoice_id']);
4701 * Test Repeat Transaction Contribution with Tax amount.
4703 * https://lab.civicrm.org/dev/core/issues/806
4705 * @throws \CRM_Core_Exception
4707 public function testRepeatContributionWithTaxAmount(): void
{
4708 $this->enableTaxAndInvoicing();
4709 $financialType = $this->callAPISuccess('financial_type', 'create', [
4710 'name' => 'Test taxable financial Type',
4714 $this->addTaxAccountToFinancialType($financialType['id']);
4715 $contribution = $this->setUpRepeatTransaction(
4719 'financial_type_id' => $financialType['id'],
4722 $this->callAPISuccess('contribution', 'repeattransaction', [
4723 'original_contribution_id' => $contribution['id'],
4724 'contribution_status_id' => 'Completed',
4725 'trxn_id' => 'test',
4727 $payments = $this->callAPISuccess('Contribution', 'get', ['sequential' => 1, 'return' => ['total_amount', 'tax_amount']])['values'];
4728 //Assert if first payment and repeated payment has the same contribution amount.
4729 $this->assertEquals($payments[0]['total_amount'], $payments[1]['total_amount']);
4730 $this->callAPISuccessGetCount('Contribution', [], 2);
4732 //Assert line item records.
4733 $lineItems = $this->callAPISuccess('LineItem', 'get', ['sequential' => 1])['values'];
4734 foreach ($lineItems as $lineItem) {
4735 $taxExclusiveAmount = $payments[0]['total_amount'] - $payments[0]['tax_amount'];
4736 $this->assertEquals($lineItem['unit_price'], $taxExclusiveAmount);
4737 $this->assertEquals($lineItem['line_total'], $taxExclusiveAmount);
4739 $this->callAPISuccessGetCount('Contribution', [], 2);
4742 public function testGetCurrencyOptions() {
4743 $result = $this->callAPISuccess('Contribution', 'getoptions', [
4744 'field' => 'currency',
4746 $this->assertEquals('US Dollar', $result['values']['USD']);
4747 $this->assertNotContains('$', $result['values']);
4748 $result = $this->callAPISuccess('Contribution', 'getoptions', [
4749 'field' => 'currency',
4750 'context' => "abbreviate",
4752 $this->assertEquals('$', $result['values']['USD']);
4753 $this->assertNotContains('US Dollar', $result['values']);
4757 * @throws \API_Exception
4758 * @throws \CRM_Core_Exception
4759 * @throws \Civi\API\Exception\UnauthorizedException
4761 public function testSetCustomDataInCreateAndHook() {
4762 $this->createCustomGroupWithFieldOfType([], 'int');
4763 $this->ids
['CustomField']['text'] = (int) $this->createTextCustomField(['custom_group_id' => $this->ids
['CustomGroup']['Custom Group']])['id'];
4764 $this->hookClass
->setHook('civicrm_post', [
4766 'civicrmPostContributionCustom',
4768 $params = $this->_params
;
4769 $params['custom_' . $this->ids
['CustomField']['text']] = 'Some Text';
4770 $contribution = $this->callAPISuccess('Contribution', 'create', $params);
4771 $getContribution = $this->callAPISuccess('Contribution', 'get', [
4772 'id' => $contribution['id'],
4773 'return' => ['id', 'custom_' . $this->ids
['CustomField']['text'], 'custom_' . $this->ids
['CustomField']['int']],
4775 $this->assertEquals(5, $getContribution['values'][$contribution['id']][$this->getCustomFieldName('int')]);
4776 $this->assertEquals('Some Text', $getContribution['values'][$contribution['id']]['custom_' . $this->ids
['CustomField']['text']]);
4777 $this->callAPISuccess('CustomField', 'delete', ['id' => $this->ids
['CustomField']['text']]);
4778 $this->callAPISuccess('CustomField', 'delete', ['id' => $this->ids
['CustomField']['int']]);
4779 $this->callAPISuccess('CustomGroup', 'delete', ['id' => $this->ids
['CustomGroup']['Custom Group']]);
4783 * Implement post hook.
4786 * @param string $objectName
4787 * @param int|null $objectId
4789 * @throws \CRM_Core_Exception
4791 public function civicrmPostContributionCustom(string $op, string $objectName, ?
int $objectId): void
{
4792 if ($objectName === 'Contribution' && $op === 'create') {
4793 $this->callAPISuccess('Contribution', 'create', [
4795 'custom_' . $this->ids
['CustomField']['int'] => 5,
4801 * Test that passing in label for an option value linked to a custom field
4804 * @see dev/core#1816
4806 * @throws \API_Exception
4807 * @throws \CRM_Core_Exception
4809 public function testCustomValueOptionLabelTest(): void
{
4810 $this->createCustomGroupWithFieldOfType([], 'radio');
4811 $params = $this->_params
;
4812 $params['custom_' . $this->ids
['CustomField']['radio']] = 'Red Testing';
4813 $this->callAPISuccess('Contribution', 'Create', $params);
4817 * Test repeatTransaction with installments and next_sched_contribution_date
4819 * @dataProvider getRepeatTransactionNextSchedData
4821 * @param array $dataSet
4823 * @throws \CRM_Core_Exception
4825 public function testRepeatTransactionUpdateNextSchedContributionDate(array $dataSet): void
{
4826 $paymentProcessorID = $this->paymentProcessorCreate();
4827 // Create the contribution before the recur so it doesn't trigger the update of next_sched_contribution_date
4828 $contribution = $this->callAPISuccess('contribution', 'create', array_merge(
4831 'contribution_status_id' => 'Completed',
4832 'receive_date' => $dataSet['repeat'][0]['receive_date'],
4835 $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
4836 'contact_id' => $this->_individualId
,
4837 'frequency_interval' => '1',
4839 'contribution_status_id' => 'Pending',
4840 'start_date' => '2012-01-01 00:00:00',
4841 'currency' => 'USD',
4842 'frequency_unit' => 'month',
4843 'payment_processor_id' => $paymentProcessorID,
4844 ], $dataSet['recur']));
4845 // Link the existing contribution to the recur *after* creating the recur.
4846 // If we just created the contribution now the next_sched_contribution_date would be automatically set
4847 // and we want to test the case when it is empty.
4848 $this->callAPISuccess('contribution', 'create', [
4849 'id' => $contribution['id'],
4850 'contribution_recur_id' => $contributionRecur['id'],
4853 $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
4854 'id' => $contributionRecur['id'],
4855 'return' => ['next_sched_contribution_date', 'contribution_status_id'],
4857 // Check that next_sched_contribution_date is empty
4858 $this->assertEquals('', $contributionRecur['next_sched_contribution_date'] ??
'');
4860 $this->callAPISuccess('Contribution', 'repeattransaction', [
4861 'contribution_status_id' => 'Completed',
4862 'contribution_recur_id' => $contributionRecur['id'],
4863 'receive_date' => $dataSet['repeat'][0]['receive_date'],
4865 $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
4866 'id' => $contributionRecur['id'],
4867 'return' => ['next_sched_contribution_date', 'contribution_status_id'],
4869 // Check that recur has status "In Progress"
4870 $this->assertEquals(
4871 (string) CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', $dataSet['repeat'][0]['expectedRecurStatus']),
4872 $contributionRecur['contribution_status_id']
4874 // Check that next_sched_contribution_date has been set to 1 period after the contribution receive date (ie. 1 month)
4875 $this->assertEquals($dataSet['repeat'][0]['expectedNextSched'], $contributionRecur['next_sched_contribution_date']);
4877 // Now call Contribution.repeattransaction again and check that the next_sched_contribution_date has moved forward by 1 period again
4878 $this->callAPISuccess('Contribution', 'repeattransaction', [
4879 'contribution_status_id' => 'Completed',
4880 'contribution_recur_id' => $contributionRecur['id'],
4881 'receive_date' => $dataSet['repeat'][1]['receive_date'],
4883 $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
4884 'id' => $contributionRecur['id'],
4885 'return' => ['next_sched_contribution_date', 'contribution_status_id'],
4887 // Check that recur has status "In Progress" or "Completed" depending on whether number of installments has been reached
4888 $this->assertEquals(
4889 (string) CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', $dataSet['repeat'][1]['expectedRecurStatus']),
4890 $contributionRecur['contribution_status_id']
4892 // Check that next_sched_contribution_date has been set to 1 period after the contribution receive date (ie. 1 month)
4893 $this->assertEquals($dataSet['repeat'][1]['expectedNextSched'], $contributionRecur['next_sched_contribution_date'] ??
'');
4897 * Get dates for testing.
4901 public function getRepeatTransactionNextSchedData(): array {
4902 // Both these tests handle/test the case that next_sched_contribution_date is empty when Contribution.repeattransaction
4903 // is called for the first time. Historically setting it was inconsistent but on new updates it should always be set.
4905 * This tests that calling Contribution.repeattransaction with installments does the following:
4906 * - For the first call to repeattransaction the recur status is In Progress and next_sched_contribution_date is updated
4907 * to match next expected receive_date.
4908 * - Once the 3rd contribution is created contributionRecur status = completed and next_sched_contribution_date = ''.
4910 $result['receive_date_includes_time_with_installments']['2012-01-01-1-month'] = [
4912 'start_date' => '2012-01-01',
4913 'frequency_interval' => 1,
4914 'installments' => '3',
4915 'frequency_unit' => 'month',
4919 'receive_date' => '2012-02-29 16:00:00',
4920 'expectedNextSched' => '2012-03-29 00:00:00',
4921 'expectedRecurStatus' => 'In Progress',
4924 'receive_date' => '2012-03-29 16:00:00',
4925 'expectedNextSched' => '',
4926 'expectedRecurStatus' => 'Completed',
4931 * This tests that calling Contribution.repeattransaction with no installments does the following:
4932 * - For the each call to repeattransaction the recur status is In Progress and next_sched_contribution_date is updated
4933 * to match next expected receive_date.
4935 $result['receive_date_includes_time_no_installments']['2012-01-01-1-month'] = [
4937 'start_date' => '2012-01-01',
4938 'frequency_interval' => 1,
4939 'frequency_unit' => 'month',
4943 'receive_date' => '2012-02-29 16:00:00',
4944 'expectedNextSched' => '2012-03-29 00:00:00',
4945 'expectedRecurStatus' => 'In Progress',
4948 'receive_date' => '2012-03-29 16:00:00',
4949 'expectedNextSched' => '2012-04-29 00:00:00',
4950 'expectedRecurStatus' => 'In Progress',
4958 * Make sure that recording a payment doesn't alter the receive_date of a
4959 * pending contribution.
4961 public function testPaymentDontChangeReceiveDate(): void
{
4963 'contact_id' => $this->_individualId
,
4964 'total_amount' => 100,
4965 'receive_date' => '2020-02-02',
4966 'contribution_status_id' => 'Pending',
4968 $contributionID = $this->contributionCreate($params);
4970 'contribution_id' => $contributionID,
4971 'total_amount' => 100,
4972 'trxn_date' => '2020-03-04',
4974 $this->callAPISuccess('payment', 'create', $paymentParams);
4976 //check if contribution status is set to "Completed".
4977 $contribution = $this->callAPISuccess('Contribution', 'getSingle', [
4978 'id' => $contributionID,
4980 $this->assertEquals('2020-02-02 00:00:00', $contribution['receive_date']);
4984 * Make sure that recording a payment with Different Payment Instrument update main contribution record payment
4985 * instrument too. If multiple Payment Recorded, last payment record payment (when No more due) instrument set to main
4988 public function testPaymentVerifyPaymentInstrumentChange() {
4989 // Create Pending contribution with pay later mode, with payment instrument Check
4991 'contact_id' => $this->_individualId
,
4992 'total_amount' => 100,
4993 'receive_date' => '2020-02-02',
4994 'contribution_status_id' => 'Pending',
4995 'is_pay_later' => 1,
4996 'payment_instrument_id' => 'Check',
4998 $contributionID = $this->contributionCreate($params);
5000 // Record the the Payment with instrument other than Check, e.g EFT
5002 'contribution_id' => $contributionID,
5003 'total_amount' => 50,
5004 'trxn_date' => '2020-03-04',
5005 'payment_instrument_id' => 'EFT',
5007 $this->callAPISuccess('payment', 'create', $paymentParams);
5009 $contribution = $this->callAPISuccess('Contribution', 'getSingle', [
5010 'id' => $contributionID,
5012 // payment status should be 'Partially paid'
5013 $this->assertEquals('Partially paid', $contribution['contribution_status']);
5015 // Record the the Payment with instrument other than Check, e.g Cash (pay all remaining amount)
5017 'contribution_id' => $contributionID,
5018 'total_amount' => 50,
5019 'trxn_date' => '2020-03-04',
5020 'payment_instrument_id' => 'Cash',
5022 $this->callAPISuccess('payment', 'create', $paymentParams);
5024 //check if contribution Payment Instrument (Payment Method) is is set to "Cash".
5025 $contribution = $this->callAPISuccess('Contribution', 'getSingle', [
5026 'id' => $contributionID,
5028 $this->assertEquals('Cash', $contribution['payment_instrument']);
5029 $this->assertEquals('Completed', $contribution['contribution_status']);
5033 * Test the "clean money" functionality.
5035 public function testCleanMoney() {
5037 'contact_id' => $this->_individualId
,
5038 'financial_type_id' => 1,
5039 'total_amount' => '$100',
5040 'fee_amount' => '$20',
5041 'net_amount' => '$80',
5042 'non_deductible_amount' => '$80',
5045 $id = $this->callAPISuccess('Contribution', 'create', $params)['id'];
5046 // Reading the return values of the API isn't reliable here; get the data from the db.
5047 $contribution = $this->callAPISuccess('Contribution', 'getsingle', ['id' => $id]);
5048 $this->assertEquals('100.00', $contribution['total_amount']);
5049 $this->assertEquals('20.00', $contribution['fee_amount']);
5050 $this->assertEquals('80.00', $contribution['net_amount']);
5051 $this->assertEquals('80.00', $contribution['non_deductible_amount']);
5055 * Create a price set with a quick config price set.
5057 * The params to use this look like
5059 * ['price_' . $this->ids['PriceField']['basic'] => $this->ids['PriceFieldValue']['basic']]
5061 * @param array $contributionPageParams
5065 * @throws \API_Exception
5066 * @throws \CRM_Core_Exception
5067 * @throws \Civi\API\Exception\UnauthorizedException
5069 private function createQuickConfigContributionPage(array $contributionPageParams = []): int {
5070 $contributionPageID = $this->callAPISuccess('ContributionPage', 'create', array_merge([
5071 'receipt_from_name' => 'Mickey Mouse',
5072 'receipt_from_email' => 'mickey@mouse.com',
5073 'title' => 'Test Contribution Page',
5074 'financial_type_id' => 'Member Dues',
5075 'currency' => 'CAD',
5076 'is_pay_later' => 1,
5077 'is_quick_config' => TRUE,
5078 'pay_later_text' => 'I will send payment by check',
5079 'pay_later_receipt' => 'This is a pay later receipt',
5080 'is_allow_other_amount' => 1,
5081 'min_amount' => 10.00,
5082 'max_amount' => 10000.00,
5083 'goal_amount' => 100000.00,
5084 'is_email_receipt' => 1,
5086 'amount_block_is_active' => 1,
5087 'is_billing_required' => 0,
5088 ], $contributionPageParams))['id'];
5090 $priceSetID = PriceSet
::create()->setValues([
5091 'name' => 'quick config set',
5092 'title' => 'basic price set',
5093 'is_quick_config' => TRUE,
5095 ])->execute()->first()['id'];
5097 $priceFieldID = PriceField
::create()->setValues([
5098 'price_set_id' => $priceSetID,
5099 'name' => 'quick config field name',
5100 'label' => 'quick config field name',
5101 'html_type' => 'Radio',
5102 ])->execute()->first()['id'];
5103 $this->ids
['PriceSet']['basic'] = $priceSetID;
5104 $this->ids
['PriceField']['basic'] = $priceFieldID;
5105 $this->ids
['PriceFieldValue']['basic'] = PriceFieldValue
::create()->setValues([
5106 'price_field_id' => $priceFieldID,
5107 'name' => 'quick config price field',
5108 'label' => 'quick config price field',
5110 'financial_type_id:name' => 'Member Dues',
5111 ])->execute()->first()['id'];
5112 CRM_Price_BAO_PriceSet
::addTo('civicrm_contribution_page', $contributionPageID, $priceSetID);
5113 return $contributionPageID;
5117 * Get the created contribution ID.
5119 * @param string $key
5123 protected function getContributionID(string $key = 'first'): int {
5124 return (int) $this->ids
['contribution'][$key];
5128 * Get the created contribution ID.
5132 protected function getMembershipID(): int {
5133 return (int) $this->_ids
['membership'];
5137 * Create a paid membership for renewal tests.
5139 protected function createSubsequentPendingMembership(): void
{
5140 $this->setUpPendingContribution($this->_ids
['price_field_value'][1], 'second', [], [], [
5141 'id' => $this->getMembershipID(),
5146 * Create a paid membership for renewal tests.
5148 protected function createInitialPaidMembership(): void
{
5149 $this->setUpPendingContribution($this->_ids
['price_field_value'][1]);
5150 $this->callAPISuccess('Payment', 'create', [
5151 'contribution_id' => $this->getContributionID(),
5152 'total_amount' => 20,