tests/phpunit/api/v3/ContributionTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  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;
  17
  18 /**
  19  *  Test APIv3 civicrm_contribute_* functions
  20  *
  21  * @package CiviCRM_APIv3
  22  * @subpackage API_Contribution
  23  * @group headless
  24  */
  25 class api_v3_ContributionTest extends CiviUnitTestCase {
  26
  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;
  32
  33   protected $_individualId;
  34   protected $_contribution;
  35   protected $_financialTypeId = 1;
  36   protected $entity = 'Contribution';
  37   protected $_params;
  38   protected $_ids = [];
  39   protected $_pageParams = [];
  40
  41   /**
  42    * Payment processor ID (dummy processor).
  43    *
  44    * @var int
  45    */
  46   protected $paymentProcessorID;
  47
  48   /**
  49    * Parameters to create payment processor.
  50    *
  51    * @var array
  52    */
  53   protected $_processorParams = [];
  54
  55   /**
  56    * ID of created event.
  57    *
  58    * @var int
  59    */
  60   protected $_eventID;
  61
  62   /**
  63    * @var CiviMailUtils
  64    */
  65   protected $mut;
  66
  67   /**
  68    * Should financials be checked after the test but before tear down.
  69    *
  70    * @var bool
  71    */
  72   protected $isValidateFinancialsOnPostAssert = TRUE;
  73
  74   /**
  75    * Setup function.
  76    */
  77   public function setUp(): void {
  78     parent::setUp();
  79
  80     $this->_apiversion = 3;
  81     $this->_individualId = $this->individualCreate();
  82     $this->_params = [
  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,
  88       'fee_amount' => 5.00,
  89       'net_amount' => 95.00,
  90       'source' => 'SSF',
  91       'contribution_status_id' => 1,
  92     ];
  93     $this->_processorParams = [
  94       'domain_id' => 1,
  95       'name' => 'Dummy',
  96       'payment_processor_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Financial_BAO_PaymentProcessor', 'payment_processor_type_id', 'Dummy'),
  97       'financial_account_id' => 12,
  98       'is_active' => 1,
  99       'user_name' => '',
 100       'url_site' => 'http://dummy.com',
 101       'url_recur' => 'http://dummy.com',
 102       'billing_mode' => 1,
 103     ];
 104     $this->paymentProcessorID = $this->processorCreate();
 105     $this->_pageParams = [
 106       'title' => 'Test Contribution Page',
 107       'financial_type_id' => 1,
 108       'currency' => 'USD',
 109       'financial_account_id' => 1,
 110       'payment_processor' => $this->paymentProcessorID,
 111       'is_active' => 1,
 112       'is_allow_other_amount' => 1,
 113       'min_amount' => 10,
 114       'max_amount' => 1000,
 115     ];
 116   }
 117
 118   /**
 119    * Clean up after each test.
 120    *
 121    * @throws \API_Exception
 122    * @throws \CRM_Core_Exception
 123    */
 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'],
 132         ]);
 133         foreach ($entityFinancialTypes['values'] as $entityFinancialType) {
 134           $this->callAPISuccess('EntityFinancialAccount', 'delete', ['id' => $entityFinancialType['id']]);
 135         }
 136         $this->callAPISuccess('FinancialAccount', 'delete', ['id' => $financialAccount['id']]);
 137       }
 138     }
 139     $this->restoreUFGroupOne();
 140     parent::tearDown();
 141   }
 142
 143   /**
 144    * Test Get.
 145    */
 146   public function testGetContribution(): void {
 147     $this->enableTaxAndInvoicing();
 148     $p = [
 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,
 156       'trxn_id' => 23456,
 157       'invoice_id' => 78910,
 158       'source' => 'SSF',
 159       'contribution_status_id' => 'Completed',
 160     ];
 161     $this->_contribution = $this->callAPISuccess('contribution', 'create', $p);
 162
 163     $params = [
 164       'contribution_id' => $this->_contribution['id'],
 165       'return' => array_merge(['invoice_number', 'contribution_source'], array_keys($p)),
 166     ];
 167
 168     $contributions = $this->callAPIAndDocument('Contribution', 'get', $params, __FUNCTION__, __FILE__);
 169
 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';
 186
 187     $contribution2 = $this->callAPISuccess('contribution', 'create', $p);
 188
 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,
 196     ]);
 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,
 202     ]);
 203     $this->assertEquals($contribution2['id'], $contribution);
 204     // Test id as field.
 205     $contribution = $this->callAPISuccess('contribution', 'get', [
 206       'id' => $this->_contribution['id'],
 207     ]);
 208     $this->assertEquals(1, $contribution['count']);
 209
 210     // Test get by contact id works.
 211     $contribution = $this->callAPISuccess('contribution', 'get', ['contact_id' => $this->_individualId]);
 212
 213     $this->assertEquals(2, $contribution['count']);
 214     $this->callAPISuccess('Contribution', 'Delete', [
 215       'id' => $this->_contribution['id'],
 216     ]);
 217     $this->callAPISuccess('Contribution', 'Delete', [
 218       'id' => $contribution2['id'],
 219     ]);
 220   }
 221
 222   /**
 223    * Test that test contributions can be retrieved.
 224    *
 225    * @throws \CRM_Core_Exception
 226    */
 227   public function testGetTestContribution(): void {
 228     $this->callAPISuccess('Contribution', 'create', array_merge($this->_params, ['is_test' => 1]));
 229     $this->callAPISuccessGetSingle('Contribution', ['is_test' => 1]);
 230   }
 231
 232   /**
 233    * Test Creating a check contribution with original check_number field
 234    *
 235    * @throws \CRM_Core_Exception
 236    */
 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',
 252     ]);
 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',
 267     ]);
 268     foreach ($entityFinancialTrxn['values'] as $eft) {
 269       $financialTrxn = $this->callAPISuccess('FinancialTrxn', 'get', [
 270         'id' => $eft['financial_trxn_id'],
 271         'return' => 'check_number',
 272       ]);
 273       $this->assertEquals('bouncer', $financialTrxn['values'][$financialTrxn['id']]['check_number']);
 274     }
 275   }
 276
 277   /**
 278    * Test the 'return' param works for all fields.
 279    */
 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',
 295     ]);
 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,
 302       'amount' => 5,
 303     ]);
 304     $params['contribution_recur_id'] = $contributionRecur['id'];
 305
 306     $params['campaign_id'] = $this->campaignCreate();
 307
 308     $contributionID = $this->contributionCreate($params);
 309
 310     // update contribution with invoice number
 311     $params = array_merge($params, [
 312       'id' => $contributionID,
 313       'invoice_number' => Civi::settings()->get('invoice_prefix') . $contributionID,
 314       'trxn_id' => 12345,
 315       'invoice_id' => 6789,
 316     ]);
 317     $contributionID = $this->contributionCreate($params);
 318
 319     $contribution = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID]);
 320     $this->assertEquals('bouncer', $contribution['check_number']);
 321     $this->assertEquals('bouncer', $contribution['contribution_check_number']);
 322
 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'];
 331
 332     $fieldsLockedIn = [
 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',
 339     ];
 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';
 349       }
 350       $this->assertTrue((!empty($contribution[$returnField]) || $contribution[$returnField] === '0'), $returnField);
 351     }
 352     $entityFinancialTrxn = $this->callAPISuccess('EntityFinancialTrxn', 'get', [
 353       'entity_id' => $contributionID,
 354       'entity_table' => 'civicrm_contribution',
 355       'return' => 'financial_trxn_id',
 356     ]);
 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']);
 360     }
 361   }
 362
 363   /**
 364    * Test cancel reason works as a filter.
 365    *
 366    * @throws \CRM_Core_Exception
 367    */
 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);
 378   }
 379
 380   /**
 381    * We need to ensure previous tested api contract behaviour still works.
 382    *
 383    * @throws \CRM_Core_Exception
 384    */
 385   public function testGetContributionLegacyBehaviour(): void {
 386     $p = [
 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,
 394       'trxn_id' => 23456,
 395       'invoice_id' => 78910,
 396       'source' => 'SSF',
 397       'contribution_status_id' => 1,
 398     ];
 399     $this->_contribution = $this->callAPISuccess('Contribution', 'create', $p);
 400
 401     $params = [
 402       'contribution_id' => $this->_contribution['id'],
 403       'return' => array_keys($p),
 404     ];
 405     $params['return'][] = 'financial_type_id';
 406     $params['return'][] = 'contribution_source';
 407     $contribution = $this->callAPISuccess('Contribution', 'get', $params);
 408
 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');
 421
 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';
 425
 426     $contribution2 = $this->callAPISuccess('contribution', 'create', $p);
 427
 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,
 435     ]);
 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,
 441     ]);
 442     $this->assertEquals($contribution2['id'], $contribution);
 443     $contribution = $this->callAPISuccess('contribution', 'get', [
 444       'id' => $this->_contribution['id'],
 445     ]);
 446     //test id as field
 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]);
 451
 452     $this->assertEquals(2, $contribution['count']);
 453     $this->callAPISuccess('Contribution', 'Delete', [
 454       'id' => $this->_contribution['id'],
 455     ]);
 456     $this->callAPISuccess('Contribution', 'Delete', [
 457       'id' => $contribution2['id'],
 458     ]);
 459   }
 460
 461   /**
 462    * Create an contribution_id=FALSE and financial_type_id=Donation.
 463    */
 464   public function testCreateEmptyContributionIDUseDonation() {
 465     $params = [
 466       'contribution_id' => FALSE,
 467       'contact_id' => 1,
 468       'total_amount' => 1,
 469       'check_permissions' => FALSE,
 470       'financial_type_id' => 'Donation',
 471     ];
 472     $this->callAPISuccess('contribution', 'create', $params);
 473   }
 474
 475   /**
 476    * Check with complete array + custom field.
 477    *
 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
 481    *
 482    * @throws \CRM_Core_Exception
 483    */
 484   public function testCreateWithCustom(): void {
 485     $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 486
 487     $params = $this->_params;
 488     $params['custom_' . $ids['custom_field_id']] = 'custom string';
 489
 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'],
 495     ]);
 496     $this->assertEquals('custom string', $check['values'][$check['id']]['custom_' . $ids['custom_field_id']]);
 497   }
 498
 499   /**
 500    * Check with complete array + custom field.
 501    *
 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
 505    *
 506    * @throws \CRM_Core_Exception
 507    */
 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']);
 518   }
 519
 520   /**
 521    * Test creating a contribution without skipLineItems.
 522    *
 523    * @throws \CRM_Core_Exception
 524    */
 525   public function testCreateContributionNoLineItems(): void {
 526     // Turn off this validation as this test results in invalid
 527     // financial entities.
 528     $this->isValidateFinancialsOnPostAssert = FALSE;
 529     $params = [
 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,
 538       'trxn_id' => 12345,
 539       'invoice_id' => 67890,
 540       'source' => 'SSF',
 541       'contribution_status_id' => 1,
 542       'skipLineItem' => 1,
 543     ];
 544
 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'])));
 549     }
 550     $this->callAPISuccessGetCount('LineItem', [
 551       'entity_id' => $contribution['id'],
 552       'entity_table' => 'civicrm_contribution',
 553       'sequential' => 1,
 554     ], 0);
 555   }
 556
 557   /**
 558    * Test checks that passing in line items suppresses the create mechanism.
 559    *
 560    * @throws \CRM_Core_Exception
 561    */
 562   public function testCreateContributionChainedLineItems(): void {
 563     $params = [
 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,
 572       'trxn_id' => 12345,
 573       'invoice_id' => 67890,
 574       'source' => 'SSF',
 575       'contribution_status_id' => 'Pending',
 576       'skipLineItem' => 1,
 577       'api.line_item.create' => [
 578         [
 579           'price_field_id' => 1,
 580           'qty' => 2,
 581           'line_total' => '20',
 582           'unit_price' => '10',
 583         ],
 584         [
 585           'price_field_id' => 1,
 586           'qty' => 1,
 587           'line_total' => '80',
 588           'unit_price' => '80',
 589         ],
 590       ],
 591     ];
 592
 593     $description = 'Create Contribution with Nested Line Items.';
 594     $subFile = 'CreateWithNestedLineItems';
 595     $contribution = $this->callAPIAndDocument('Contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subFile);
 596
 597     $this->callAPISuccessGetCount('LineItem', [
 598       'entity_id' => $contribution['id'],
 599       'contribution_id' => $contribution['id'],
 600       'entity_table' => 'civicrm_contribution',
 601       'sequential' => 1,
 602     ], 2);
 603   }
 604
 605   /**
 606    * @throws \CRM_Core_Exception
 607    */
 608   public function testCreateContributionOffline(): void {
 609     $params = [
 610       'contact_id' => $this->_individualId,
 611       'receive_date' => '20120511',
 612       'total_amount' => 100.00,
 613       'financial_type_id' => 1,
 614       'trxn_id' => 12345,
 615       'invoice_id' => 67890,
 616       'source' => 'SSF',
 617       'contribution_status_id' => 1,
 618       'sequential' => 1,
 619     ];
 620
 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',
 633       'sequential' => 1,
 634       'return' => ['entity_id', 'contribution_id'],
 635     ]);
 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']);
 641   }
 642
 643   /**
 644    * Test create with valid payment instrument.
 645    *
 646    * @throws \CRM_Core_Exception
 647    */
 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', [
 652       'sequential' => 1,
 653       'id' => $contribution['id'],
 654       'return' => 'payment_instrument',
 655     ]);
 656     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 657     $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
 658
 659     $this->callAPISuccess('Contribution', 'create', [
 660       'id' => $contribution['id'],
 661       'payment_instrument' => 'Credit Card',
 662     ]);
 663     $contribution = $this->callAPISuccess('Contribution', 'get', [
 664       'sequential' => 1,
 665       'id' => $contribution['id'],
 666       'return' => 'payment_instrument',
 667     ]);
 668     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 669     $this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
 670   }
 671
 672   /**
 673    * @throws \CRM_Core_Exception
 674    */
 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', [
 681       'sequential' => 1,
 682       'contribution_payment_instrument' => 'Cash',
 683       'return' => 'payment_instrument',
 684     ]);
 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', [
 693       'sequential' => 1,
 694       'payment_instrument_id' => 5,
 695       'return' => 'payment_instrument',
 696     ]);
 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', [
 701       'sequential' => 1,
 702       'payment_instrument' => 'EFT',
 703       'return' => 'payment_instrument',
 704     ]);
 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',
 712     ]);
 713     $contribution = $this->callAPISuccess('Contribution', 'get', [
 714       'sequential' => 1,
 715       'id' => $contribution['id'],
 716       'return' => 'payment_instrument',
 717     ]);
 718     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 719     $this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
 720     $this->assertEquals(1, $contribution['count']);
 721   }
 722
 723   /**
 724    * CRM-16227 introduces invoice_id as a parameter.
 725    *
 726    * @throws \CRM_Core_Exception
 727    */
 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);
 733   }
 734
 735   /**
 736    * Check the credit note retrieval is case insensitive.
 737    *
 738    * @throws \CRM_Core_Exception
 739    */
 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']);
 745   }
 746
 747   /**
 748    * Test retrieval by total_amount works.
 749    *
 750    * @throws \CRM_Core_Exception
 751    */
 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);
 761   }
 762
 763   /**
 764    * @dataProvider createLocalizedContributionDataProvider
 765    *
 766    * @param float|int|string $totalAmount
 767    * @param string $decimalPoint
 768    * @param string $thousandSeparator
 769    * @param string $currency
 770    * @param bool $expectedResult
 771    *
 772    * @throws \CRM_Core_Exception
 773    */
 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);
 778
 779     $_params = [
 780       'contact_id' => $this->_individualId,
 781       'receive_date' => '20120511',
 782       'total_amount' => $totalAmount,
 783       'financial_type_id' => $this->_financialTypeId,
 784       'contribution_status_id' => 1,
 785     ];
 786
 787     if ($expectedResult) {
 788       $this->callAPISuccess('Contribution', 'create', $_params);
 789     }
 790     else {
 791       $this->callAPIFailure('Contribution', 'create', $_params);
 792     }
 793   }
 794
 795   /**
 796    * @return array
 797    */
 798   public function createLocalizedContributionDataProvider(): array {
 799     return [
 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],
 860     ];
 861   }
 862
 863   /**
 864    * Create test with unique field name on source.
 865    */
 866   public function testCreateContributionSource() {
 867
 868     $params = [
 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,
 877       'trxn_id' => 12345,
 878       'invoice_id' => 67890,
 879       'contribution_source' => 'SSF',
 880       'contribution_status_id' => 1,
 881     ];
 882
 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');
 886   }
 887
 888   /**
 889    * Create test with unique field name on source.
 890    *
 891    * @param string $thousandSeparator
 892    *   punctuation used to refer to thousands.
 893    *
 894    * @dataProvider getThousandSeparators
 895    */
 896   public function testCreateDefaultNow($thousandSeparator) {
 897     $this->setCurrencySeparators($thousandSeparator);
 898     $params = $this->_params;
 899     unset($params['receive_date'], $params['net_amount']);
 900
 901     $params['total_amount'] = $this->formatMoneyInput(5000.77);
 902     $params['fee_amount'] = $this->formatMoneyInput(.77);
 903     $params['skipCleanMoney'] = FALSE;
 904
 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']);
 911   }
 912
 913   /**
 914    * Create test with unique field name on source.
 915    */
 916   public function testCreateContributionNullOutThankyouDate() {
 917
 918     $params = $this->_params;
 919     $params['thankyou_date'] = 'yesterday';
 920
 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'])));
 924
 925     $params['thankyou_date'] = 'null';
 926     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 927     $this->assertTrue(empty($contribution['thankyou_date']));
 928   }
 929
 930   /**
 931    * Create test with unique field name on source.
 932    */
 933   public function testCreateContributionSourceInvalidContact() {
 934
 935     $params = [
 936       'contact_id' => 999,
 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,
 944       'trxn_id' => 12345,
 945       'invoice_id' => 67890,
 946       'contribution_source' => 'SSF',
 947       'contribution_status_id' => 1,
 948     ];
 949
 950     $this->callAPIFailure('contribution', 'create', $params, 'contact_id is not valid : 999');
 951   }
 952
 953   /**
 954    * Test note created correctly.
 955    *
 956    * @throws \CRM_Core_Exception
 957    */
 958   public function testCreateContributionWithNote(): void {
 959     $description = 'Demonstrates creating contribution with Note Entity.';
 960     $subFile = 'ContributionCreateWithNote';
 961     $params = [
 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,
 970       'trxn_id' => 12345,
 971       'invoice_id' => 67890,
 972       'source' => 'SSF',
 973       'contribution_status_id' => 1,
 974       'note' => 'my contribution note',
 975     ];
 976
 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'],
 981       'sequential' => 1,
 982       'return' => 'note',
 983     ]);
 984     $this->assertEquals('my contribution note', $result['values'][0]['note']);
 985     $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
 986   }
 987
 988   /**
 989    * @throws \CRM_Core_Exception
 990    */
 991   public function testCreateContributionWithNoteUniqueNameAliases(): void {
 992     $params = [
 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,
1001       'trxn_id' => 12345,
1002       'invoice_id' => 67890,
1003       'source' => 'SSF',
1004       'contribution_status_id' => 1,
1005       'contribution_note' => 'my contribution note',
1006     ];
1007
1008     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1009     $result = $this->callAPISuccess('note', 'get', [
1010       'entity_table' => 'civicrm_contribution',
1011       'entity_id' => $contribution['id'],
1012       'sequential' => 1,
1013       'return' => 'note',
1014     ]);
1015     $this->assertEquals('my contribution note', $result['values'][0]['note']);
1016   }
1017
1018   /**
1019    * This is the test for creating soft credits.
1020    */
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',
1027     ]);
1028     $softParams = [
1029       'contact_id' => $contact2['id'],
1030       'amount' => 50,
1031       'soft_credit_type_id' => 3,
1032     ];
1033
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]);
1037
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']);
1041
1042     $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
1043     $this->callAPISuccess('contact', 'delete', ['id' => $contact2['id']]);
1044   }
1045
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',
1052     ]);
1053     $params = $this->_params + [
1054       'soft_credit_to' => $contact2['id'],
1055     ];
1056     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
1057     $result = $this->callAPISuccess('contribution', 'get', ['return' => 'soft_credit', 'sequential' => 1]);
1058
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']);
1063
1064     $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
1065     $this->callAPISuccess('contact', 'delete', ['id' => $contact2['id']]);
1066   }
1067
1068   /**
1069    * Test creating contribution with Soft Credit by passing in honor_contact_id.
1070    */
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',
1077     ]);
1078     $params = $this->_params + [
1079       'honor_contact_id' => $contact2['id'],
1080     ];
1081     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
1082     $result = $this->callAPISuccess('contribution', 'get', ['return' => 'soft_credit', 'sequential' => 1]);
1083
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));
1090
1091     $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
1092     $this->callAPISuccess('contact', 'delete', ['id' => $contact2['id']]);
1093   }
1094
1095   /**
1096    * Test using example code.
1097    */
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);
1107   }
1108
1109   /**
1110    * Function tests that additional financial records are created when fee amount is recorded.
1111    */
1112   public function testCreateContributionWithFee() {
1113     $params = [
1114       'contact_id' => $this->_individualId,
1115       'receive_date' => '20120511',
1116       'total_amount' => 100.00,
1117       'fee_amount' => 50,
1118       'financial_type_id' => 1,
1119       'trxn_id' => 12345,
1120       'invoice_id' => 67890,
1121       'source' => 'SSF',
1122       'contribution_status_id' => 1,
1123     ];
1124
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);
1135
1136     $lineItems = $this->callAPISuccess('line_item', 'get', [
1137
1138       'entity_id' => $contribution['id'],
1139       'entity_table' => 'civicrm_contribution',
1140       'sequential' => 1,
1141       'return' => ['entity_id', 'contribution_id'],
1142     ]);
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', [
1147
1148       'entity_id' => $contribution['id'],
1149       'contribution_id' => $contribution['id'],
1150       'entity_table' => 'civicrm_contribution',
1151       'sequential' => 1,
1152     ], 1);
1153     $this->_checkFinancialRecords($contribution, 'feeAmount');
1154   }
1155
1156   /**
1157    * Function tests that additional financial records are created when online
1158    * contribution is created.
1159    *
1160    * @throws \CRM_Core_Exception
1161    * @throws \CiviCRM_API3_Exception
1162    */
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);
1167     $params = [
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,
1174       'trxn_id' => 12345,
1175       'invoice_id' => 67890,
1176       'source' => 'SSF',
1177       'contribution_status_id' => 1,
1178
1179     ];
1180
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',
1192     ]);
1193     $this->_checkFinancialRecords($contribution, 'online');
1194   }
1195
1196   /**
1197    * Check handling of financial type.
1198    *
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
1201    */
1202   public function testCreateInvalidFinancialType(): void {
1203     $params = $this->_params;
1204     $params['financial_type_id'] = 99999;
1205     $this->callAPIFailure($this->entity, 'create', $params);
1206   }
1207
1208   /**
1209    * Check handling of financial type.
1210    *
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
1213    *
1214    * @throws \CRM_Core_Exception
1215    */
1216   public function testValidNamedFinancialType() {
1217     $params = $this->_params;
1218     $params['financial_type_id'] = 'Donation';
1219     $this->callAPISuccess($this->entity, 'create', $params);
1220   }
1221
1222   /**
1223    * Tests that additional financial records are created.
1224    *
1225    * Checks when online contribution with pay later option is created
1226    *
1227    * @throws \CRM_Core_Exception
1228    */
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);
1233     $params = [
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'],
1239       'trxn_id' => 12345,
1240       'is_pay_later' => 1,
1241       'invoice_id' => 67890,
1242       'source' => 'SSF',
1243       'contribution_status_id' => 'Pending',
1244
1245     ];
1246
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');
1257   }
1258
1259   /**
1260    * Function tests that additional financial records are created for online contribution with pending option.
1261    */
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);
1266     $params = [
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'],
1272       'trxn_id' => 12345,
1273       'invoice_id' => 67890,
1274       'source' => 'SSF',
1275       'contribution_status_id' => 2,
1276     ];
1277
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');
1287   }
1288
1289   /**
1290    * Test that BAO defaults work.
1291    *
1292    * @throws \CRM_Core_Exception
1293    */
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'],
1301     ]);
1302     $this->assertEquals(1, $contribution['contribution_status_id']);
1303     $this->assertEquals('Check', $contribution['payment_instrument']);
1304     $this->callAPISuccessGetCount('Contribution', ['id' => $contribution['id']], 0);
1305   }
1306
1307   /**
1308    * Test that getsingle can be chained with delete.
1309    *
1310    * @throws CRM_Core_Exception
1311    */
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,
1317       'return' => 'id',
1318     ]);
1319     $this->callAPISuccessGetCount('Contribution', ['id' => $contribution['id']], 0);
1320   }
1321
1322   /**
1323    * Function tests that line items, financial records are updated when contribution amount is changed.
1324    *
1325    * @throws \CRM_Core_Exception
1326    */
1327   public function testCreateUpdateContributionChangeTotal() {
1328     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
1329     $lineItems = $this->callAPISuccess('line_item', 'getvalue', [
1330
1331       'entity_id' => $contribution['id'],
1332       'entity_table' => 'civicrm_contribution',
1333       'sequential' => 1,
1334       'return' => 'line_total',
1335     ]);
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);
1340     $newParams = [
1341
1342       'id' => $contribution['id'],
1343       'total_amount' => '125',
1344     ];
1345     $contribution = $this->callAPISuccess('Contribution', 'create', $newParams);
1346
1347     $lineItems = $this->callAPISuccess('line_item', 'getvalue', [
1348
1349       'entity_id' => $contribution['id'],
1350       'entity_table' => 'civicrm_contribution',
1351       'sequential' => 1,
1352       'return' => 'line_total',
1353     ]);
1354
1355     $this->assertEquals('125.00', $lineItems);
1356     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
1357
1358     // Financial trxn SUM = 125 + 5 (fee).
1359     $this->assertEquals('130.00', $trxnAmount);
1360     $this->assertEquals('125.00', $this->_getFinancialItemAmount($contribution['id']));
1361   }
1362
1363   /**
1364    * Function tests that line items, financial records are updated when pay later contribution is received.
1365    */
1366   public function testCreateUpdateContributionPayLater() {
1367     $contribParams = [
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,
1375
1376     ];
1377     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1378
1379     $newParams = array_merge($contribParams, [
1380       'id' => $contribution['id'],
1381       'contribution_status_id' => 1,
1382     ]);
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');
1388   }
1389
1390   /**
1391    * Function tests that financial records are updated when Payment Instrument is changed.
1392    */
1393   public function testCreateUpdateContributionPaymentInstrument() {
1394     $instrumentId = $this->_addPaymentInstrument();
1395     $contribParams = [
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,
1401
1402     ];
1403     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1404
1405     $newParams = array_merge($contribParams, [
1406       'id' => $contribution['id'],
1407       'payment_instrument_id' => $instrumentId,
1408     ]);
1409     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1410     $this->assertAPISuccess($contribution);
1411     $this->checkFinancialTrxnPaymentInstrumentChange($contribution['id'], 4, $instrumentId);
1412
1413     // cleanup - delete created payment instrument
1414     $this->_deletedAddedPaymentInstrument();
1415   }
1416
1417   /**
1418    * Function tests that financial records are updated when Payment Instrument is changed when amount is negative.
1419    */
1420   public function testCreateUpdateNegativeContributionPaymentInstrument() {
1421     $instrumentId = $this->_addPaymentInstrument();
1422     $contribParams = [
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,
1428
1429     ];
1430     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1431
1432     $newParams = array_merge($contribParams, [
1433       'id' => $contribution['id'],
1434       'payment_instrument_id' => $instrumentId,
1435     ]);
1436     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1437     $this->assertAPISuccess($contribution);
1438     $this->checkFinancialTrxnPaymentInstrumentChange($contribution['id'], 4, $instrumentId, -100);
1439
1440     // cleanup - delete created payment instrument
1441     $this->_deletedAddedPaymentInstrument();
1442   }
1443
1444   /**
1445    * Function tests that financial records are added when Contribution is Refunded.
1446    *
1447    * @throws \CRM_Core_Exception
1448    */
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',
1458     ];
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',
1465     ]);
1466
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',
1473     ]));
1474   }
1475
1476   /**
1477    * Refund a contribution for a financial type with a contra account.
1478    *
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.
1482    *
1483    * @throws \CRM_Core_Exception
1484    */
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',
1490     ]);
1491     $this->callAPISuccessGetSingle('Contribution', ['contribution_status_id' => 'Chargeback']);
1492
1493     $lineItems = $this->callAPISuccessGetSingle('LineItem', [
1494       'contribution_id' => $contribution['id'],
1495       'api.FinancialItem.getsingle' => ['amount' => ['<' => 0]],
1496     ]);
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,
1502     ]);
1503   }
1504
1505   /**
1506    * Refund a contribution for a financial type with a contra account.
1507    *
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.
1511    *
1512    * @throws \CRM_Core_Exception
1513    */
1514   public function testCreateUpdateChargebackContributionCustomAccount() {
1515     $financialAccount = $this->callAPISuccess('FinancialAccount', 'create', [
1516       'name' => 'Chargeback Account',
1517       'is_active' => TRUE,
1518     ]);
1519
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',
1525     ]);
1526
1527     $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params);
1528     $this->callAPISuccess('Contribution', 'create', [
1529       'id' => $contribution['id'],
1530       'contribution_status_id' => 'Chargeback',
1531     ]);
1532     $this->callAPISuccessGetSingle('Contribution', ['contribution_status_id' => 'Chargeback']);
1533
1534     $lineItems = $this->callAPISuccessGetSingle('LineItem', [
1535       'contribution_id' => $contribution['id'],
1536       'api.FinancialItem.getsingle' => ['amount' => ['<' => 0]],
1537     ]);
1538     $this->assertEquals($financialAccount['id'], $lineItems['api.FinancialItem.getsingle']['financial_account_id']);
1539
1540     $this->callAPISuccess('Contribution', 'delete', ['id' => $contribution['id']]);
1541     $this->callAPISuccess('EntityFinancialAccount', 'delete', ['id' => $entityFinancialAccount['id']]);
1542     $this->callAPISuccess('FinancialAccount', 'delete', ['id' => $financialAccount['id']]);
1543   }
1544
1545   /**
1546    * Refund a contribution for a financial type with a contra account.
1547    *
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.
1551    */
1552   public function testCreateUpdateRefundContributionConfiguredContraAccount() {
1553     $financialAccount = $this->callAPISuccess('FinancialAccount', 'create', [
1554       'name' => 'Refund Account',
1555       'is_active' => TRUE,
1556     ]);
1557
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',
1563     ]);
1564
1565     $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params);
1566     $this->callAPISuccess('Contribution', 'create', [
1567       'id' => $contribution['id'],
1568       'contribution_status_id' => 'Refunded',
1569     ]);
1570
1571     $lineItems = $this->callAPISuccessGetSingle('LineItem', [
1572       'contribution_id' => $contribution['id'],
1573       'api.FinancialItem.getsingle' => ['amount' => ['<' => 0]],
1574     ]);
1575     $this->assertEquals($financialAccount['id'], $lineItems['api.FinancialItem.getsingle']['financial_account_id']);
1576
1577     $this->callAPISuccess('Contribution', 'delete', ['id' => $contribution['id']]);
1578     $this->callAPISuccess('EntityFinancialAccount', 'delete', ['id' => $entityFinancialAccount['id']]);
1579     $this->callAPISuccess('FinancialAccount', 'delete', ['id' => $financialAccount['id']]);
1580   }
1581
1582   /**
1583    * Function tests that trxn_id is set when passed in.
1584    *
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.
1587    */
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',
1597     ];
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',
1604     ]);
1605
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',
1612     ]));
1613   }
1614
1615   /**
1616    * Function tests that trxn_id is set when passed in.
1617    *
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.
1621    */
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',
1631     ];
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',
1639     ]);
1640
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',
1647     ]));
1648   }
1649
1650   /**
1651    * Function tests that refund_trxn_id is set when passed in empty.
1652    *
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.
1656    */
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',
1666     ];
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' => '',
1674     ]);
1675
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',
1682     ]));
1683   }
1684
1685   /**
1686    * Function tests invalid contribution status change.
1687    */
1688   public function testCreateUpdateContributionInValidStatusChange() {
1689     $contribParams = [
1690       'contact_id' => 1,
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,
1696     ];
1697     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1698     $newParams = array_merge($contribParams, [
1699       'id' => $contribution['id'],
1700       'contribution_status_id' => 2,
1701     ]);
1702     $this->callAPIFailure('contribution', 'create', $newParams, ts('Cannot change contribution status from Completed to Pending.'));
1703
1704   }
1705
1706   /**
1707    * Function tests that financial records are added when Pending Contribution is Canceled.
1708    *
1709    * @throws \CRM_Core_Exception
1710    */
1711   public function testCreateUpdateContributionCancelPending() {
1712     $contribParams = [
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,
1720
1721     ];
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',
1727     ]);
1728     //Check if trxn_date is same as cancel_date.
1729     $checkTrxnDate = [
1730       'trxn_date' => '2012-02-02 09:00:00',
1731     ];
1732     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1733     $this->_checkFinancialTrxn($contribution, 'cancelPending', NULL, $checkTrxnDate);
1734     $this->_checkFinancialItem($contribution['id'], 'cancelPending');
1735   }
1736
1737   /**
1738    * Function tests that financial records are added when Financial Type is Changed.
1739    *
1740    * @throws \CRM_Core_Exception
1741    */
1742   public function testCreateUpdateContributionChangeFinancialType() {
1743     $contribParams = [
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,
1750
1751     ];
1752     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1753     $newParams = array_merge($contribParams, [
1754       'id' => $contribution['id'],
1755       'financial_type_id' => 3,
1756     ]);
1757     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1758     $this->_checkFinancialTrxn($contribution, 'changeFinancial');
1759     $this->_checkFinancialItem($contribution['id'], 'changeFinancial');
1760   }
1761
1762   /**
1763    * Function tets that financial records are correctly added when financial type is changed
1764    *
1765    * @throws \CRM_Core_Exception
1766    */
1767   public function testCreateUpdateContributionWithFeeAmountChangeFinancialType() {
1768     $contribParams = [
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,
1776
1777     ];
1778     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1779     $newParams = array_merge($contribParams, [
1780       'id' => $contribution['id'],
1781       'financial_type_id' => 3,
1782     ]);
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');
1786   }
1787
1788   /**
1789    * Test that update does not change status id CRM-15105.
1790    */
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,
1797     ]);
1798     $this->assertEquals(2, $contribution['contribution_status_id']);
1799   }
1800
1801   /**
1802    * Test Updating a Contribution.
1803    *
1804    * CHANGE: we require the API to do an incremental update
1805    */
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',
1812     ]);
1813     $old_params = [
1814       'contribution_id' => $contributionID,
1815     ];
1816     $original = $this->callAPISuccess('contribution', 'get', $old_params);
1817     $this->assertEquals($original['id'], $contributionID);
1818     //set up list of old params, verify
1819
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'];
1825
1826     $old_trxn_id = $original['values'][$contributionID]['trxn_id'];
1827     $old_invoice_id = $original['values'][$contributionID]['invoice_id'];
1828
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');
1835     $params = [
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',
1844     ];
1845
1846     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1847
1848     $new_params = [
1849       'contribution_id' => $contribution['id'],
1850     ];
1851     $contribution = $this->callAPISuccessGetSingle('contribution', $new_params);
1852
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');
1864
1865     $this->assertEquals($contribution['net_amount'], $contribution['total_amount'] - $contribution['fee_amount']);
1866
1867     $params = [
1868       'contribution_id' => $contributionID,
1869     ];
1870     $result = $this->callAPISuccess('contribution', 'delete', $params);
1871     $this->assertAPISuccess($result);
1872   }
1873
1874   /**
1875    * Check that net_amount is updated when a contribution is updated.
1876    *
1877    * Update fee amount AND total amount, just fee amount, just total amount
1878    * and neither to check that net_amount is keep updated.
1879    */
1880   public function testUpdateContributionNetAmountVariants() {
1881     $contributionID = $this->contributionCreate(['contact_id' => $this->individualCreate()]);
1882
1883     $this->callAPISuccess('Contribution', 'create', [
1884       'id' => $contributionID,
1885       'total_amount' => 90,
1886       'fee_amount' => 6,
1887     ]);
1888     $contribution = $this->callAPISuccessGetSingle('Contribution', [
1889       'id' => $contributionID,
1890       'return' => ['net_amount', 'fee_amount', 'total_amount'],
1891     ]);
1892     $this->assertEquals(6, $contribution['fee_amount']);
1893     $this->assertEquals(90, $contribution['total_amount']);
1894     $this->assertEquals(84, $contribution['net_amount']);
1895
1896     $this->callAPISuccess('Contribution', 'create', [
1897       'id' => $contributionID,
1898       'fee_amount' => 3,
1899     ]);
1900     $contribution = $this->callAPISuccessGetSingle('Contribution', [
1901       'id' => $contributionID,
1902       'return' => ['net_amount', 'fee_amount', 'total_amount'],
1903     ]);
1904     $this->assertEquals(3, $contribution['fee_amount']);
1905     $this->assertEquals(90, $contribution['total_amount']);
1906     $this->assertEquals(87, $contribution['net_amount']);
1907
1908     $this->callAPISuccess('Contribution', 'create', [
1909       'id' => $contributionID,
1910       'total_amount' => 200,
1911     ]);
1912     $contribution = $this->callAPISuccessGetSingle('Contribution', [
1913       'id' => $contributionID,
1914       'return' => ['net_amount', 'fee_amount', 'total_amount'],
1915     ]);
1916     $this->assertEquals(3, $contribution['fee_amount']);
1917     $this->assertEquals(200, $contribution['total_amount']);
1918     $this->assertEquals(197, $contribution['net_amount']);
1919
1920     $this->callAPISuccess('Contribution', 'create', [
1921       'id' => $contributionID,
1922       'payment_instrument' => 'Cash',
1923     ]);
1924     $contribution = $this->callAPISuccessGetSingle('Contribution', [
1925       'id' => $contributionID,
1926       'return' => ['net_amount', 'fee_amount', 'total_amount'],
1927     ]);
1928     $this->assertEquals(3, $contribution['fee_amount']);
1929     $this->assertEquals(200, $contribution['total_amount']);
1930     $this->assertEquals(197, $contribution['net_amount']);
1931   }
1932
1933   /**
1934    * Attempt (but fail) to delete a contribution without parameters.
1935    */
1936   public function testDeleteEmptyParamsContribution() {
1937     $params = [];
1938     $this->callAPIFailure('contribution', 'delete', $params);
1939   }
1940
1941   public function testDeleteWrongParamContribution() {
1942     $params = [
1943       'contribution_source' => 'SSF',
1944     ];
1945     $this->callAPIFailure('contribution', 'delete', $params);
1946   }
1947
1948   public function testDeleteContribution() {
1949     $contributionID = $this->contributionCreate([
1950       'contact_id' => $this->_individualId,
1951       'financial_type_id' => $this->_financialTypeId,
1952     ]);
1953     $params = [
1954       'id' => $contributionID,
1955     ];
1956     $this->callAPIAndDocument('contribution', 'delete', $params, __FUNCTION__, __FILE__);
1957   }
1958
1959   /**
1960    * Test civicrm_contribution_search with empty params.
1961    *
1962    * All available contributions expected.
1963    */
1964   public function testSearchEmptyParams() {
1965     $params = [];
1966
1967     $p = [
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,
1975       'trxn_id' => 23456,
1976       'invoice_id' => 78910,
1977       'source' => 'SSF',
1978       'contribution_status_id' => 1,
1979     ];
1980     $contribution = $this->callAPISuccess('contribution', 'create', $p);
1981
1982     $result = $this->callAPISuccess('contribution', 'get', $params);
1983     // We're taking the first element.
1984     $res = $result['values'][$contribution['id']];
1985
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']);
1997
1998     $this->contributionDelete($contribution['id']);
1999   }
2000
2001   /**
2002    * Test civicrm_contribution_search. Success expected.
2003    */
2004   public function testSearch() {
2005     $p1 = [
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,
2012     ];
2013     $contribution1 = $this->callAPISuccess('contribution', 'create', $p1);
2014
2015     $p2 = [
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,
2026     ];
2027     $contribution2 = $this->callAPISuccess('contribution', 'create', $p2);
2028
2029     $params = [
2030       'contribution_id' => $contribution2['id'],
2031     ];
2032     $result = $this->callAPISuccess('contribution', 'get', $params);
2033     $res = $result['values'][$contribution2['id']];
2034
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']);
2044
2045     $this->contributionDelete($contribution1['id']);
2046     $this->contributionDelete($contribution2['id']);
2047   }
2048
2049   /**
2050    * Test completing a transaction via the API.
2051    *
2052    * Note that we are creating a logged in user because email goes out from
2053    * that person
2054    */
2055   public function testCompleteTransaction(): void {
2056     $mut = new CiviMailUtils($this, TRUE);
2057     Civi::settings()->set('tax_term', 'GST');
2058     $this->swapMessageTemplateForTestTemplate();
2059     $this->createLoggedInUser();
2060     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2061     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2062     $this->callAPISuccess('contribution', 'completetransaction', [
2063       'id' => $contribution['id'],
2064     ]);
2065     $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id']]);
2066     $this->assertEquals('SSF', $contribution['contribution_source']);
2067     $this->assertEquals('Completed', $contribution['contribution_status']);
2068     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receipt_date'])));
2069     $mut->checkMailLog([
2070       'email:::anthony_anderson@civicrm.org',
2071       'is_monetary:::1',
2072       'amount:::100.00',
2073       'currency:::USD',
2074       'receive_date:::' . date('Ymd', strtotime($contribution['receive_date'])),
2075       "receipt_date:::\n",
2076       'title:::Contribution',
2077       'contributionStatus:::Completed',
2078       'taxTerm:::GST',
2079     ]);
2080     $mut->stop();
2081     $this->revertTemplateToReservedTemplate();
2082   }
2083
2084   /**
2085    * Test completing a transaction via the API with a non-USD transaction.
2086    */
2087   public function testCompleteTransactionEuro(): void {
2088     $mut = new CiviMailUtils($this, TRUE);
2089     $this->swapMessageTemplateForTestTemplate();
2090     $this->createLoggedInUser();
2091     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'currency' => 'EUR']);
2092     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2093
2094     $this->callAPISuccess('contribution', 'completetransaction', [
2095       'id' => $contribution['id'],
2096     ]);
2097
2098     $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id']]);
2099     $this->assertEquals('SSF', $contribution['contribution_source']);
2100     $this->assertEquals('Completed', $contribution['contribution_status']);
2101     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receipt_date'])));
2102
2103     $entityFinancialTransactions = $this->getFinancialTransactionsForContribution($contribution['id']);
2104     $entityFinancialTransaction = reset($entityFinancialTransactions);
2105     $financialTrxn = $this->callAPISuccessGetSingle('FinancialTrxn', ['id' => $entityFinancialTransaction['financial_trxn_id']]);
2106     $this->assertEquals('EUR', $financialTrxn['currency']);
2107
2108     $mut->checkMailLog([
2109       'email:::anthony_anderson@civicrm.org',
2110       'is_monetary:::1',
2111       'amount:::100.00',
2112       'currency:::EUR',
2113       'receive_date:::' . date('Ymd', strtotime($contribution['receive_date'])),
2114       "receipt_date:::\n",
2115       'title:::Contribution',
2116       'contributionStatus:::Completed',
2117     ]);
2118     $mut->stop();
2119     $this->revertTemplateToReservedTemplate();
2120   }
2121
2122   /**
2123    * Test to ensure mail is sent for pay later
2124    *
2125    * @throws \CRM_Core_Exception
2126    * @throws \API_Exception
2127    */
2128   public function testPayLater(): void {
2129     $mut = new CiviMailUtils($this, TRUE);
2130     $this->swapMessageTemplateForTestTemplate();
2131     $this->createLoggedInUser();
2132     $contributionPageID = $this->createQuickConfigContributionPage();
2133
2134     $params = [
2135       'id' => $contributionPageID,
2136       'price_' . $this->ids['PriceField']['basic'] => $this->ids['PriceFieldValue']['basic'],
2137       'contact_id' => $this->_individualId,
2138       'email-5' => 'anthony_anderson@civicrm.org',
2139       'payment_processor_id' => 0,
2140       'currencyID' => 'USD',
2141       'is_pay_later' => 1,
2142       'invoiceID' => 'f28e1ddc86f8c4a0ff5bcf46393e4bc8',
2143       'description' => 'Online Contribution: Help Support CiviCRM!',
2144     ];
2145     $this->callAPISuccess('ContributionPage', 'submit', $params);
2146
2147     $mut->checkMailLog([
2148       'is_pay_later:::1',
2149       'email:::anthony_anderson@civicrm.org',
2150       'pay_later_receipt:::This is a pay later receipt',
2151       'contributionPageId:::' . $contributionPageID,
2152       'title:::Test Contribution Page',
2153       'amount:::100',
2154     ]);
2155     $mut->stop();
2156     $this->revertTemplateToReservedTemplate();
2157   }
2158
2159   /**
2160    * Test to check whether contact billing address is used when no contribution address
2161    */
2162   public function testBillingAddress() {
2163     $mut = new CiviMailUtils($this, TRUE);
2164     $this->swapMessageTemplateForTestTemplate();
2165     $this->createLoggedInUser();
2166
2167     //Scenario 1: When Contact don't have any address
2168     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2169     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2170     $this->callAPISuccess('contribution', 'completetransaction', [
2171       'id' => $contribution['id'],
2172     ]);
2173     $mut->checkMailLog([
2174       'address:::',
2175     ]);
2176
2177     // Scenario 2: Contribution using address
2178     $address = $this->callAPISuccess('address', 'create', [
2179       'street_address' => 'contribution billing st',
2180       'location_type_id' => 2,
2181       'contact_id' => $this->_params['contact_id'],
2182     ]);
2183     $params = array_merge($this->_params, [
2184       'contribution_status_id' => 2,
2185       'address_id' => $address['id'],
2186     ]
2187     );
2188     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2189     $this->callAPISuccess('contribution', 'completetransaction', [
2190       'id' => $contribution['id'],
2191     ]);
2192     $mut->checkMailLog([
2193       'address:::contribution billing st',
2194     ]);
2195
2196     // Scenario 3: Contribution wtth no address but contact has a billing address
2197     $this->callAPISuccess('address', 'create', [
2198       'id' => $address['id'],
2199       'street_address' => 'is billing st',
2200       'contact_id' => $this->_params['contact_id'],
2201     ]);
2202     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2203     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2204     $this->callAPISuccess('contribution', 'completetransaction', [
2205       'id' => $contribution['id'],
2206     ]);
2207     $mut->checkMailLog([
2208       'address:::is billing st',
2209     ]);
2210
2211     $mut->stop();
2212     $this->revertTemplateToReservedTemplate();
2213   }
2214
2215   /**
2216    * Test completing a transaction via the API.
2217    *
2218    * Note that we are creating a logged in user because email goes out from
2219    * that person
2220    */
2221   public function testCompleteTransactionFeeAmount() {
2222     $this->createLoggedInUser();
2223     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2224     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2225     $this->callAPISuccess('contribution', 'completetransaction', [
2226       'id' => $contribution['id'],
2227       'fee_amount' => '.56',
2228       'trxn_id' => '7778888',
2229     ]);
2230     $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id'], 'sequential' => 1]);
2231     $this->assertEquals('Completed', $contribution['contribution_status']);
2232     $this->assertEquals('7778888', $contribution['trxn_id']);
2233     $this->assertEquals('0.56', $contribution['fee_amount']);
2234     $this->assertEquals('99.44', $contribution['net_amount']);
2235   }
2236
2237   /**
2238    * CRM-19126 Add test to verify when complete transaction is called tax
2239    * amount is not changed.
2240    *
2241    * We start of with a pending contribution.
2242    *  - total_amount (input) = 100
2243    *  - total_amount post save (based on tax being added) = 105
2244    *  - net_amount = 95
2245    *  - fee_amount = 5
2246    *  - non_deductible_amount = 10
2247    *  - tax rate = 5%
2248    *  - tax_amount = 5
2249    *  - sum of (calculated) line items = 105
2250    *
2251    * Note the fee_amount should really be set when the payment is received
2252    * and whatever the non_deductible amount is, it is ignored.
2253    *
2254    * The fee amount when the payment comes in is 6 rather than 5. The net_amount
2255    * and fee_amount should change, but not the total_amount or
2256    * the line items.
2257    *
2258    * @param string $thousandSeparator
2259    *   punctuation used to refer to thousands.
2260    *
2261    * @throws \API_Exception
2262    * @throws \CRM_Core_Exception
2263    * @dataProvider getThousandSeparators
2264    */
2265   public function testCheckTaxAmount(string $thousandSeparator): void {
2266     $this->setCurrencySeparators($thousandSeparator);
2267     $this->createFinancialTypeWithSalesTax();
2268     $financialTypeId = $this->ids['FinancialType']['taxable'];
2269
2270     $contributionID = $this->callAPISuccess('Order', 'create',
2271       array_merge($this->_params, ['financial_type_id' => $financialTypeId])
2272     )['id'];
2273     $contributionPrePayment = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID, 'return' => ['tax_amount', 'total_amount']]);
2274     $this->validateAllContributions();
2275     $this->callAPISuccess('Contribution', 'completetransaction', [
2276       'id' => $contributionID,
2277       'trxn_id' => '777788888',
2278       'fee_amount' => '6.00',
2279       'sequential' => 1,
2280     ]);
2281     $contributionPostPayment = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID, 'return' => ['tax_amount', 'fee_amount', 'net_amount']]);
2282     $this->assertEquals(4.76, $contributionPrePayment['tax_amount']);
2283     $this->assertEquals(4.76, $contributionPostPayment['tax_amount']);
2284     $this->assertEquals('6.00', $contributionPostPayment['fee_amount']);
2285     $this->assertEquals('94.00', $contributionPostPayment['net_amount']);
2286     $this->validateAllContributions();
2287     $this->validateAllPayments();
2288   }
2289
2290   /**
2291    * Test repeat contribution successfully creates line item.
2292    *
2293    * @throws \CRM_Core_Exception
2294    */
2295   public function testRepeatTransaction(): void {
2296     $originalContribution = $this->setUpRepeatTransaction([], 'single');
2297     $this->callAPISuccess('contribution', 'repeattransaction', [
2298       'original_contribution_id' => $originalContribution['id'],
2299       'contribution_status_id' => 'Completed',
2300       'trxn_id' => 4567,
2301     ]);
2302     $lineItemParams = [
2303       'entity_id' => $originalContribution['id'],
2304       'sequential' => 1,
2305       'return' => [
2306         'entity_table',
2307         'qty',
2308         'unit_price',
2309         'line_total',
2310         'label',
2311         'financial_type_id',
2312         'deductible_amount',
2313         'price_field_value_id',
2314         'price_field_id',
2315       ],
2316     ];
2317     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2318       'entity_id' => $originalContribution['id'],
2319     ]));
2320     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2321       'entity_id' => $originalContribution['id'] + 1,
2322     ]));
2323     unset($lineItem1['values'][0]['id'], $lineItem1['values'][0]['entity_id']);
2324     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2325     $this->assertEquals($lineItem1['values'][0], $lineItem2['values'][0]);
2326     $this->_checkFinancialRecords([
2327       'id' => $originalContribution['id'] + 1,
2328       'payment_instrument_id' => $this->callAPISuccessGetValue('PaymentProcessor', [
2329         'id' => $originalContribution['payment_processor_id'],
2330         'return' => 'payment_instrument_id',
2331       ]),
2332     ], 'online');
2333   }
2334
2335   /**
2336    * Test custom data is copied over from the template transaction.
2337    *
2338    * (Over time various discussions have deemed this to be the most recent one, allowing
2339    * users to alter custom data going forwards. This is implemented for line items already.
2340    *
2341    * @throws \API_Exception
2342    * @throws \CRM_Core_Exception
2343    */
2344   public function testRepeatTransactionWithCustomData(): void {
2345     $this->createCustomGroupWithFieldOfType(['extends' => 'Contribution', 'name' => 'Repeat'], 'text');
2346     $originalContribution = $this->setUpRepeatTransaction([], 'single', [$this->getCustomFieldName('text') => 'first']);
2347     $this->callAPISuccess('contribution', 'repeattransaction', [
2348       'contribution_recur_id' => $originalContribution['contribution_recur_id'],
2349       'contribution_status_id' => 'Completed',
2350       'trxn_id' => 'my_trxn',
2351     ]);
2352
2353     $contribution = Contribution::get()
2354       ->addWhere('trxn_id', '=', 'my_trxn')
2355       ->addSelect('Custom_Group.Enter_text_here')
2356       ->addSelect('id')
2357       ->execute()->first();
2358     $this->assertEquals('first', $contribution['Custom_Group.Enter_text_here']);
2359
2360     Contribution::update()->setValues(['Custom_Group.Enter_text_here' => 'second'])->addWhere('id', '=', $contribution['id'])->execute();
2361
2362     $this->callAPISuccess('contribution', 'repeattransaction', [
2363       'original_contribution_id' => $originalContribution['id'],
2364       'contribution_status_id' => 'Completed',
2365       'trxn_id' => 'number_3',
2366     ]);
2367
2368     $contribution = Contribution::get()
2369       ->addWhere('trxn_id', '=', 'number_3')
2370       ->setSelect(['id', 'Custom_Group.Enter_text_here'])
2371       ->execute()->first();
2372     $this->assertEquals('second', $contribution['Custom_Group.Enter_text_here']);
2373   }
2374
2375   /**
2376    * Test repeat contribution successfully creates line items (plural).
2377    *
2378    * @throws \CRM_Core_Exception
2379    */
2380   public function testRepeatTransactionLineItems(): void {
2381     // CRM-19309
2382     $originalContribution = $this->setUpRepeatTransaction([], 'multiple');
2383     $this->callAPISuccess('contribution', 'repeattransaction', [
2384       'original_contribution_id' => $originalContribution['id'],
2385       'contribution_status_id' => 'Completed',
2386       'trxn_id' => 1234,
2387     ]);
2388
2389     $lineItemParams = [
2390       'entity_id' => $originalContribution['id'],
2391       'sequential' => 1,
2392       'return' => [
2393         'entity_table',
2394         'qty',
2395         'unit_price',
2396         'line_total',
2397         'label',
2398         'financial_type_id',
2399         'deductible_amount',
2400         'price_field_value_id',
2401         'price_field_id',
2402       ],
2403     ];
2404     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2405       'entity_id' => $originalContribution['id'],
2406       'options' => ['sort' => 'qty'],
2407     ]))['values'];
2408     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2409       'entity_id' => $originalContribution['id'] + 1,
2410       'options' => ['sort' => 'qty'],
2411     ]))['values'];
2412
2413     // unset id and entity_id for all of them to be able to compare the lineItems:
2414     unset($lineItem1[0]['id'], $lineItem1[0]['entity_id']);
2415     unset($lineItem2[0]['id'], $lineItem2[0]['entity_id']);
2416     $this->assertEquals($lineItem1[0], $lineItem2[0]);
2417
2418     unset($lineItem1[1]['id'], $lineItem1[1]['entity_id']);
2419     unset($lineItem2[1]['id'], $lineItem2[1]['entity_id']);
2420     $this->assertEquals($lineItem1[1], $lineItem2[1]);
2421
2422     // CRM-19309 so in future we also want to:
2423     // check that financial_line_items have been created for entity_id 3 and 4;
2424
2425     $this->callAPISuccessGetCount('FinancialItem', ['description' => 'Sales Tax', 'amount' => 0], 0);
2426   }
2427
2428   /**
2429    * Test repeat contribution successfully creates is_test transaction.
2430    *
2431    * @throws \CRM_Core_Exception
2432    */
2433   public function testRepeatTransactionIsTest(): void {
2434     $this->_params['is_test'] = 1;
2435     $originalContribution = $this->setUpRepeatTransaction(['is_test' => 1], 'single');
2436
2437     $this->callAPISuccess('contribution', 'repeattransaction', [
2438       'original_contribution_id' => $originalContribution['id'],
2439       'contribution_status_id' => 'Completed',
2440       'trxn_id' => '1234',
2441     ]);
2442     $this->callAPISuccessGetCount('Contribution', ['contribution_test' => 1], 2);
2443   }
2444
2445   /**
2446    * Test repeat contribution passed in status.
2447    *
2448    * @throws \CRM_Core_Exception
2449    */
2450   public function testRepeatTransactionPassedInStatus(): void {
2451     $originalContribution = $this->setUpRepeatTransaction([], 'single');
2452
2453     $this->callAPISuccess('contribution', 'repeattransaction', [
2454       'original_contribution_id' => $originalContribution['id'],
2455       'contribution_status_id' => 'Pending',
2456       'trxn_id' => 1234,
2457     ]);
2458     $this->callAPISuccessGetCount('Contribution', ['contribution_status_id' => 2], 1);
2459   }
2460
2461   /**
2462    * Test repeat contribution accepts recur_id instead of
2463    * original_contribution_id.
2464    *
2465    * @throws \CRM_Core_Exception
2466    */
2467   public function testRepeatTransactionAcceptRecurID(): void {
2468     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2469       'contact_id' => $this->_individualId,
2470       'installments' => '12',
2471       'frequency_interval' => '1',
2472       'amount' => '100',
2473       'contribution_status_id' => 1,
2474       'start_date' => '2012-01-01 00:00:00',
2475       'currency' => 'USD',
2476       'frequency_unit' => 'month',
2477       'payment_processor_id' => $this->paymentProcessorID,
2478     ]);
2479     $this->callAPISuccess('contribution', 'create', array_merge(
2480         $this->_params,
2481         ['contribution_recur_id' => $contributionRecur['id']])
2482     );
2483
2484     $this->callAPISuccess('contribution', 'repeattransaction', [
2485       'contribution_recur_id' => $contributionRecur['id'],
2486       'contribution_status_id' => 'Completed',
2487       'trxn_id' => 1234,
2488     ]);
2489
2490   }
2491
2492   /**
2493    * CRM-19873 Test repeattransaction if contribution_recur_id is a test.
2494    *
2495    * @throws \CRM_Core_Exception
2496    */
2497   public function testRepeatTransactionTestRecurId() {
2498     $contributionRecur = $this->callAPISuccess('ContributionRecur', 'create', [
2499       'contact_id' => $this->_individualId,
2500       'frequency_interval' => '1',
2501       'amount' => '1.00',
2502       'contribution_status_id' => 1,
2503       'start_date' => '2017-01-01 00:00:00',
2504       'currency' => 'USD',
2505       'frequency_unit' => 'month',
2506       'payment_processor_id' => $this->paymentProcessorID,
2507       'is_test' => 1,
2508     ]);
2509     $this->callAPISuccess('contribution', 'create', array_merge(
2510         $this->_params,
2511         [
2512           'contribution_recur_id' => $contributionRecur['id'],
2513           'is_test' => 1,
2514         ])
2515     );
2516
2517     $repeatedContribution = $this->callAPISuccess('contribution', 'repeattransaction', [
2518       'contribution_recur_id' => $contributionRecur['id'],
2519       'contribution_status_id' => 'Completed',
2520       'trxn_id' => 'magic_number',
2521     ]);
2522
2523     $this->assertEquals($contributionRecur['values'][1]['is_test'], $repeatedContribution['values'][2]['is_test']);
2524   }
2525
2526   /**
2527    * CRM-19945 Tests that Contribute.repeattransaction renews a membership when contribution status=Completed
2528    *
2529    * @throws \CRM_Core_Exception
2530    */
2531   public function testRepeatTransactionMembershipRenewCompletedContribution(): void {
2532     [$originalContribution, $membership] = $this->setUpAutoRenewMembership();
2533
2534     $this->callAPISuccess('Contribution', 'repeattransaction', [
2535       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2536       'contribution_status_id' => 'Failed',
2537     ]);
2538
2539     $this->callAPISuccess('membership', 'create', [
2540       'id' => $membership['id'],
2541       'end_date' => 'yesterday',
2542       'status_id' => 'Expired',
2543     ]);
2544
2545     $contribution = $this->callAPISuccess('Contribution', 'repeattransaction', [
2546       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2547       'contribution_status_id' => 'Completed',
2548       'trxn_id' => 'bobsled',
2549     ]);
2550
2551     $membershipStatusId = $this->callAPISuccess('membership', 'getvalue', [
2552       'id' => $membership['id'],
2553       'return' => 'status_id',
2554     ]);
2555
2556     $membership = $this->callAPISuccess('membership', 'get', [
2557       'id' => $membership['id'],
2558     ]);
2559
2560     $this->assertEquals('New', CRM_Core_PseudoConstant::getName('CRM_Member_BAO_Membership', 'status_id', $membershipStatusId));
2561
2562     $lineItem = $this->callAPISuccessGetSingle('LineItem', ['contribution_id' => $contribution['id']]);
2563     $this->assertEquals('civicrm_membership', $lineItem['entity_table']);
2564     $this->callAPISuccessGetCount('MembershipPayment', ['membership_id' => $membership['id']]);
2565   }
2566
2567   /**
2568    * This is one of those tests that locks in existing behaviour.
2569    *
2570    * I feel like correct behaviour is arguable & has been discussed in the past. However, if the membership has
2571    * a date which says it should be expired then the result of repeattransaction is to push that date
2572    * to be one membership term from 'now' with status 'new'.
2573    */
2574   public function testRepeattransactionRenewMembershipOldMembership() {
2575     $entities = $this->setUpAutoRenewMembership();
2576     $newStatusID = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'New');
2577     $membership = $this->callAPISuccess('Membership', 'create', [
2578       'id' => $entities[1]['id'],
2579       'join_date' => '4 months ago',
2580       'start_date' => '3 months ago',
2581       'end_date' => '2 months ago',
2582     ]);
2583     $membership = $membership['values'][$membership['id']];
2584
2585     // This status does not appear to be calculated at all and is set to 'new'. Feels like a bug.
2586     $this->assertEquals($newStatusID, $membership['status_id']);
2587
2588     // So it seems renewing this expired membership results in it's new status being current and it being pushed to a future date
2589     $this->callAPISuccess('Contribution', 'repeattransaction', ['original_contribution_id' => $entities[0]['id'], 'contribution_status_id' => 'Completed']);
2590     $membership = $this->callAPISuccessGetSingle('Membership', ['id' => $membership['id']]);
2591     // If this date calculation winds up being flakey the spirit of the test would be maintained by just checking
2592     // date is greater than today.
2593     $this->assertEquals(date('Y-m-d', strtotime('+ 1 month -1 day')), $membership['end_date']);
2594     $this->assertEquals($newStatusID, $membership['membership_type_id']);
2595   }
2596
2597   /**
2598    * CRM-19945 Tests that Contribute.repeattransaction DOES NOT renew a membership when contribution status=Failed
2599    *
2600    * @dataProvider contributionStatusProvider
2601    *
2602    * @throws \CRM_Core_Exception
2603    */
2604   public function testRepeatTransactionMembershipRenewContributionNotCompleted($contributionStatus): void {
2605     // Completed status should renew so we don't test that here
2606     // In Progress status was never actually intended to be available for contributions.
2607     // Partially paid is not valid.
2608     if (in_array($contributionStatus['name'], ['Completed', 'In Progress', 'Partially paid'])) {
2609       return;
2610     }
2611     [$originalContribution, $membership] = $this->setUpAutoRenewMembership();
2612
2613     $this->callAPISuccess('Contribution', 'repeattransaction', [
2614       'original_contribution_id' => $originalContribution['id'],
2615       'contribution_status_id' => 'Completed',
2616     ]);
2617
2618     $this->callAPISuccess('membership', 'create', [
2619       'id' => $membership['id'],
2620       'end_date' => 'yesterday',
2621       'status_id' => 'Expired',
2622     ]);
2623
2624     $contribution = $this->callAPISuccess('contribution', 'repeattransaction', [
2625       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2626       'contribution_status_id' => $contributionStatus['name'],
2627       'trxn_id' => 'bobsled',
2628     ]);
2629
2630     $updatedMembership = $this->callAPISuccess('membership', 'getsingle', ['id' => $membership['id']]);
2631
2632     $dateTime = new DateTime('yesterday');
2633     $this->assertEquals($dateTime->format('Y-m-d'), $updatedMembership['end_date']);
2634     $this->assertEquals(CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Expired'), $updatedMembership['status_id']);
2635
2636     $lineItem = $this->callAPISuccessGetSingle('LineItem', ['contribution_id' => $contribution['id']]);
2637     $this->assertEquals('civicrm_membership', $lineItem['entity_table']);
2638     $this->callAPISuccessGetCount('MembershipPayment', ['membership_id' => $membership['id']]);
2639   }
2640
2641   /**
2642    * Dataprovider provides contribution status as [optionvalue=>contribution_status_name]
2643    * FIXME: buildOptions seems to die in CRM_Core_Config::_construct when in test mode.
2644    *
2645    * @return array
2646    * @throws \CiviCRM_API3_Exception
2647    */
2648   public function contributionStatusProvider() {
2649     $contributionStatuses = civicrm_api3('OptionValue', 'get', [
2650       'return' => ['id', 'name'],
2651       'option_group_id' => 'contribution_status',
2652     ]);
2653     foreach ($contributionStatuses['values'] as $statusName) {
2654       $statuses[] = [$statusName];
2655     }
2656     return $statuses;
2657   }
2658
2659   /**
2660    * CRM-16397 test appropriate action if total amount has changed for single
2661    * line items.
2662    *
2663    * @throws \CRM_Core_Exception
2664    */
2665   public function testRepeatTransactionAlteredAmount(): void {
2666     $paymentProcessorID = $this->paymentProcessorCreate();
2667     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2668       'contact_id' => $this->_individualId,
2669       'installments' => '12',
2670       'frequency_interval' => '1',
2671       'amount' => '500',
2672       'contribution_status_id' => 1,
2673       'start_date' => '2012-01-01 00:00:00',
2674       'currency' => 'USD',
2675       'frequency_unit' => 'month',
2676       'payment_processor_id' => $paymentProcessorID,
2677     ]);
2678     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2679         $this->_params,
2680         [
2681           'contribution_recur_id' => $contributionRecur['id'],
2682         ])
2683     );
2684
2685     $this->callAPISuccess('contribution', 'repeattransaction', [
2686       'original_contribution_id' => $originalContribution['id'],
2687       'contribution_status_id' => 'Completed',
2688       'trxn_id' => 1234,
2689       'total_amount' => '400',
2690       'fee_amount' => 50,
2691     ]);
2692
2693     $lineItemParams = [
2694       'entity_id' => $originalContribution['id'],
2695       'sequential' => 1,
2696       'return' => [
2697         'entity_table',
2698         'qty',
2699         'unit_price',
2700         'line_total',
2701         'label',
2702         'financial_type_id',
2703         'deductible_amount',
2704         'price_field_value_id',
2705         'price_field_id',
2706       ],
2707     ];
2708     $this->callAPISuccessGetSingle('contribution', [
2709       'total_amount' => 400,
2710       'fee_amount' => 50,
2711       'net_amount' => 350,
2712     ]);
2713     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2714       'entity_id' => $originalContribution['id'],
2715     ]));
2716     $expectedLineItem = array_merge(
2717       $lineItem1['values'][0], [
2718         'line_total' => '400.00',
2719         'unit_price' => '400.00',
2720       ]
2721     );
2722
2723     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2724       'entity_id' => $originalContribution['id'] + 1,
2725     ]));
2726
2727     unset($expectedLineItem['id'], $expectedLineItem['entity_id'], $lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2728     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2729   }
2730
2731   /**
2732    * Test financial_type_id override behaviour with a single line item.
2733    *
2734    * CRM-17718 a passed in financial_type_id is allowed to override the
2735    * original contribution where there is only one line item.
2736    *
2737    * @throws \CRM_Core_Exception
2738    */
2739   public function testRepeatTransactionPassedInFinancialType() {
2740     $originalContribution = $this->setUpRecurringContribution();
2741
2742     $this->callAPISuccess('Contribution', 'repeattransaction', [
2743       'original_contribution_id' => $originalContribution['id'],
2744       'contribution_status_id' => 'Completed',
2745       'trxn_id' => 12345,
2746       'financial_type_id' => 2,
2747     ]);
2748     $lineItemParams = [
2749       'entity_id' => $originalContribution['id'],
2750       'sequential' => 1,
2751       'return' => [
2752         'entity_table',
2753         'qty',
2754         'unit_price',
2755         'line_total',
2756         'label',
2757         'financial_type_id',
2758         'deductible_amount',
2759         'price_field_value_id',
2760         'price_field_id',
2761       ],
2762     ];
2763
2764     $this->callAPISuccessGetSingle('Contribution', [
2765       'total_amount' => 100,
2766       'financial_type_id' => 2,
2767     ]);
2768     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2769       'entity_id' => $originalContribution['id'],
2770     ]));
2771     $expectedLineItem = array_merge(
2772       $lineItem1['values'][0], [
2773         'line_total' => '100.00',
2774         'unit_price' => '100.00',
2775         'financial_type_id' => 2,
2776         'contribution_type_id' => 2,
2777       ]
2778     );
2779     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2780       'entity_id' => $originalContribution['id'] + 1,
2781     ]));
2782     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
2783     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2784     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2785   }
2786
2787   /**
2788    * Test Contribution with Order api.
2789    *
2790    * @throws \CRM_Core_Exception|\CiviCRM_API3_Exception
2791    */
2792   public function testContributionOrder() {
2793     $this->createContributionAndMembershipOrder();
2794     $contribution = $this->callAPISuccess('contribution', 'get')['values'][$this->ids['Contribution'][0]];
2795     $this->assertEquals('Pending Label**', $contribution['contribution_status']);
2796     $membership = $this->callAPISuccessGetSingle('Membership', ['contact_id' => $this->ids['Contact']['order']]);
2797
2798     $this->callAPISuccess('Payment', 'create', [
2799       'contribution_id' => $this->ids['Contribution'][0],
2800       'payment_instrument_id' => 'Check',
2801       'total_amount' => 300,
2802     ]);
2803     $contribution = $this->callAPISuccess('contribution', 'get')['values'][$this->ids['Contribution'][0]];
2804     $this->assertEquals('Completed', $contribution['contribution_status']);
2805
2806     $lineItem = $this->callAPISuccess('LineItem', 'get', [
2807       'sequential' => 1,
2808       'contribution_id' => $this->ids['Contribution'][0],
2809     ])['values'];
2810     $this->assertCount(2, $lineItem);
2811     $this->assertEquals($this->ids['Contribution'][0], $lineItem[0]['entity_id']);
2812     $this->assertEquals('civicrm_contribution', $lineItem[0]['entity_table']);
2813     $this->assertEquals($this->ids['Contribution'][0], $lineItem[0]['contribution_id']);
2814     $this->assertEquals($this->ids['Contribution'][0], $lineItem[1]['contribution_id']);
2815     $this->assertEquals('100.00', $lineItem[0]['line_total']);
2816     $this->assertEquals('200.00', $lineItem[1]['line_total']);
2817     $this->assertEquals($membership['id'], $lineItem[1]['entity_id']);
2818     $this->assertEquals('civicrm_membership', $lineItem[1]['entity_table']);
2819   }
2820
2821   /**
2822    * Test financial_type_id override behaviour with a single line item.
2823    *
2824    * CRM-17718 a passed in financial_type_id is not allowed to override the
2825    * original contribution where there is more than one line item.
2826    *
2827    * @throws \CRM_Core_Exception
2828    */
2829   public function testRepeatTransactionPassedInFinancialTypeTwoLineItems(): void {
2830     $this->_params = $this->getParticipantOrderParams();
2831     $originalContribution = $this->setUpRecurringContribution();
2832
2833     $this->callAPISuccess('Contribution', 'repeattransaction', [
2834       'original_contribution_id' => $originalContribution['id'],
2835       'contribution_status_id' => 'Completed',
2836       'trxn_id' => 'repeat',
2837       'financial_type_id' => 2,
2838     ]);
2839
2840     // Retrieve the new contribution and note the financial type passed in has been ignored.
2841     $contribution = $this->callAPISuccessGetSingle('Contribution', [
2842       'trxn_id' => 'repeat',
2843     ]);
2844     $this->assertEquals(4, $contribution['financial_type_id']);
2845
2846     $lineItems = $this->callAPISuccess('line_item', 'get', [
2847       'entity_id' => $contribution['id'],
2848     ])['values'];
2849     foreach ($lineItems as $lineItem) {
2850       $this->assertNotEquals(2, $lineItem['financial_type_id']);
2851     }
2852   }
2853
2854   /**
2855    * CRM-17718 test appropriate action if financial type has changed for single
2856    * line items.
2857    *
2858    * @throws \CRM_Core_Exception
2859    */
2860   public function testRepeatTransactionUpdatedFinancialType(): void {
2861     $originalContribution = $this->setUpRecurringContribution([], ['financial_type_id' => 2]);
2862
2863     $this->callAPISuccess('contribution', 'repeattransaction', [
2864       'contribution_recur_id' => $originalContribution['id'],
2865       'contribution_status_id' => 'Completed',
2866       'trxn_id' => 234,
2867     ]);
2868     $lineItemParams = [
2869       'entity_id' => $originalContribution['id'],
2870       'sequential' => 1,
2871       'return' => [
2872         'entity_table',
2873         'qty',
2874         'unit_price',
2875         'line_total',
2876         'label',
2877         'financial_type_id',
2878         'deductible_amount',
2879         'price_field_value_id',
2880         'price_field_id',
2881       ],
2882     ];
2883
2884     $this->callAPISuccessGetSingle('contribution', [
2885       'total_amount' => 100,
2886       'financial_type_id' => 2,
2887     ]);
2888     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2889       'entity_id' => $originalContribution['id'],
2890     ]))['values'][0];
2891     $expectedLineItem = array_merge(
2892       $lineItem1, [
2893         'line_total' => '100.00',
2894         'unit_price' => '100.00',
2895         'financial_type_id' => 2,
2896         'contribution_type_id' => 2,
2897       ]
2898     );
2899
2900     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2901       'entity_id' => $originalContribution['id'] + 1,
2902     ]));
2903     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
2904     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2905     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2906   }
2907
2908   /**
2909    * CRM-16397 test appropriate action if campaign has been passed in.
2910    */
2911   public function testRepeatTransactionPassedInCampaign() {
2912     $paymentProcessorID = $this->paymentProcessorCreate();
2913     $campaignID = $this->campaignCreate();
2914     $campaignID2 = $this->campaignCreate();
2915     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2916       'contact_id' => $this->_individualId,
2917       'installments' => '12',
2918       'frequency_interval' => '1',
2919       'amount' => '100',
2920       'contribution_status_id' => 1,
2921       'start_date' => '2012-01-01 00:00:00',
2922       'currency' => 'USD',
2923       'frequency_unit' => 'month',
2924       'payment_processor_id' => $paymentProcessorID,
2925     ]);
2926     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2927       $this->_params,
2928       [
2929         'contribution_recur_id' => $contributionRecur['id'],
2930         'campaign_id' => $campaignID,
2931       ])
2932     );
2933
2934     $this->callAPISuccess('contribution', 'repeattransaction', [
2935       'original_contribution_id' => $originalContribution['id'],
2936       'contribution_status_id' => 'Completed',
2937       'trxn_id' => 2345,
2938       'campaign_id' => $campaignID2,
2939     ]);
2940
2941     $this->callAPISuccessGetSingle('contribution', [
2942       'total_amount' => 100,
2943       'campaign_id' => $campaignID2,
2944     ]);
2945   }
2946
2947   /**
2948    * CRM-17718 campaign stored on contribution recur gets priority.
2949    *
2950    * This reflects the fact we permit people to update them.
2951    *
2952    * @throws \CRM_Core_Exception
2953    */
2954   public function testRepeatTransactionUpdatedCampaign(): void {
2955     $paymentProcessorID = $this->paymentProcessorCreate();
2956     $campaignID = $this->campaignCreate();
2957     $campaignID2 = $this->campaignCreate();
2958     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2959       'contact_id' => $this->_individualId,
2960       'installments' => '12',
2961       'frequency_interval' => '1',
2962       'amount' => '100',
2963       'contribution_status_id' => 1,
2964       'start_date' => '2012-01-01 00:00:00',
2965       'currency' => 'USD',
2966       'frequency_unit' => 'month',
2967       'payment_processor_id' => $paymentProcessorID,
2968       'campaign_id' => $campaignID,
2969     ]);
2970     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2971       $this->_params,
2972       [
2973         'contribution_recur_id' => $contributionRecur['id'],
2974         'campaign_id' => $campaignID2,
2975       ])
2976     );
2977
2978     $this->callAPISuccess('contribution', 'repeattransaction', [
2979       'original_contribution_id' => $originalContribution['id'],
2980       'contribution_status_id' => 'Completed',
2981       'trxn_id' => 789,
2982     ]);
2983
2984     $this->callAPISuccessGetSingle('Contribution', [
2985       'total_amount' => 100,
2986       'campaign_id' => $campaignID,
2987     ]);
2988   }
2989
2990   /**
2991    * CRM-20685 Repeattransaction produces incorrect Financial Type ID (in
2992    * specific circumstance) - if number of lineItems = 1.
2993    *
2994    * This case happens when the line item & contribution do not have the same
2995    * type in his initiating transaction.
2996    *
2997    * @throws \CRM_Core_Exception
2998    */
2999   public function testRepeatTransactionUpdatedFinancialTypeAndNotEquals(): void {
3000     $originalContribution = $this->setUpRecurringContribution([], ['financial_type_id' => 2]);
3001     // This will made the trick to get the not equals behaviour.
3002     $this->callAPISuccess('line_item', 'create', ['id' => 1, 'financial_type_id' => 4]);
3003     $this->callAPISuccess('contribution', 'repeattransaction', [
3004       'contribution_recur_id' => $originalContribution['id'],
3005       'contribution_status_id' => 'Completed',
3006       'trxn_id' => 1234,
3007     ]);
3008     $lineItemParams = [
3009       'entity_id' => $originalContribution['id'],
3010       'sequential' => 1,
3011       'return' => [
3012         'entity_table',
3013         'qty',
3014         'unit_price',
3015         'line_total',
3016         'label',
3017         'financial_type_id',
3018         'deductible_amount',
3019         'price_field_value_id',
3020         'price_field_id',
3021       ],
3022     ];
3023     $this->callAPISuccessGetSingle('contribution', [
3024       'total_amount' => 100,
3025       'financial_type_id' => 2,
3026     ]);
3027     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
3028       'entity_id' => $originalContribution['id'],
3029     ]));
3030     $expectedLineItem = array_merge(
3031       $lineItem1['values'][0], [
3032         'line_total' => '100.00',
3033         'unit_price' => '100.00',
3034         'financial_type_id' => 4,
3035         'contribution_type_id' => 4,
3036       ]
3037     );
3038
3039     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
3040       'entity_id' => $originalContribution['id'] + 1,
3041     ]));
3042     $this->callAPISuccess('line_item', 'create', ['id' => 1, 'financial_type_id' => 1]);
3043     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
3044     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
3045     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
3046   }
3047
3048   /**
3049    * Test completing a transaction does not 'mess' with net amount (CRM-15960).
3050    */
3051   public function testCompleteTransactionNetAmountOK() {
3052     $this->createLoggedInUser();
3053     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
3054     unset($params['net_amount']);
3055     $contribution = $this->callAPISuccess('contribution', 'create', $params);
3056     $this->callAPISuccess('contribution', 'completetransaction', [
3057       'id' => $contribution['id'],
3058     ]);
3059     $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id']]);
3060     $this->assertEquals('Completed', $contribution['contribution_status']);
3061     $this->assertTrue(($contribution['total_amount'] - $contribution['net_amount']) == $contribution['fee_amount']);
3062   }
3063
3064   /**
3065    * CRM-14151 - Test completing a transaction via the API.
3066    */
3067   public function testCompleteTransactionWithReceiptDateSet() {
3068     $this->swapMessageTemplateForTestTemplate();
3069     $mut = new CiviMailUtils($this, TRUE);
3070     $this->createLoggedInUser();
3071     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'receipt_date' => 'now']);
3072     $contribution = $this->callAPISuccess('contribution', 'create', $params);
3073     $this->callAPISuccess('contribution', 'completetransaction', ['id' => $contribution['id'], 'trxn_date' => date('Y-m-d')]);
3074     $contribution = $this->callAPISuccess('contribution', 'get', ['id' => $contribution['id'], 'sequential' => 1]);
3075     $this->assertEquals('Completed', $contribution['values'][0]['contribution_status']);
3076     // Make sure receive_date is original date and make sure payment date is today
3077     $this->assertEquals('2012-05-11', date('Y-m-d', strtotime($contribution['values'][0]['receive_date'])));
3078     $payment = $this->callAPISuccess('payment', 'get', ['contribution_id' => $contribution['id'], 'sequential' => 1]);
3079     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($payment['values'][0]['trxn_date'])));
3080     $mut->checkMailLog([
3081       'Receipt - Contribution',
3082       'receipt_date:::' . date('Ymd'),
3083     ]);
3084     $mut->stop();
3085     $this->revertTemplateToReservedTemplate();
3086   }
3087
3088   /**
3089    * CRM-1960 - Test to ensure that completetransaction respects the is_email_receipt setting
3090    */
3091   public function testCompleteTransactionWithEmailReceiptInput() {
3092     $contributionPage = $this->createReceiptableContributionPage();
3093
3094     $this->_params['contribution_page_id'] = $contributionPage['id'];
3095     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
3096     $contribution = $this->callAPISuccess('contribution', 'create', $params);
3097     // Complete the transaction overriding is_email_receipt to = FALSE
3098     $this->callAPISuccess('contribution', 'completetransaction', [
3099       'id' => $contribution['id'],
3100       'trxn_date' => date('2011-04-09'),
3101       'trxn_id' => 'kazam',
3102       'is_email_receipt' => 0,
3103     ]);
3104     // Check if a receipt was issued
3105     $receipt_date = $this->callAPISuccess('Contribution', 'getvalue', ['id' => $contribution['id'], 'return' => 'receipt_date']);
3106     $this->assertEquals('', $receipt_date);
3107   }
3108
3109   /**
3110    * Test that $is_recur is assigned to the receipt.
3111    */
3112   public function testCompleteTransactionForRecurring() {
3113     $this->mut = new CiviMailUtils($this, TRUE);
3114     $this->swapMessageTemplateForTestTemplate();
3115     $recurring = $this->setUpRecurringContribution();
3116     $contributionPage = $this->createReceiptableContributionPage(['is_recur' => TRUE, 'recur_frequency_unit' => 'month', 'recur_interval' => 1]);
3117
3118     $this->_params['contribution_page_id'] = $contributionPage['id'];
3119     $this->_params['contribution_recur_id'] = $recurring['id'];
3120
3121     $contribution = $this->setUpForCompleteTransaction();
3122
3123     $this->callAPISuccess('contribution', 'completetransaction', [
3124       'id' => $contribution['id'],
3125       'trxn_date' => date('2011-04-09'),
3126       'trxn_id' => 'kazam',
3127       'is_email_receipt' => 1,
3128     ]);
3129
3130     $this->mut->checkMailLog([
3131       'is_recur:::1',
3132       'cancelSubscriptionUrl:::' . CIVICRM_UF_BASEURL,
3133     ]);
3134     $this->mut->stop();
3135     $this->revertTemplateToReservedTemplate();
3136   }
3137
3138   /**
3139    * CRM-19710 - Test to ensure that completetransaction respects the input for
3140    * is_email_receipt setting.
3141    *
3142    * If passed in it will override the default from contribution page.
3143    *
3144    * @throws \API_Exception
3145    * @throws \CRM_Core_Exception
3146    */
3147   public function testCompleteTransactionWithEmailReceiptInputTrue(): void {
3148     $mut = new CiviMailUtils($this, TRUE);
3149     $this->createLoggedInUser();
3150     $contributionPageParams = ['is_email_receipt' => 0];
3151     // Create a Contribution Page with is_email_receipt = FALSE
3152     $contributionPageID = $this->createQuickConfigContributionPage($contributionPageParams);
3153     $this->_params['contribution_page_id'] = $contributionPageID;
3154     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'receipt_date' => 'now', 'amount_level' => 'amount entered']);
3155     $contribution = $this->callAPISuccess('Contribution', 'create', $params);
3156     // Complete the transaction overriding is_email_receipt to = TRUE.
3157     $this->callAPISuccess('Contribution', 'completetransaction', [
3158       'id' => $contribution['id'],
3159       'is_email_receipt' => 1,
3160     ]);
3161     $mut->checkMailLog([
3162       'Contribution Information',
3163       'amount entered',
3164     ]);
3165     $mut->stop();
3166   }
3167
3168   /**
3169    * Complete the transaction using the template with all the possible.
3170    */
3171   public function testCompleteTransactionWithTestTemplate() {
3172     $this->swapMessageTemplateForTestTemplate();
3173     $contribution = $this->setUpForCompleteTransaction();
3174     $this->callAPISuccess('contribution', 'completetransaction', [
3175       'id' => $contribution['id'],
3176       'trxn_date' => date('2011-04-09'),
3177       'trxn_id' => 'kazam',
3178     ]);
3179     $receive_date = $this->callAPISuccess('Contribution', 'getvalue', ['id' => $contribution['id'], 'return' => 'receive_date']);
3180     $this->mut->checkMailLog([
3181       'email:::anthony_anderson@civicrm.org',
3182       'is_monetary:::1',
3183       'amount:::100.00',
3184       'currency:::USD',
3185       'receive_date:::' . date('Ymd', strtotime($receive_date)),
3186       'receipt_date:::' . date('Ymd'),
3187       'title:::Contribution',
3188       'trxn_id:::kazam',
3189       'contactID:::' . $this->_params['contact_id'],
3190       'contributionID:::' . $contribution['id'],
3191       'financialTypeId:::1',
3192       'financialTypeName:::Donation',
3193     ]);
3194     $this->mut->stop();
3195     $this->revertTemplateToReservedTemplate();
3196   }
3197
3198   /**
3199    * Complete the transaction using the template with all the possible.
3200    */
3201   public function testCompleteTransactionContributionPageFromAddress() {
3202     $contributionPage = $this->callAPISuccess('ContributionPage', 'create', [
3203       'receipt_from_name' => 'Mickey Mouse',
3204       'receipt_from_email' => 'mickey@mouse.com',
3205       'title' => 'Test Contribution Page',
3206       'financial_type_id' => 1,
3207       'currency' => 'NZD',
3208       'goal_amount' => 50,
3209       'is_pay_later' => 1,
3210       'is_monetary' => TRUE,
3211       'is_email_receipt' => TRUE,
3212     ]);
3213     $this->_params['contribution_page_id'] = $contributionPage['id'];
3214     $contribution = $this->setUpForCompleteTransaction();
3215     $this->callAPISuccess('contribution', 'completetransaction', ['id' => $contribution['id']]);
3216     $this->mut->checkMailLog([
3217       'mickey@mouse.com',
3218       'Mickey Mouse <',
3219     ]);
3220     $this->mut->stop();
3221   }
3222
3223   /**
3224    * Test completing first transaction in a recurring series.
3225    *
3226    * The status should be set to 'in progress' and the next scheduled payment date calculated.
3227    *
3228    * @dataProvider getScheduledDateData
3229    *
3230    * @param array $dataSet
3231    *
3232    * @throws \Exception
3233    */
3234   public function testCompleteTransactionSetStatusToInProgress($dataSet) {
3235     $paymentProcessorID = $this->paymentProcessorCreate();
3236     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
3237       'contact_id' => $this->_individualId,
3238       'installments' => '2',
3239       'frequency_interval' => '1',
3240       'amount' => '500',
3241       'contribution_status_id' => 'Pending',
3242       'start_date' => '2012-01-01 00:00:00',
3243       'currency' => 'USD',
3244       'frequency_unit' => 'month',
3245       'payment_processor_id' => $paymentProcessorID,
3246     ], $dataSet['data']));
3247     $contribution = $this->callAPISuccess('contribution', 'create', array_merge(
3248       $this->_params,
3249       [
3250         'contribution_recur_id' => $contributionRecur['id'],
3251         'contribution_status_id' => 'Pending',
3252         'receive_date' => $dataSet['receive_date'],
3253       ])
3254     );
3255     $this->callAPISuccess('Contribution', 'completetransaction', [
3256       'id' => $contribution,
3257       'receive_date' => $dataSet['receive_date'],
3258     ]);
3259     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
3260       'id' => $contributionRecur['id'],
3261       'return' => ['next_sched_contribution_date', 'contribution_status_id'],
3262     ]);
3263     $this->assertEquals(5, $contributionRecur['contribution_status_id']);
3264     $this->assertEquals($dataSet['expected'], $contributionRecur['next_sched_contribution_date']);
3265     $this->callAPISuccess('Contribution', 'create', array_merge(
3266       $this->_params,
3267       [
3268         'contribution_recur_id' => $contributionRecur['id'],
3269         'contribution_status_id' => 'Completed',
3270       ]
3271     ));
3272     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
3273       'id' => $contributionRecur['id'],
3274       'return' => ['contribution_status_id'],
3275     ]);
3276     $this->assertEquals(1, $contributionRecur['contribution_status_id']);
3277   }
3278
3279   /**
3280    * Get dates for testing.
3281    *
3282    * @return array
3283    */
3284   public function getScheduledDateData() {
3285     $result = [];
3286     $result[]['2016-08-31-1-month'] = [
3287       'data' => [
3288         'start_date' => '2016-08-31',
3289         'frequency_interval' => 1,
3290         'frequency_unit' => 'month',
3291       ],
3292       'receive_date' => '2016-08-31',
3293       'expected' => '2016-10-01 00:00:00',
3294     ];
3295     $result[]['2012-01-01-1-month'] = [
3296       'data' => [
3297         'start_date' => '2012-01-01',
3298         'frequency_interval' => 1,
3299         'frequency_unit' => 'month',
3300       ],
3301       'receive_date' => '2012-01-01',
3302       'expected' => '2012-02-01 00:00:00',
3303     ];
3304     $result[]['2012-01-01-1-month'] = [
3305       'data' => [
3306         'start_date' => '2012-01-01',
3307         'frequency_interval' => 1,
3308         'frequency_unit' => 'month',
3309       ],
3310       'receive_date' => '2012-02-29',
3311       'expected' => '2012-03-29 00:00:00',
3312     ];
3313     $result['receive_date_includes_time']['2012-01-01-1-month'] = [
3314       'data' => [
3315         'start_date' => '2012-01-01',
3316         'frequency_interval' => 1,
3317         'frequency_unit' => 'month',
3318         'next_sched_contribution_date' => '2012-02-29',
3319       ],
3320       'receive_date' => '2012-02-29 16:00:00',
3321       'expected' => '2012-03-29 00:00:00',
3322     ];
3323     return $result;
3324   }
3325
3326   /**
3327    * Test completing a pledge with the completeTransaction api..
3328    *
3329    * Note that we are creating a logged in user because email goes out from
3330    * that person.
3331    */
3332   public function testCompleteTransactionUpdatePledgePayment() {
3333     $this->swapMessageTemplateForTestTemplate();
3334     $mut = new CiviMailUtils($this, TRUE);
3335     $mut->clearMessages();
3336     $this->createLoggedInUser();
3337     $contributionID = $this->createPendingPledgeContribution();
3338     $this->callAPISuccess('contribution', 'completetransaction', [
3339       'id' => $contributionID,
3340       'trxn_date' => '1 Feb 2013',
3341     ]);
3342     $pledge = $this->callAPISuccessGetSingle('Pledge', [
3343       'id' => $this->_ids['pledge'],
3344     ]);
3345     $this->assertEquals('Completed', $pledge['pledge_status']);
3346
3347     $status = $this->callAPISuccessGetValue('PledgePayment', [
3348       'pledge_id' => $this->_ids['pledge'],
3349       'return' => 'status_id',
3350     ]);
3351     $this->assertEquals(1, $status);
3352     $mut->checkMailLog([
3353       'amount:::500.00',
3354       // The `receive_date` should remain as it was created.
3355       // TODO: the latest payment transaction date (and maybe other details,
3356       // such as amount and payment instrument) would be a useful token to make
3357       // available.
3358       'receive_date:::20120511000000',
3359       "receipt_date:::\n",
3360     ]);
3361     $mut->stop();
3362     $this->revertTemplateToReservedTemplate();
3363   }
3364
3365   /**
3366    * Test completing a transaction with an event via the API.
3367    *
3368    * Note that we are creating a logged in user because email goes out from
3369    * that person
3370    *
3371    * @throws \CRM_Core_Exception
3372    */
3373   public function testCompleteTransactionWithParticipantRecord(): void {
3374     $mut = new CiviMailUtils($this, TRUE);
3375     $mut->clearMessages();
3376     $this->_individualId = $this->createLoggedInUser();
3377     $this->_params['source'] = 'Online Event Registration: Annual CiviCRM meet';
3378     $contributionID = $this->createPendingParticipantContribution();
3379     $this->createJoinedProfile(['entity_id' => $this->_ids['event']['test'], 'entity_table' => 'civicrm_event']);
3380     $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']);
3381     $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']);
3382     $this->eliminateUFGroupOne();
3383
3384     $this->callAPISuccess('contribution', 'completetransaction', ['id' => $contributionID]);
3385     $contribution = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID, 'return' => ['contribution_source']]);
3386     $this->assertEquals('Online Event Registration: Annual CiviCRM meet', $contribution['contribution_source']);
3387     $participantStatus = $this->callAPISuccessGetValue('participant', [
3388       'id' => $this->_ids['participant'],
3389       'return' => 'participant_status_id',
3390     ]);
3391     $this->assertEquals(1, $participantStatus);
3392
3393     //Assert only three activities are created.
3394     $activities = $this->callAPISuccess('Activity', 'get', [
3395       'contact_id' => $this->_individualId,
3396     ])['values'];
3397
3398     $this->assertCount(3, $activities);
3399     $activityNames = array_count_values(CRM_Utils_Array::collect('activity_name', $activities));
3400     // record two activities before and after completing payment for Event registration
3401     $this->assertEquals(2, $activityNames['Event Registration']);
3402     // update the original 'Contribution' activity created after completing payment
3403     $this->assertEquals(1, $activityNames['Contribution']);
3404
3405     $mut->checkMailLog([
3406       'Annual CiviCRM meet',
3407       'Event',
3408       'This is a confirmation that your registration has been received and your status has been updated to Registered.',
3409       'First Name: Logged In',
3410       'Public title',
3411       'public 2',
3412       'public 3',
3413     ], ['Back end title', 'title_post_2', 'title_post_3']);
3414     $mut->stop();
3415   }
3416
3417   /**
3418    * Test membership is renewed when transaction completed.
3419    *
3420    * @throws \API_Exception
3421    */
3422   public function testCompleteTransactionMembershipPriceSet(): void {
3423     $this->createPriceSetWithPage('membership');
3424     $this->createInitialPaidMembership();
3425     $membership = $this->callAPISuccess('Membership', 'getsingle', [
3426       'id' => $this->getMembershipID(),
3427       'status_id' => 'Grace',
3428       'return' => ['end_date'],
3429     ]);
3430     $this->assertEquals(date('Y-m-d', strtotime('yesterday')), $membership['end_date']);
3431
3432     $this->createSubsequentPendingMembership();
3433     $this->callAPISuccess('Payment', 'create', [
3434       'contribution_id' => $this->getContributionID('second'),
3435       'total_amount' => 20,
3436     ]);
3437     $membership = $this->callAPISuccess('membership', 'getsingle', ['id' => $this->_ids['membership']]);
3438     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 2 year')), $membership['end_date']);
3439     $logs = $this->callAPISuccess('MembershipLog', 'get', [
3440       'membership_id' => $this->getMembershipID(),
3441     ]);
3442     $this->assertEquals(4, $logs['count']);
3443     //Assert only three activities are created.
3444     $activityNames = (array) ActivityContact::get(FALSE)
3445       ->addWhere('contact_id', '=', $this->_ids['contact'])
3446       ->addSelect('activity_id.activity_type_id:name')->execute()->indexBy('activity_id.activity_type_id:name');
3447     $this->assertArrayHasKey('Contribution', $activityNames);
3448     $this->assertArrayHasKey('Membership Signup', $activityNames);
3449     $this->assertArrayHasKey('Change Membership Status', $activityNames);
3450   }
3451
3452   /**
3453    * Test if renewal activity is create after changing Pending contribution to
3454    * Completed via offline
3455    *
3456    * @throws \CRM_Core_Exception|\CiviCRM_API3_Exception
3457    */
3458   public function testPendingToCompleteContribution(): void {
3459     $this->createPriceSetWithPage('membership');
3460     $this->setUpPendingContribution($this->_ids['price_field_value'][0]);
3461     $this->callAPISuccess('membership', 'getsingle', ['id' => $this->_ids['membership']]);
3462     // Case 1: Assert that Membership Signup Activity is created on Pending to Completed Contribution via backoffice
3463     $activity = $this->callAPISuccess('Activity', 'get', [
3464       'activity_type_id' => 'Membership Signup',
3465       'source_record_id' => $this->_ids['membership'],
3466       'status_id' => 'Scheduled',
3467     ]);
3468     $this->assertEquals(1, $activity['count']);
3469     $_REQUEST['id'] = $this->getContributionID();
3470     $_REQUEST['action'] = 'update';
3471     // change pending contribution to completed
3472     /* @var CRM_Contribute_Form_Contribution $form */
3473     $form = $this->getFormObject('CRM_Contribute_Form_Contribution', [
3474       'total_amount' => 20,
3475       'net_amount' => 20,
3476       'fee_amount' => 0,
3477       'financial_type_id' => 1,
3478       'contact_id' => $this->_individualId,
3479       'contribution_status_id' => 1,
3480       'billing_middle_name' => '',
3481       'billing_last_name' => 'Adams',
3482       'billing_street_address-5' => '790L Lincoln St S',
3483       'billing_city-5' => 'Mary knoll',
3484       'billing_state_province_id-5' => 1031,
3485       'billing_postal_code-5' => 10545,
3486       'billing_country_id-5' => 1228,
3487       'frequency_interval' => 1,
3488       'frequency_unit' => 'month',
3489       'installments' => '',
3490       'hidden_AdditionalDetail' => 1,
3491       'hidden_Premium' => 1,
3492       'from_email_address' => '"civi45" <civi45@civicrm.com>',
3493       'payment_processor_id' => $this->paymentProcessorID,
3494       'currency' => 'USD',
3495       'contribution_page_id' => $this->_ids['contribution_page'],
3496       'source' => 'Membership Signup and Renewal',
3497     ]);
3498     $form->buildForm();
3499     $form->postProcess();
3500
3501     // Case 2: After successful payment for Pending backoffice there are three activities created
3502     //  2.a Update status of existing Scheduled Membership Signup (created in step 1) to Completed
3503     $activity = $this->callAPISuccess('Activity', 'get', [
3504       'activity_type_id' => 'Membership Signup',
3505       'source_record_id' => $this->getMembershipID(),
3506       'status_id' => 'Completed',
3507     ]);
3508     $this->assertEquals(1, $activity['count']);
3509     // 2.b Contribution activity created to record successful payment
3510     $activity = $this->callAPISuccess('Activity', 'get', [
3511       'activity_type_id' => 'Contribution',
3512       'source_record_id' => $this->getContributionID(),
3513       'status_id' => 'Completed',
3514     ]);
3515     $this->assertEquals(1, $activity['count']);
3516
3517     // 2.c 'Change membership type' activity created to record Membership status change from Grace to Current
3518     $activity = $this->callAPISuccess('Activity', 'get', [
3519       'activity_type_id' => 'Change Membership Status',
3520       'source_record_id' => $this->getMembershipID(),
3521       'status_id' => 'Completed',
3522     ]);
3523     $this->assertEquals(1, $activity['count']);
3524     $this->assertEquals('Status changed from Pending to New', $activity['values'][$activity['id']]['subject']);
3525     $membershipLogs = $this->callAPISuccess('MembershipLog', 'get', ['sequential' => 1])['values'];
3526     $this->assertEquals('Pending', CRM_Core_PseudoConstant::getName('CRM_Member_BAO_Membership', 'status_id', $membershipLogs[0]['status_id']));
3527     $this->assertEquals('New', CRM_Core_PseudoConstant::getName('CRM_Member_BAO_Membership', 'status_id', $membershipLogs[1]['status_id']));
3528     //Create another pending contribution for renewal
3529     $this->setUpPendingContribution($this->_ids['price_field_value'][0], 'second', [], ['entity_id' => $this->getMembershipID()], ['id' => $this->getMembershipID()]);
3530
3531     //Update it to Failed.
3532     $form->_params['id'] = $this->getContributionID('second');
3533     $form->_params['contribution_status_id'] = 4;
3534
3535     $form->testSubmit($form->_params, CRM_Core_Action::UPDATE);
3536     //Existing membership should not get updated to expired.
3537     $membership = $this->callAPISuccess('Membership', 'getsingle', ['id' => $this->_ids['membership']]);
3538     $this->assertNotEquals(4, $membership['status_id']);
3539   }
3540
3541   /**
3542    * Test membership is renewed for 2 terms when transaction completed based on the line item having 2 terms as qty.
3543    *
3544    * Also check that altering the qty for the most recent contribution results in repeattransaction picking it up.
3545    */
3546   public function testCompleteTransactionMembershipPriceSetTwoTerms(): void {
3547     $this->createPriceSetWithPage('membership');
3548     $this->createInitialPaidMembership();
3549     $this->createSubsequentPendingMembership();
3550
3551     $this->callAPISuccess('Payment', 'create', [
3552       'contribution_id' => $this->getContributionID('second'),
3553       'total_amount' => 20,
3554     ]);
3555
3556     $membership = $this->callAPISuccessGetSingle('membership', ['id' => $this->getMembershipID()]);
3557     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 2 years')), $membership['end_date']);
3558
3559     $paymentProcessorID = $this->paymentProcessorAuthorizeNetCreate();
3560
3561     $contributionRecurID = $this->callAPISuccess('ContributionRecur', 'create', ['contact_id' => $membership['contact_id'], 'payment_processor_id' => $paymentProcessorID, 'amount' => 20, 'frequency_interval' => 1])['id'];
3562     $this->callAPISuccess('Contribution', 'create', ['id' => $this->getContributionID(), 'contribution_recur_id' => $contributionRecurID]);
3563     $this->callAPISuccess('contribution', 'repeattransaction', ['contribution_recur_id' => $contributionRecurID, 'contribution_status_id' => 'Completed']);
3564     $membership = $this->callAPISuccessGetSingle('membership', ['id' => $this->getMembershipID()]);
3565     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 4 years')), $membership['end_date']);
3566
3567     // 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.
3568     $contribution = Contribution::get()->setOrderBy(['id' => 'DESC'])->setSelect(['id'])->execute()->first();
3569     CRM_Core_DAO::executeQuery('UPDATE civicrm_line_item SET price_field_value_id = ' . $this->_ids['price_field_value'][0] . ' WHERE contribution_id = ' . $contribution['id']);
3570     $this->callAPISuccess('contribution', 'repeattransaction', ['contribution_recur_id' => $contributionRecurID, 'contribution_status_id' => 'Completed']);
3571     $membership = $this->callAPISuccessGetSingle('membership', ['id' => $this->_ids['membership']]);
3572     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 5 years')), $membership['end_date']);
3573   }
3574
3575   public function cleanUpAfterPriceSets() {
3576     $this->quickCleanUpFinancialEntities();
3577     $this->contactDelete($this->_ids['contact']);
3578   }
3579
3580   /**
3581    * Set up a pending transaction with a specific price field id.
3582    *
3583    * @param int $priceFieldValueID
3584    * @param string $key
3585    * @param array $contributionParams
3586    * @param array $lineParams
3587    * @param array $membershipParams
3588    */
3589   public function setUpPendingContribution(int $priceFieldValueID, string $key = 'first', array $contributionParams = [], array $lineParams = [], array $membershipParams = []): void {
3590     $contactID = $this->individualCreate();
3591     $membershipParams = array_merge([
3592       'contact_id' => $contactID,
3593       'membership_type_id' => $this->_ids['membership_type'],
3594     ], $membershipParams);
3595     if ($key === 'first') {
3596       // If we want these after the initial we will set them.
3597       $membershipParams['start_date'] = 'yesterday - 1 year';
3598       $membershipParams['end_date'] = 'yesterday';
3599       $membershipParams['join_date'] = 'yesterday - 1 year';
3600     }
3601     $contribution = $this->callAPISuccess('Order', 'create', array_merge([
3602       'domain_id' => 1,
3603       'contact_id' => $contactID,
3604       'receive_date' => date('Ymd'),
3605       'total_amount' => 20.00,
3606       'financial_type_id' => 1,
3607       'payment_instrument_id' => 'Credit Card',
3608       'non_deductible_amount' => 10.00,
3609       'source' => 'SSF',
3610       'contribution_page_id' => $this->_ids['contribution_page'],
3611       'line_items' => [
3612         [
3613           'line_item' => [
3614             array_merge([
3615               'price_field_id' => $this->_ids['price_field'][0],
3616               'qty' => 1,
3617               'entity_table' => 'civicrm_membership',
3618               'unit_price' => 20,
3619               'line_total' => 20,
3620               'financial_type_id' => 1,
3621               'price_field_value_id' => $priceFieldValueID,
3622             ], $lineParams),
3623           ],
3624           'params' => $membershipParams,
3625         ],
3626       ],
3627     ], $contributionParams));
3628
3629     $this->_ids['contact'] = $contactID;
3630     $this->ids['contribution'][$key] = $contribution['id'];
3631     $this->_ids['membership'] = $this->callAPISuccessGetValue('MembershipPayment', ['return' => 'membership_id', 'contribution_id' => $contribution['id']]);
3632   }
3633
3634   /**
3635    * Test sending a mail via the API.
3636    *
3637    * @throws \CRM_Core_Exception
3638    */
3639   public function testSendMail(): void {
3640     $mut = new CiviMailUtils($this, TRUE);
3641     $orderParams = $this->_params;
3642     $orderParams['contribution_status_id'] = 'Pending';
3643     $orderParams['api.PaymentProcessor.pay'] = [
3644       'payment_processor_id' => $this->paymentProcessorID,
3645       'credit_card_type' => 'Visa',
3646       'credit_card_number' => 41111111111111,
3647       'amount' => 5,
3648     ];
3649
3650     $order = $this->callAPISuccess('Order', 'create', $orderParams);
3651     $this->callAPISuccess('Payment', 'create', ['total_amount' => 5, 'is_send_notification' => 0, 'order_id' => $order['id']]);
3652     $address = $this->callAPISuccess('Address', 'create', ['contribution_id' => $order['id'], 'name' => 'bob', 'contact_id' => 1, 'street_address' => 'blah']);
3653     $this->callAPISuccess('Contribution', 'create', ['id' => $order['id'], 'address_id' => $address['id']]);
3654     $this->callAPISuccess('contribution', 'sendconfirmation', [
3655       'id' => $order['id'],
3656       'receipt_from_email' => 'api@civicrm.org',
3657     ]);
3658     $mut->checkMailLog([
3659       '$100.00',
3660       'Contribution Information',
3661     ], [
3662       'Event',
3663     ]);
3664
3665     $this->checkCreditCardDetails($mut, $order['id']);
3666     $mut->stop();
3667     $tplVars = CRM_Core_Smarty::singleton()->get_template_vars();
3668     $this->assertEquals('bob', $tplVars['billingName']);
3669   }
3670
3671   /**
3672    * Test sending a mail via the API.
3673    * This simulates webform_civicrm using pay later contribution page
3674    *
3675    * @throws \CRM_Core_Exception
3676    * @throws \CiviCRM_API3_Exception
3677    */
3678   public function testSendConfirmationPayLater(): void {
3679     $mut = new CiviMailUtils($this, TRUE);
3680     // Create contribution page
3681     $pageParams = [
3682       'title' => 'Webform Contributions',
3683       'financial_type_id' => 1,
3684       'contribution_type_id' => 1,
3685       'is_confirm_enabled' => 1,
3686       'is_pay_later' => 1,
3687       'pay_later_text' => 'I will send payment by cheque',
3688       'pay_later_receipt' => 'Send your cheque payable to "CiviCRM LLC" to the office',
3689     ];
3690     $contributionPage = $this->callAPISuccess('ContributionPage', 'create', $pageParams);
3691
3692     // Create pay later contribution
3693     $contribution = $this->callAPISuccess('Order', 'create', [
3694       'contact_id' => $this->_individualId,
3695       'financial_type_id' => 1,
3696       'is_pay_later' => 1,
3697       'contribution_status_id' => 2,
3698       'contribution_page_id' => $contributionPage['id'],
3699       'total_amount' => '10.00',
3700       'line_items' => [
3701         [
3702           'line_item' => [
3703             [
3704               'entity_table' => 'civicrm_contribution',
3705               'label' => 'My lineitem label',
3706               'qty' => 1,
3707               'unit_price' => '10.00',
3708               'line_total' => '10.00',
3709             ],
3710           ],
3711         ],
3712       ],
3713     ]);
3714
3715     // Create email
3716     try {
3717       civicrm_api3('contribution', 'sendconfirmation', [
3718         'id' => $contribution['id'],
3719         'receipt_from_email' => 'api@civicrm.org',
3720       ]);
3721     }
3722     catch (Exception $e) {
3723       // Need to figure out how to stop this some other day
3724       // We don't care about the Payment Processor because this is Pay Later
3725       // The point of this test is to check we get the pay_later version of the mail
3726       if ($e->getMessage() !== 'Undefined variable: CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage') {
3727         throw $e;
3728       }
3729     }
3730
3731     // Retrieve mail & check it has the pay_later_receipt info
3732     $mut->getMostRecentEmail('raw');
3733     $mut->checkMailLog([
3734       (string) 10,
3735       $pageParams['pay_later_receipt'],
3736     ], [
3737       'Event',
3738     ]);
3739     $this->checkReceiptDetails($mut, $contributionPage['id'], $contribution['id'], $pageParams);
3740     $mut->stop();
3741   }
3742
3743   /**
3744    * Check credit card details in sent mail via API
3745    *
3746    * @param CiviMailUtils $mut
3747    * @param int $contributionID Contribution ID
3748    *
3749    * @throws \CRM_Core_Exception
3750    */
3751   public function checkCreditCardDetails($mut, $contributionID) {
3752     $this->callAPISuccess('contribution', 'create', $this->_params);
3753     $this->callAPISuccess('contribution', 'sendconfirmation', [
3754       'id' => $contributionID,
3755       'receipt_from_email' => 'api@civicrm.org',
3756       'payment_processor_id' => $this->paymentProcessorID,
3757     ]);
3758     $mut->checkMailLog([
3759       // billing header
3760       'Billing Name and Address',
3761       // billing name
3762       'anthony_anderson@civicrm.org',
3763     ], [
3764       'Event',
3765     ]);
3766   }
3767
3768   /**
3769    * Check receipt details in sent mail via API
3770    *
3771    * @param CiviMailUtils $mut
3772    * @param int $pageID Page ID
3773    * @param int $contributionID Contribution ID
3774    * @param array $pageParams
3775    *
3776    * @throws \CRM_Core_Exception
3777    */
3778   public function checkReceiptDetails($mut, $pageID, $contributionID, $pageParams): void {
3779     $pageReceipt = [
3780       'receipt_from_name' => 'Page FromName',
3781       'receipt_from_email' => 'page_from@email.com',
3782       'cc_receipt' => 'page_cc@email.com',
3783       'receipt_text' => 'Page Receipt Text',
3784       'pay_later_receipt' => $pageParams['pay_later_receipt'],
3785     ];
3786     $customReceipt = [
3787       'receipt_from_name' => 'Custom FromName',
3788       'receipt_from_email' => 'custom_from@email.com',
3789       'cc_receipt' => 'custom_cc@email.com',
3790       'receipt_text' => 'Test Custom Receipt Text',
3791       'pay_later_receipt' => 'Mail your check to test@example.com within 3 business days.',
3792     ];
3793     $this->callAPISuccess('ContributionPage', 'create', array_merge([
3794       'id' => $pageID,
3795       'is_email_receipt' => 1,
3796     ], $pageReceipt));
3797
3798     $this->callAPISuccess('contribution', 'sendconfirmation', array_merge([
3799       'id' => $contributionID,
3800       'payment_processor_id' => $this->paymentProcessorID,
3801     ], $customReceipt));
3802
3803     //Verify if custom receipt details are present in email.
3804     //Page receipt details shouldn't be included.
3805     $mut->checkMailLog(array_values($customReceipt), array_values($pageReceipt));
3806   }
3807
3808   /**
3809    * Test sending a mail via the API.
3810    */
3811   public function testSendMailEvent() {
3812     $mut = new CiviMailUtils($this, TRUE);
3813     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
3814     $event = $this->eventCreate([
3815       'is_email_confirm' => 1,
3816       'confirm_from_email' => 'test@civicrm.org',
3817     ]);
3818     $this->_eventID = $event['id'];
3819     $participantParams = [
3820       'contact_id' => $this->_individualId,
3821       'event_id' => $this->_eventID,
3822       'status_id' => 1,
3823       'role_id' => 1,
3824       // to ensure it matches later on
3825       'register_date' => '2007-07-21 00:00:00',
3826       'source' => 'Online Event Registration: API Testing',
3827
3828     ];
3829     $participant = $this->callAPISuccess('participant', 'create', $participantParams);
3830     $this->callAPISuccess('participant_payment', 'create', [
3831       'participant_id' => $participant['id'],
3832       'contribution_id' => $contribution['id'],
3833     ]);
3834     $this->callAPISuccess('contribution', 'sendconfirmation', [
3835       'id' => $contribution['id'],
3836       'receipt_from_email' => 'api@civicrm.org',
3837     ]);
3838
3839     $mut->checkMailLog([
3840       'Annual CiviCRM meet',
3841       'Event',
3842       'To: "Mr. Anthony Anderson II" <anthony_anderson@civicrm.org>',
3843     ], []);
3844     $mut->stop();
3845   }
3846
3847   /**
3848    * This function does a GET & compares the result against the $params.
3849    *
3850    * Use as a double check on Creates.
3851    *
3852    * @param array $params
3853    * @param int $id
3854    * @param bool $delete
3855    *
3856    * @throws \CRM_Core_Exception
3857    */
3858   public function contributionGetnCheck(array $params, int $id, bool $delete = TRUE): void {
3859     $contribution = $this->callAPISuccess('Contribution', 'Get', [
3860       'id' => $id,
3861       'return' => array_merge(['contribution_source'], array_keys($params)),
3862     ]);
3863     if ($delete) {
3864       $this->callAPISuccess('contribution', 'delete', ['id' => $id]);
3865     }
3866     $this->assertAPISuccess($contribution, 0);
3867     $values = $contribution['values'][$contribution['id']];
3868     $params['receive_date'] = date('Y-m-d H:i:s', strtotime($params['receive_date']));
3869     // this is not returned in id format
3870     unset($params['payment_instrument_id']);
3871     $params['contribution_source'] = $params['source'];
3872     unset($params['source'], $params['sequential']);
3873     foreach ($params as $key => $value) {
3874       $this->assertEquals($value, $values[$key], $key . " value: $value doesn't match " . print_r($values, TRUE));
3875     }
3876   }
3877
3878   /**
3879    * Create a pending contribution & linked pending pledge record.
3880    *
3881    * @throws \CRM_Core_Exception
3882    */
3883   public function createPendingPledgeContribution() {
3884
3885     $pledgeID = $this->pledgeCreate(['contact_id' => $this->_individualId, 'installments' => 1, 'amount' => 500]);
3886     $this->_ids['pledge'] = $pledgeID;
3887     $contribution = $this->callAPISuccess('Contribution', 'create', array_merge($this->_params, [
3888       'contribution_status_id' => 'Pending',
3889       'total_amount' => 500,
3890     ]));
3891     $paymentID = $this->callAPISuccessGetValue('PledgePayment', [
3892       'options' => ['limit' => 1],
3893       'return' => 'id',
3894     ]);
3895     $this->callAPISuccess('PledgePayment', 'create', [
3896       'id' => $paymentID,
3897       'contribution_id' =>
3898       $contribution['id'],
3899       'status_id' => 'Pending',
3900       'scheduled_amount' => 500,
3901     ]);
3902
3903     return $contribution['id'];
3904   }
3905
3906   /**
3907    * Create a pending contribution & linked pending participant record (along
3908    * with an event).
3909    *
3910    * @throws \CRM_Core_Exception
3911    */
3912   public function createPendingParticipantContribution() {
3913     $this->_ids['event']['test'] = $this->eventCreate(['is_email_confirm' => 1, 'confirm_from_email' => 'test@civicrm.org'])['id'];
3914     $participantID = $this->participantCreate(['event_id' => $this->_ids['event']['test'], 'status_id' => 6, 'contact_id' => $this->_individualId]);
3915     $this->_ids['participant'] = $participantID;
3916     $params = array_merge($this->_params, ['contact_id' => $this->_individualId, 'contribution_status_id' => 2, 'financial_type_id' => 'Event Fee']);
3917     $contribution = $this->callAPISuccess('contribution', 'create', $params);
3918     $this->callAPISuccess('participant_payment', 'create', [
3919       'contribution_id' => $contribution['id'],
3920       'participant_id' => $participantID,
3921     ]);
3922     $this->callAPISuccess('line_item', 'get', [
3923       'entity_id' => $contribution['id'],
3924       'entity_table' => 'civicrm_contribution',
3925       'api.line_item.create' => [
3926         'entity_id' => $participantID,
3927         'entity_table' => 'civicrm_participant',
3928       ],
3929     ]);
3930     return $contribution['id'];
3931   }
3932
3933   /**
3934    * Get financial transaction amount.
3935    *
3936    * @param int $contId
3937    *
3938    * @return null|string
3939    */
3940   public function _getFinancialTrxnAmount($contId) {
3941     $query = "SELECT
3942      SUM( ft.total_amount ) AS total
3943      FROM civicrm_financial_trxn AS ft
3944      LEFT JOIN civicrm_entity_financial_trxn AS ceft ON ft.id = ceft.financial_trxn_id
3945      WHERE ceft.entity_table = 'civicrm_contribution'
3946      AND ceft.entity_id = {$contId}";
3947
3948     return CRM_Core_DAO::singleValueQuery($query);
3949   }
3950
3951   /**
3952    * @param int $contId
3953    *
3954    * @return null|string
3955    */
3956   public function _getFinancialItemAmount($contId) {
3957     $lineItem = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
3958     $query = "SELECT
3959      SUM(amount)
3960      FROM civicrm_financial_item
3961      WHERE entity_table = 'civicrm_line_item'
3962      AND entity_id = {$lineItem}";
3963     return CRM_Core_DAO::singleValueQuery($query);
3964   }
3965
3966   /**
3967    * @param int $contId
3968    * @param $context
3969    */
3970   public function _checkFinancialItem($contId, $context) {
3971     if ($context !== 'paylater') {
3972       $params = [
3973         'entity_id' => $contId,
3974         'entity_table' => 'civicrm_contribution',
3975       ];
3976       $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($params, TRUE));
3977       $entityParams = [
3978         'financial_trxn_id' => $trxn['financial_trxn_id'],
3979         'entity_table' => 'civicrm_financial_item',
3980       ];
3981       $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
3982       $params = [
3983         'id' => $entityTrxn['entity_id'],
3984       ];
3985     }
3986     if ($context === 'paylater') {
3987       $lineItems = CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution');
3988       foreach ($lineItems as $key => $item) {
3989         $params = [
3990           'entity_id' => $key,
3991           'entity_table' => 'civicrm_line_item',
3992         ];
3993         $compareParams = ['status_id' => 1];
3994         $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
3995       }
3996     }
3997     elseif ($context === 'refund') {
3998       $compareParams = [
3999         'status_id' => 1,
4000         'financial_account_id' => 1,
4001         'amount' => -100,
4002       ];
4003     }
4004     elseif ($context === 'cancelPending') {
4005       $compareParams = [
4006         'status_id' => 3,
4007         'financial_account_id' => 1,
4008         'amount' => -100,
4009       ];
4010     }
4011     elseif ($context === 'changeFinancial') {
4012       $lineKey = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
4013       $params = [
4014         'entity_id' => $lineKey,
4015         'amount' => -100,
4016       ];
4017       $compareParams = [
4018         'financial_account_id' => 1,
4019       ];
4020       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
4021       $params = [
4022         'financial_account_id' => 3,
4023         'entity_id' => $lineKey,
4024       ];
4025       $compareParams = [
4026         'amount' => 100,
4027       ];
4028     }
4029     if ($context !== 'paylater') {
4030       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
4031     }
4032   }
4033
4034   /**
4035    * Check correct financial transaction entries were created for the change in payment instrument.
4036    *
4037    * @param int $contributionID
4038    * @param int $originalInstrumentID
4039    * @param int $newInstrumentID
4040    * @param int $amount
4041    */
4042   public function checkFinancialTrxnPaymentInstrumentChange($contributionID, $originalInstrumentID, $newInstrumentID, $amount = 100) {
4043
4044     $entityFinancialTrxns = $this->getFinancialTransactionsForContribution($contributionID);
4045
4046     $originalTrxnParams = [
4047       'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($originalInstrumentID),
4048       'payment_instrument_id' => $originalInstrumentID,
4049       'amount' => $amount,
4050       'status_id' => 1,
4051     ];
4052
4053     $reversalTrxnParams = [
4054       'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($originalInstrumentID),
4055       'payment_instrument_id' => $originalInstrumentID,
4056       'amount' => -$amount,
4057       'status_id' => 1,
4058     ];
4059
4060     $newTrxnParams = [
4061       'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($newInstrumentID),
4062       'payment_instrument_id' => $newInstrumentID,
4063       'amount' => $amount,
4064       'status_id' => 1,
4065     ];
4066
4067     foreach ([$originalTrxnParams, $reversalTrxnParams, $newTrxnParams] as $index => $transaction) {
4068       $entityFinancialTrxn = $entityFinancialTrxns[$index];
4069       $this->assertEquals($entityFinancialTrxn['amount'], $transaction['amount']);
4070
4071       $financialTrxn = $this->callAPISuccessGetSingle('FinancialTrxn', [
4072         'id' => $entityFinancialTrxn['financial_trxn_id'],
4073       ]);
4074       $this->assertEquals($transaction['status_id'], $financialTrxn['status_id']);
4075       $this->assertEquals($transaction['amount'], $financialTrxn['total_amount']);
4076       $this->assertEquals($transaction['amount'], $financialTrxn['net_amount']);
4077       $this->assertEquals(0, $financialTrxn['fee_amount']);
4078       $this->assertEquals($transaction['payment_instrument_id'], $financialTrxn['payment_instrument_id']);
4079       $this->assertEquals($transaction['to_financial_account_id'], $financialTrxn['to_financial_account_id']);
4080
4081       // Generic checks.
4082       $this->assertEquals(1, $financialTrxn['is_payment']);
4083       $this->assertEquals('USD', $financialTrxn['currency']);
4084       $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($financialTrxn['trxn_date'])));
4085     }
4086   }
4087
4088   /**
4089    * Check financial transaction.
4090    *
4091    * @todo break this down into sensible functions - most calls to it only use a few lines out of the big if.
4092    *
4093    * @param array $contribution
4094    * @param string $context
4095    * @param int $instrumentId
4096    * @param array $extraParams
4097    */
4098   public function _checkFinancialTrxn($contribution, $context, $instrumentId = NULL, $extraParams = []) {
4099     $financialTrxns = $this->getFinancialTransactionsForContribution($contribution['id']);
4100     $trxn = array_pop($financialTrxns);
4101
4102     $params = [
4103       'id' => $trxn['financial_trxn_id'],
4104     ];
4105     if ($context === 'payLater') {
4106       $compareParams = [
4107         'status_id' => 1,
4108         'from_financial_account_id' => CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($contribution['financial_type_id'], 'Accounts Receivable Account is'),
4109       ];
4110     }
4111     elseif ($context === 'refund') {
4112       $compareParams = [
4113         'to_financial_account_id' => 6,
4114         'total_amount' => -100,
4115         'status_id' => 7,
4116         'trxn_date' => '2015-01-01 09:00:00',
4117         'trxn_id' => 'the refund',
4118       ];
4119     }
4120     elseif ($context === 'cancelPending') {
4121       $compareParams = [
4122         'to_financial_account_id' => 7,
4123         'total_amount' => -100,
4124         'status_id' => 3,
4125       ];
4126     }
4127     elseif ($context === 'changeFinancial' || $context === 'paymentInstrument') {
4128       // @todo checkFinancialTrxnPaymentInstrumentChange instead for paymentInstrument.
4129       // It does the same thing with greater readability.
4130       // @todo remove handling for
4131
4132       $entityParams = [
4133         'entity_id' => $contribution['id'],
4134         'entity_table' => 'civicrm_contribution',
4135         'amount' => -100,
4136       ];
4137       $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
4138       $trxnParams1 = [
4139         'id' => $trxn['financial_trxn_id'],
4140       ];
4141       if (empty($extraParams)) {
4142         $compareParams = [
4143           'total_amount' => -100,
4144           'status_id' => 1,
4145         ];
4146       }
4147       elseif ($context !== 'changeFinancial') {
4148         $compareParams = [
4149           'total_amount' => 100,
4150           'status_id' => 1,
4151         ];
4152       }
4153       if ($context === 'paymentInstrument') {
4154         $compareParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($instrumentId);
4155         $compareParams['payment_instrument_id'] = $instrumentId;
4156       }
4157       else {
4158         $compareParams['to_financial_account_id'] = 12;
4159       }
4160       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams1, array_merge($compareParams, $extraParams));
4161       $compareParams['total_amount'] = 100;
4162       // Reverse the extra params now that we will be checking the new positive transaction.
4163       if ($context === 'changeFinancial' && !empty($extraParams)) {
4164         foreach ($extraParams as $param => $value) {
4165           $extraParams[$param] = 0 - $value;
4166         }
4167       }
4168     }
4169
4170     $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $params, array_merge($compareParams, $extraParams));
4171   }
4172
4173   /**
4174    * @return mixed
4175    */
4176   public function _addPaymentInstrument() {
4177     $gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'payment_instrument', 'id', 'name');
4178     $optionParams = [
4179       'option_group_id' => $gId,
4180       'label' => 'Test Card',
4181       'name' => 'Test Card',
4182       'value' => '6',
4183       'weight' => '6',
4184       'is_active' => 1,
4185     ];
4186     $optionValue = $this->callAPISuccess('option_value', 'create', $optionParams);
4187     $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
4188     $financialParams = [
4189       'entity_table' => 'civicrm_option_value',
4190       'entity_id' => $optionValue['id'],
4191       'account_relationship' => $relationTypeId,
4192       'financial_account_id' => 7,
4193     ];
4194     CRM_Financial_BAO_FinancialTypeAccount::add($financialParams);
4195     $this->assertNotEmpty($optionValue['values'][$optionValue['id']]['value']);
4196     return $optionValue['values'][$optionValue['id']]['value'];
4197   }
4198
4199   public function _deletedAddedPaymentInstrument() {
4200     $result = $this->callAPISuccess('OptionValue', 'get', [
4201       'option_group_id' => 'payment_instrument',
4202       'name' => 'Test Card',
4203       'value' => '6',
4204       'is_active' => 1,
4205     ]);
4206     if ($id = CRM_Utils_Array::value('id', $result)) {
4207       $this->callAPISuccess('OptionValue', 'delete', ['id' => $id]);
4208     }
4209   }
4210
4211   /**
4212    * Set up the basic recurring contribution for tests.
4213    *
4214    * @param array $generalParams
4215    *   Parameters that can be merged into the recurring AND the contribution.
4216    *
4217    * @param array $recurParams
4218    *   Parameters to merge into the recur only.
4219    *
4220    * @return array|int
4221    * @throws \CRM_Core_Exception
4222    */
4223   protected function setUpRecurringContribution($generalParams = [], $recurParams = []) {
4224     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
4225       'contact_id' => $this->_individualId,
4226       'installments' => '12',
4227       'frequency_interval' => '1',
4228       'amount' => '100',
4229       'contribution_status_id' => 1,
4230       'start_date' => '2012-01-01 00:00:00',
4231       'currency' => 'USD',
4232       'frequency_unit' => 'month',
4233       'payment_processor_id' => $this->paymentProcessorID,
4234     ], $generalParams, $recurParams));
4235     $contributionParams = array_merge(
4236       $this->_params,
4237       [
4238         'contribution_recur_id' => $contributionRecur['id'],
4239         'contribution_status_id' => 'Pending',
4240       ], $generalParams);
4241     $contributionParams['api.Payment.create'] = ['total_amount' => $contributionParams['total_amount']];
4242     $originalContribution = $this->callAPISuccess('Order', 'create', $contributionParams);
4243     return $originalContribution;
4244   }
4245
4246   /**
4247    * Set up a basic auto-renew membership for tests.
4248    *
4249    * @param array $generalParams
4250    *   Parameters that can be merged into the recurring AND the contribution.
4251    *
4252    * @param array $recurParams
4253    *   Parameters to merge into the recur only.
4254    *
4255    * @return array|int
4256    * @throws \CRM_Core_Exception
4257    */
4258   protected function setUpAutoRenewMembership($generalParams = [], $recurParams = []) {
4259     $newContact = $this->callAPISuccess('Contact', 'create', [
4260       'contact_type' => 'Individual',
4261       'sort_name' => 'McTesterson, Testy',
4262       'display_name' => 'Testy McTesterson',
4263       'preferred_language' => 'en_US',
4264       'preferred_mail_format' => 'Both',
4265       'first_name' => 'Testy',
4266       'last_name' => 'McTesterson',
4267       'contact_is_deleted' => '0',
4268       'email_id' => '4',
4269       'email' => 'tmctesterson@example.com',
4270       'on_hold' => '0',
4271     ]);
4272     $membershipType = $this->callAPISuccess('MembershipType', 'create', [
4273       'domain_id' => 'Default Domain Name',
4274       'member_of_contact_id' => 1,
4275       'financial_type_id' => 'Member Dues',
4276       'duration_unit' => 'month',
4277       'duration_interval' => 1,
4278       'period_type' => 'rolling',
4279       'name' => 'Standard Member',
4280       'minimum_fee' => 100,
4281     ]);
4282     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
4283       'contact_id' => $newContact['id'],
4284       'installments' => '12',
4285       'frequency_interval' => '1',
4286       'amount' => '100',
4287       'contribution_status_id' => 1,
4288       'start_date' => '2012-01-01 00:00:00',
4289       'currency' => 'USD',
4290       'frequency_unit' => 'month',
4291       'payment_processor_id' => $this->paymentProcessorID,
4292     ], $generalParams, $recurParams));
4293
4294     $originalContribution = $this->callAPISuccess('Order', 'create', array_merge(
4295       $this->_params,
4296       [
4297         'contact_id' => $newContact['id'],
4298         'contribution_recur_id' => $contributionRecur['id'],
4299         'financial_type_id' => 'Member Dues',
4300         'api.Payment.create' => ['total_amount' => 100, 'payment_instrument_id' => 'Credit card'],
4301         'invoice_id' => 2345,
4302         'line_items' => [
4303           [
4304             'line_item' => [
4305               [
4306                 'membership_type_id' => $membershipType['id'],
4307                 'financial_type_id' => 'Member Dues',
4308                 'line_total' => $generalParams['total_amount'] ?? 100,
4309               ],
4310             ],
4311             'params' => [
4312               'contact_id' => $newContact['id'],
4313               'contribution_recur_id' => $contributionRecur['id'],
4314               'membership_type_id' => $membershipType['id'],
4315               'num_terms' => 1,
4316             ],
4317           ],
4318         ],
4319       ], $generalParams)
4320     );
4321     $lineItem = $this->callAPISuccess('LineItem', 'getsingle', []);
4322     $this->assertEquals('civicrm_membership', $lineItem['entity_table']);
4323     $membership = $this->callAPISuccess('Membership', 'getsingle', ['id' => $lineItem['entity_id']]);
4324     $this->callAPISuccess('LineItem', 'getsingle', []);
4325     $this->callAPISuccessGetCount('MembershipPayment', ['membership_id' => $membership['id']], 1);
4326
4327     return [$originalContribution, $membership];
4328   }
4329
4330   /**
4331    * Set up a repeat transaction.
4332    *
4333    * @param array $recurParams
4334    * @param string $flag
4335    * @param array $contributionParams
4336    *
4337    * @return array
4338    */
4339   protected function setUpRepeatTransaction(array $recurParams, $flag, array $contributionParams = []) {
4340     $paymentProcessorID = $this->paymentProcessorCreate();
4341     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
4342       'contact_id' => $this->_individualId,
4343       'installments' => '12',
4344       'frequency_interval' => '1',
4345       'amount' => '500',
4346       'contribution_status_id' => 1,
4347       'start_date' => '2012-01-01 00:00:00',
4348       'currency' => 'USD',
4349       'frequency_unit' => 'month',
4350       'payment_processor_id' => $paymentProcessorID,
4351     ], $recurParams));
4352
4353     $originalContribution = '';
4354     if ($flag === 'multiple') {
4355       // CRM-19309 create a contribution + also add in line_items (plural):
4356       $this->createContributionWithTwoLineItemsAgainstPriceSet([
4357         'contact_id' => $this->_individualId,
4358         'contribution_recur_id' => $contributionRecur['id'],
4359       ]);
4360       $originalContribution = $this->callAPISuccessGetSingle('Contribution', ['contribution_recur_id' => $contributionRecur['id'], 'return' => 'id']);
4361     }
4362     elseif ($flag === 'single') {
4363       $params = array_merge($this->_params, ['contribution_recur_id' => $contributionRecur['id']]);
4364       $params = array_merge($params, $contributionParams);
4365       $originalContribution = $this->callAPISuccess('Order', 'create', $params);
4366       // Note the saved contribution amount will include tax.
4367       $this->callAPISuccess('Payment', 'create', [
4368         'contribution_id' => $originalContribution['id'],
4369         'total_amount' => $originalContribution['values'][$originalContribution['id']]['total_amount'],
4370       ]);
4371     }
4372     $originalContribution['contribution_recur_id'] = $contributionRecur['id'];
4373     $originalContribution['payment_processor_id'] = $paymentProcessorID;
4374     return $originalContribution;
4375   }
4376
4377   /**
4378    * Common set up routine.
4379    *
4380    * @return array
4381    * @throws \CRM_Core_Exception
4382    */
4383   protected function setUpForCompleteTransaction(): array {
4384     $this->mut = new CiviMailUtils($this, TRUE);
4385     $this->createLoggedInUser();
4386     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'receipt_date' => 'now']);
4387     return $this->callAPISuccess('Contribution', 'create', $params);
4388   }
4389
4390   /**
4391    * Test repeat contribution uses the Payment Processor' payment_instrument setting.
4392    *
4393    * @throws \CRM_Core_Exception
4394    */
4395   public function testRepeatTransactionWithNonCreditCardDefault() {
4396     $contributionRecur = $this->callAPISuccess('ContributionRecur', 'create', [
4397       'contact_id' => $this->_individualId,
4398       'installments' => '12',
4399       'frequency_interval' => '1',
4400       'amount' => '100',
4401       'contribution_status_id' => 1,
4402       'start_date' => '2012-01-01 00:00:00',
4403       'currency' => 'USD',
4404       'frequency_unit' => 'month',
4405       'payment_processor_id' => $this->paymentProcessorID,
4406     ]);
4407     $contribution1 = $this->callAPISuccess('contribution', 'create', array_merge(
4408         $this->_params,
4409         ['contribution_recur_id' => $contributionRecur['id'], 'payment_instrument_id' => 2])
4410     );
4411     $contribution2 = $this->callAPISuccess('contribution', 'repeattransaction', [
4412       'contribution_status_id' => 'Completed',
4413       'trxn_id' => 'blah',
4414       'original_contribution_id' => $contribution1,
4415     ]);
4416     $this->assertEquals('Debit Card', CRM_Contribute_PseudoConstant::getLabel('CRM_Contribute_BAO_Contribution', 'payment_instrument_id', $contribution2['values'][$contribution2['id']]['payment_instrument_id']));
4417   }
4418
4419   /**
4420    * CRM-20008 Tests repeattransaction creates pending membership.
4421    *
4422    * @throws \CRM_Core_Exception
4423    */
4424   public function testRepeatTransactionMembershipCreatePendingContribution(): void {
4425     [$originalContribution, $membership] = $this->setUpAutoRenewMembership();
4426     $this->callAPISuccess('membership', 'create', [
4427       'id' => $membership['id'],
4428       'end_date' => 'yesterday',
4429       'status_id' => 'Expired',
4430     ]);
4431     $repeatedContribution = $this->callAPISuccess('contribution', 'repeattransaction', [
4432       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
4433       'contribution_status_id' => 'Pending',
4434       'trxn_id' => 1234,
4435     ]);
4436     $membershipStatusId = $this->callAPISuccess('membership', 'getvalue', [
4437       'id' => $membership['id'],
4438       'return' => 'status_id',
4439     ]);
4440
4441     // Let's see if the membership payments got created while we're at it.
4442     $membershipPayments = $this->callAPISuccess('MembershipPayment', 'get', [
4443       'membership_id' => $membership['id'],
4444     ]);
4445     $this->assertEquals(2, $membershipPayments['count']);
4446
4447     $this->assertEquals('Expired', CRM_Core_PseudoConstant::getLabel('CRM_Member_BAO_Membership', 'status_id', $membershipStatusId));
4448     $this->callAPISuccess('Contribution', 'completetransaction', ['id' => $repeatedContribution['id']]);
4449     $membership = $this->callAPISuccessGetSingle('membership', [
4450       'id' => $membership['id'],
4451       'return' => 'status_id, end_date',
4452     ]);
4453     $this->assertEquals('New', CRM_Core_PseudoConstant::getName('CRM_Member_BAO_Membership', 'status_id', $membership['status_id']));
4454     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 1 month')), $membership['end_date']);
4455   }
4456
4457   /**
4458    * Test sending a mail via the API.
4459    *
4460    * @throws \CRM_Core_Exception
4461    */
4462   public function testSendMailWithAPISetFromDetails() {
4463     $mut = new CiviMailUtils($this, TRUE);
4464     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
4465     $this->callAPISuccess('contribution', 'sendconfirmation', [
4466       'id' => $contribution['id'],
4467       'receipt_from_email' => 'api@civicrm.org',
4468       'receipt_from_name' => 'CiviCRM LLC',
4469     ]);
4470     $mut->checkMailLog([
4471       'From: CiviCRM LLC <api@civicrm.org>',
4472       'Contribution Information',
4473     ], [
4474       'Event',
4475     ]);
4476     $mut->stop();
4477   }
4478
4479   /**
4480    * Test sending a mail via the API.
4481    */
4482   public function testSendMailWithNoFromSetFallToDomain() {
4483     $this->createLoggedInUser();
4484     $mut = new CiviMailUtils($this, TRUE);
4485     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
4486     $this->callAPISuccess('contribution', 'sendconfirmation', [
4487       'id' => $contribution['id'],
4488     ]);
4489     $domain = $this->callAPISuccess('domain', 'getsingle', ['id' => 1]);
4490     $mut->checkMailLog([
4491       'From: ' . $domain['from_name'] . ' <' . $domain['from_email'] . '>',
4492       'Contribution Information',
4493     ], [
4494       'Event',
4495     ]);
4496     $mut->stop();
4497   }
4498
4499   /**
4500    * Test sending a mail via the API.
4501    *
4502    * @throws \CRM_Core_Exception
4503    */
4504   public function testSendMailWithRepeatTransactionAPIFalltoDomain() {
4505     $this->createLoggedInUser();
4506     $mut = new CiviMailUtils($this, TRUE);
4507     $contribution = $this->setUpRepeatTransaction([], 'single');
4508     $this->callAPISuccess('contribution', 'repeattransaction', [
4509       'contribution_status_id' => 'Completed',
4510       'trxn_id' => 7890,
4511       'original_contribution_id' => $contribution,
4512     ]);
4513     $domain = $this->callAPISuccess('domain', 'getsingle', ['id' => 1]);
4514     $mut->checkMailLog([
4515       'From: ' . $domain['from_name'] . ' <' . $domain['from_email'] . '>',
4516       'Contribution Information',
4517     ], [
4518       'Event',
4519     ]
4520     );
4521     $mut->stop();
4522   }
4523
4524   /**
4525    * Test sending a mail via the API.
4526    *
4527    * @throws \CRM_Core_Exception
4528    */
4529   public function testSendMailWithRepeatTransactionAPIFalltoContributionPage() {
4530     $mut = new CiviMailUtils($this, TRUE);
4531     $contributionPage = $this->contributionPageCreate(['receipt_from_name' => 'CiviCRM LLC', 'receipt_from_email' => 'contributionpage@civicrm.org', 'is_email_receipt' => 1]);
4532     $paymentProcessorID = $this->paymentProcessorCreate();
4533     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
4534       'contact_id' => $this->_individualId,
4535       'installments' => '12',
4536       'frequency_interval' => '1',
4537       'amount' => '500',
4538       'contribution_status_id' => 1,
4539       'start_date' => '2012-01-01 00:00:00',
4540       'currency' => 'USD',
4541       'frequency_unit' => 'month',
4542       'payment_processor_id' => $paymentProcessorID,
4543     ]);
4544     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
4545       $this->_params,
4546       [
4547         'contribution_recur_id' => $contributionRecur['id'],
4548         'contribution_page_id' => $contributionPage['id'],
4549       ])
4550     );
4551     $this->callAPISuccess('Contribution', 'repeattransaction', [
4552       'contribution_status_id' => 'Completed',
4553       'trxn_id' => 5678,
4554       'original_contribution_id' => $originalContribution,
4555     ]
4556     );
4557     $mut->checkMailLog([
4558       'From: CiviCRM LLC <contributionpage@civicrm.org>',
4559       'Contribution Information',
4560     ], [
4561       'Event',
4562     ]);
4563     $mut->stop();
4564   }
4565
4566   /**
4567    * Test sending a mail via the API.
4568    *
4569    * @throws \CRM_Core_Exception
4570    */
4571   public function testSendMailWithRepeatTransactionAPIFalltoSystemFromNoDefaultFrom(): void {
4572     $mut = new CiviMailUtils($this, TRUE);
4573     $originalContribution = $this->setUpRepeatTransaction([], 'single');
4574     $fromEmail = $this->callAPISuccess('optionValue', 'get', ['is_default' => 1, 'option_group_id' => 'from_email_address', 'sequential' => 1]);
4575     foreach ($fromEmail['values'] as $from) {
4576       $this->callAPISuccess('optionValue', 'create', ['is_default' => 0, 'id' => $from['id']]);
4577     }
4578     $domain = $this->callAPISuccess('domain', 'getsingle', ['id' => CRM_Core_Config::domainID()]);
4579     $this->callAPISuccess('contribution', 'repeattransaction', [
4580       'contribution_status_id' => 'Completed',
4581       'trxn_id' => 4567,
4582       'original_contribution_id' => $originalContribution,
4583     ]);
4584     $mut->checkMailLog([
4585       'From: ' . $domain['name'] . ' <' . $domain['domain_email'] . '>',
4586       'Contribution Information',
4587     ], [
4588       'Event',
4589     ]);
4590     $mut->stop();
4591   }
4592
4593   /**
4594    * Create a Contribution Page with is_email_receipt = TRUE.
4595    *
4596    * @param array $params
4597    *   Params to overwrite with.
4598    *
4599    * @return array|int
4600    */
4601   protected function createReceiptableContributionPage($params = []) {
4602     $contributionPage = $this->callAPISuccess('ContributionPage', 'create', array_merge([
4603       'receipt_from_name' => 'Mickey Mouse',
4604       'receipt_from_email' => 'mickey@mouse.com',
4605       'title' => 'Test Contribution Page',
4606       'financial_type_id' => 1,
4607       'currency' => 'CAD',
4608       'is_monetary' => TRUE,
4609       'is_email_receipt' => TRUE,
4610     ], $params));
4611     return $contributionPage;
4612   }
4613
4614   /**
4615    * function to test card_type and pan truncation.
4616    *
4617    * @throws \CRM_Core_Exception
4618    */
4619   public function testCardTypeAndPanTruncation() {
4620     $creditCardTypeIDs = array_flip(CRM_Financial_DAO_FinancialTrxn::buildOptions('card_type_id'));
4621     $contactId = $this->individualCreate();
4622     $params = [
4623       'contact_id' => $contactId,
4624       'receive_date' => '2016-01-20',
4625       'total_amount' => 100,
4626       'financial_type_id' => 1,
4627       'payment_instrument' => 'Credit Card',
4628       'card_type_id' => $creditCardTypeIDs['Visa'],
4629       'pan_truncation' => 4567,
4630     ];
4631     $contribution = $this->callAPISuccess('contribution', 'create', $params);
4632     $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contribution['id'], 'DESC');
4633     $financialTrxn = $this->callAPISuccessGetSingle(
4634       'FinancialTrxn',
4635       [
4636         'id' => $lastFinancialTrxnId['financialTrxnId'],
4637         'return' => ['card_type_id', 'pan_truncation'],
4638       ]
4639     );
4640     $this->assertEquals(CRM_Utils_Array::value('card_type_id', $financialTrxn), $creditCardTypeIDs['Visa']);
4641     $this->assertEquals(CRM_Utils_Array::value('pan_truncation', $financialTrxn), 4567);
4642     $params = [
4643       'id' => $contribution['id'],
4644       'pan_truncation' => 2345,
4645       'card_type_id' => $creditCardTypeIDs['Amex'],
4646     ];
4647     $this->callAPISuccess('contribution', 'create', $params);
4648     $financialTrxn = $this->callAPISuccessGetSingle(
4649       'FinancialTrxn',
4650       [
4651         'id' => $lastFinancialTrxnId['financialTrxnId'],
4652         'return' => ['card_type_id', 'pan_truncation'],
4653       ]
4654     );
4655     $this->assertEquals(CRM_Utils_Array::value('card_type_id', $financialTrxn), $creditCardTypeIDs['Amex']);
4656     $this->assertEquals(CRM_Utils_Array::value('pan_truncation', $financialTrxn), 2345);
4657   }
4658
4659   /**
4660    * Test repeat contribution uses non default currency
4661    *
4662    * @see https://issues.civicrm.org/jira/projects/CRM/issues/CRM-20678
4663    * @throws \CRM_Core_Exception
4664    */
4665   public function testRepeatTransactionWithDifferenceCurrency() {
4666     $originalContribution = $this->setUpRepeatTransaction(['currency' => 'AUD'], 'single', ['currency' => 'AUD']);
4667     $contribution = $this->callAPISuccess('Contribution', 'repeattransaction', [
4668       'original_contribution_id' => $originalContribution['id'],
4669       'contribution_status_id' => 'Completed',
4670       'trxn_id' => 3456,
4671     ]);
4672     $this->assertEquals('AUD', $contribution['values'][$contribution['id']]['currency']);
4673   }
4674
4675   /**
4676    * Get the financial items for the contribution.
4677    *
4678    * @param int $contributionID
4679    *
4680    * @return array
4681    *   Array of associated financial items.
4682    */
4683   protected function getFinancialTransactionsForContribution($contributionID) {
4684     $trxnParams = [
4685       'entity_id' => $contributionID,
4686       'entity_table' => 'civicrm_contribution',
4687     ];
4688     // @todo the following function has naming errors & has a weird signature & appears to
4689     // only be called from test classes. Move into test suite & maybe just use api
4690     // from this function.
4691     return array_merge(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($trxnParams));
4692   }
4693
4694   /**
4695    * Test getunique api call for Contribution entity
4696    */
4697   public function testContributionGetUnique() {
4698     $result = $this->callAPIAndDocument($this->entity, 'getunique', [], __FUNCTION__, __FILE__);
4699     $this->assertEquals(2, $result['count']);
4700     $this->assertEquals(['trxn_id'], $result['values']['UI_contrib_trxn_id']);
4701     $this->assertEquals(['invoice_id'], $result['values']['UI_contrib_invoice_id']);
4702   }
4703
4704   /**
4705    * Test Repeat Transaction Contribution with Tax amount.
4706    *
4707    * https://lab.civicrm.org/dev/core/issues/806
4708    *
4709    * @throws \CRM_Core_Exception
4710    */
4711   public function testRepeatContributionWithTaxAmount(): void {
4712     $this->enableTaxAndInvoicing();
4713     $financialType = $this->callAPISuccess('financial_type', 'create', [
4714       'name' => 'Test taxable financial Type',
4715       'is_reserved' => 0,
4716       'is_active' => 1,
4717     ]);
4718     $this->addTaxAccountToFinancialType($financialType['id']);
4719     $contribution = $this->setUpRepeatTransaction(
4720       [],
4721       'single',
4722       [
4723         'financial_type_id' => $financialType['id'],
4724       ]
4725     );
4726     $this->callAPISuccess('contribution', 'repeattransaction', [
4727       'original_contribution_id' => $contribution['id'],
4728       'contribution_status_id' => 'Completed',
4729       'trxn_id' => 'test',
4730     ]);
4731     $payments = $this->callAPISuccess('Contribution', 'get', ['sequential' => 1, 'return' => ['total_amount', 'tax_amount']])['values'];
4732     //Assert if first payment and repeated payment has the same contribution amount.
4733     $this->assertEquals($payments[0]['total_amount'], $payments[1]['total_amount']);
4734     $this->callAPISuccessGetCount('Contribution', [], 2);
4735
4736     //Assert line item records.
4737     $lineItems = $this->callAPISuccess('LineItem', 'get', ['sequential' => 1])['values'];
4738     foreach ($lineItems as $lineItem) {
4739       $taxExclusiveAmount = $payments[0]['total_amount'] - $payments[0]['tax_amount'];
4740       $this->assertEquals($lineItem['unit_price'], $taxExclusiveAmount);
4741       $this->assertEquals($lineItem['line_total'], $taxExclusiveAmount);
4742     }
4743     $this->callAPISuccessGetCount('Contribution', [], 2);
4744   }
4745
4746   public function testGetCurrencyOptions() {
4747     $result = $this->callAPISuccess('Contribution', 'getoptions', [
4748       'field' => 'currency',
4749     ]);
4750     $this->assertEquals('US Dollar', $result['values']['USD']);
4751     $this->assertNotContains('$', $result['values']);
4752     $result = $this->callAPISuccess('Contribution', 'getoptions', [
4753       'field' => 'currency',
4754       'context' => 'abbreviate',
4755     ]);
4756     $this->assertEquals('$', $result['values']['USD']);
4757     $this->assertNotContains('US Dollar', $result['values']);
4758   }
4759
4760   /**
4761    * @throws \API_Exception
4762    * @throws \CRM_Core_Exception
4763    * @throws \Civi\API\Exception\UnauthorizedException
4764    */
4765   public function testSetCustomDataInCreateAndHook() {
4766     $this->createCustomGroupWithFieldOfType([], 'int');
4767     $this->ids['CustomField']['text'] = (int) $this->createTextCustomField(['custom_group_id' => $this->ids['CustomGroup']['Custom Group']])['id'];
4768     $this->hookClass->setHook('civicrm_post', [
4769       $this,
4770       'civicrmPostContributionCustom',
4771     ]);
4772     $params = $this->_params;
4773     $params['custom_' . $this->ids['CustomField']['text']] = 'Some Text';
4774     $contribution = $this->callAPISuccess('Contribution', 'create', $params);
4775     $getContribution = $this->callAPISuccess('Contribution', 'get', [
4776       'id' => $contribution['id'],
4777       'return' => ['id', 'custom_' . $this->ids['CustomField']['text'], 'custom_' . $this->ids['CustomField']['int']],
4778     ]);
4779     $this->assertEquals(5, $getContribution['values'][$contribution['id']][$this->getCustomFieldName('int')]);
4780     $this->assertEquals('Some Text', $getContribution['values'][$contribution['id']]['custom_' . $this->ids['CustomField']['text']]);
4781     $this->callAPISuccess('CustomField', 'delete', ['id' => $this->ids['CustomField']['text']]);
4782     $this->callAPISuccess('CustomField', 'delete', ['id' => $this->ids['CustomField']['int']]);
4783     $this->callAPISuccess('CustomGroup', 'delete', ['id' => $this->ids['CustomGroup']['Custom Group']]);
4784   }
4785
4786   /**
4787    * Implement post hook.
4788    *
4789    * @param string $op
4790    * @param string $objectName
4791    * @param int|null $objectId
4792    *
4793    * @throws \CRM_Core_Exception
4794    */
4795   public function civicrmPostContributionCustom(string $op, string $objectName, ?int $objectId): void {
4796     if ($objectName === 'Contribution' && $op === 'create') {
4797       $this->callAPISuccess('Contribution', 'create', [
4798         'id' => $objectId,
4799         'custom_' . $this->ids['CustomField']['int'] => 5,
4800       ]);
4801     }
4802   }
4803
4804   /**
4805    * Test that passing in label for an option value linked to a custom field
4806    * works
4807    *
4808    * @see dev/core#1816
4809    *
4810    * @throws \API_Exception
4811    * @throws \CRM_Core_Exception
4812    */
4813   public function testCustomValueOptionLabelTest(): void {
4814     $this->createCustomGroupWithFieldOfType([], 'radio');
4815     $params = $this->_params;
4816     $params['custom_' . $this->ids['CustomField']['radio']] = 'Red Testing';
4817     $this->callAPISuccess('Contribution', 'Create', $params);
4818   }
4819
4820   /**
4821    * Test repeatTransaction with installments and next_sched_contribution_date
4822    *
4823    * @dataProvider getRepeatTransactionNextSchedData
4824    *
4825    * @param array $dataSet
4826    *
4827    * @throws \CRM_Core_Exception
4828    */
4829   public function testRepeatTransactionUpdateNextSchedContributionDate(array $dataSet): void {
4830     $paymentProcessorID = $this->paymentProcessorCreate();
4831     // Create the contribution before the recur so it doesn't trigger the update of next_sched_contribution_date
4832     $contribution = $this->callAPISuccess('contribution', 'create', array_merge(
4833         $this->_params,
4834         [
4835           'contribution_status_id' => 'Completed',
4836           'receive_date' => $dataSet['repeat'][0]['receive_date'],
4837         ])
4838     );
4839     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
4840       'contact_id' => $this->_individualId,
4841       'frequency_interval' => '1',
4842       'amount' => '500',
4843       'contribution_status_id' => 'Pending',
4844       'start_date' => '2012-01-01 00:00:00',
4845       'currency' => 'USD',
4846       'frequency_unit' => 'month',
4847       'payment_processor_id' => $paymentProcessorID,
4848     ], $dataSet['recur']));
4849     // Link the existing contribution to the recur *after* creating the recur.
4850     // If we just created the contribution now the next_sched_contribution_date would be automatically set
4851     //   and we want to test the case when it is empty.
4852     $this->callAPISuccess('contribution', 'create', [
4853       'id' => $contribution['id'],
4854       'contribution_recur_id' => $contributionRecur['id'],
4855     ]);
4856
4857     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
4858       'id' => $contributionRecur['id'],
4859       'return' => ['next_sched_contribution_date', 'contribution_status_id'],
4860     ]);
4861     // Check that next_sched_contribution_date is empty
4862     $this->assertEquals('', $contributionRecur['next_sched_contribution_date'] ?? '');
4863
4864     $this->callAPISuccess('Contribution', 'repeattransaction', [
4865       'contribution_status_id' => 'Completed',
4866       'contribution_recur_id' => $contributionRecur['id'],
4867       'receive_date' => $dataSet['repeat'][0]['receive_date'],
4868     ]);
4869     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
4870       'id' => $contributionRecur['id'],
4871       'return' => ['next_sched_contribution_date', 'contribution_status_id'],
4872     ]);
4873     // Check that recur has status "In Progress"
4874     $this->assertEquals(
4875       (string) CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', $dataSet['repeat'][0]['expectedRecurStatus']),
4876       $contributionRecur['contribution_status_id']
4877     );
4878     // Check that next_sched_contribution_date has been set to 1 period after the contribution receive date (ie. 1 month)
4879     $this->assertEquals($dataSet['repeat'][0]['expectedNextSched'], $contributionRecur['next_sched_contribution_date']);
4880
4881     // Now call Contribution.repeattransaction again and check that the next_sched_contribution_date has moved forward by 1 period again
4882     $this->callAPISuccess('Contribution', 'repeattransaction', [
4883       'contribution_status_id' => 'Completed',
4884       'contribution_recur_id' => $contributionRecur['id'],
4885       'receive_date' => $dataSet['repeat'][1]['receive_date'],
4886     ]);
4887     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
4888       'id' => $contributionRecur['id'],
4889       'return' => ['next_sched_contribution_date', 'contribution_status_id'],
4890     ]);
4891     // Check that recur has status "In Progress" or "Completed" depending on whether number of installments has been reached
4892     $this->assertEquals(
4893       (string) CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', $dataSet['repeat'][1]['expectedRecurStatus']),
4894       $contributionRecur['contribution_status_id']
4895     );
4896     // Check that next_sched_contribution_date has been set to 1 period after the contribution receive date (ie. 1 month)
4897     $this->assertEquals($dataSet['repeat'][1]['expectedNextSched'], $contributionRecur['next_sched_contribution_date'] ?? '');
4898   }
4899
4900   /**
4901    * Get dates for testing.
4902    *
4903    * @return array
4904    */
4905   public function getRepeatTransactionNextSchedData(): array {
4906     // Both these tests handle/test the case that next_sched_contribution_date is empty when Contribution.repeattransaction
4907     //   is called for the first time. Historically setting it was inconsistent but on new updates it should always be set.
4908     /*
4909      * This tests that calling Contribution.repeattransaction with installments does the following:
4910      * - For the first call to repeattransaction the recur status is In Progress and next_sched_contribution_date is updated
4911      *   to match next expected receive_date.
4912      * - Once the 3rd contribution is created contributionRecur status = completed and next_sched_contribution_date = ''.
4913      */
4914     $result['receive_date_includes_time_with_installments']['2012-01-01-1-month'] = [
4915       'recur' => [
4916         'start_date' => '2012-01-01',
4917         'frequency_interval' => 1,
4918         'installments' => '3',
4919         'frequency_unit' => 'month',
4920       ],
4921       'repeat' => [
4922         [
4923           'receive_date' => '2012-02-29 16:00:00',
4924           'expectedNextSched' => '2012-03-29 00:00:00',
4925           'expectedRecurStatus' => 'In Progress',
4926         ],
4927         [
4928           'receive_date' => '2012-03-29 16:00:00',
4929           'expectedNextSched' => '',
4930           'expectedRecurStatus' => 'Completed',
4931         ],
4932       ],
4933     ];
4934     /*
4935      * This tests that calling Contribution.repeattransaction with no installments does the following:
4936      * - For the each call to repeattransaction the recur status is In Progress and next_sched_contribution_date is updated
4937      *   to match next expected receive_date.
4938      */
4939     $result['receive_date_includes_time_no_installments']['2012-01-01-1-month'] = [
4940       'recur' => [
4941         'start_date' => '2012-01-01',
4942         'frequency_interval' => 1,
4943         'frequency_unit' => 'month',
4944       ],
4945       'repeat' => [
4946         [
4947           'receive_date' => '2012-02-29 16:00:00',
4948           'expectedNextSched' => '2012-03-29 00:00:00',
4949           'expectedRecurStatus' => 'In Progress',
4950         ],
4951         [
4952           'receive_date' => '2012-03-29 16:00:00',
4953           'expectedNextSched' => '2012-04-29 00:00:00',
4954           'expectedRecurStatus' => 'In Progress',
4955         ],
4956       ],
4957     ];
4958     return $result;
4959   }
4960
4961   /**
4962    * Make sure that recording a payment doesn't alter the receive_date of a
4963    * pending contribution.
4964    */
4965   public function testPaymentDontChangeReceiveDate(): void {
4966     $params = [
4967       'contact_id' => $this->_individualId,
4968       'total_amount' => 100,
4969       'receive_date' => '2020-02-02',
4970       'contribution_status_id' => 'Pending',
4971     ];
4972     $contributionID = $this->contributionCreate($params);
4973     $paymentParams = [
4974       'contribution_id' => $contributionID,
4975       'total_amount' => 100,
4976       'trxn_date' => '2020-03-04',
4977     ];
4978     $this->callAPISuccess('payment', 'create', $paymentParams);
4979
4980     //check if contribution status is set to "Completed".
4981     $contribution = $this->callAPISuccess('Contribution', 'getSingle', [
4982       'id' => $contributionID,
4983     ]);
4984     $this->assertEquals('2020-02-02 00:00:00', $contribution['receive_date']);
4985   }
4986
4987   /**
4988    * Make sure that recording a payment with Different Payment Instrument update main contribution record payment
4989    * instrument too. If multiple Payment Recorded, last payment record payment (when No more due) instrument set to main
4990    * payment
4991    */
4992   public function testPaymentVerifyPaymentInstrumentChange() {
4993     // Create Pending contribution with pay later mode, with payment instrument Check
4994     $params = [
4995       'contact_id' => $this->_individualId,
4996       'total_amount' => 100,
4997       'receive_date' => '2020-02-02',
4998       'contribution_status_id' => 'Pending',
4999       'is_pay_later' => 1,
5000       'payment_instrument_id' => 'Check',
5001     ];
5002     $contributionID = $this->contributionCreate($params);
5003
5004     // Record the the Payment with instrument other than Check, e.g EFT
5005     $paymentParams = [
5006       'contribution_id' => $contributionID,
5007       'total_amount' => 50,
5008       'trxn_date' => '2020-03-04',
5009       'payment_instrument_id' => 'EFT',
5010     ];
5011     $this->callAPISuccess('payment', 'create', $paymentParams);
5012
5013     $contribution = $this->callAPISuccess('Contribution', 'getSingle', [
5014       'id' => $contributionID,
5015     ]);
5016     // payment status should be 'Partially paid'
5017     $this->assertEquals('Partially paid', $contribution['contribution_status']);
5018
5019     // Record the the Payment with instrument other than Check, e.g Cash (pay all remaining amount)
5020     $paymentParams = [
5021       'contribution_id' => $contributionID,
5022       'total_amount' => 50,
5023       'trxn_date' => '2020-03-04',
5024       'payment_instrument_id' => 'Cash',
5025     ];
5026     $this->callAPISuccess('payment', 'create', $paymentParams);
5027
5028     //check if contribution Payment Instrument (Payment Method) is is set to "Cash".
5029     $contribution = $this->callAPISuccess('Contribution', 'getSingle', [
5030       'id' => $contributionID,
5031     ]);
5032     $this->assertEquals('Cash', $contribution['payment_instrument']);
5033     $this->assertEquals('Completed', $contribution['contribution_status']);
5034   }
5035
5036   /**
5037    * Test the "clean money" functionality.
5038    */
5039   public function testCleanMoney() {
5040     $params = [
5041       'contact_id' => $this->_individualId,
5042       'financial_type_id' => 1,
5043       'total_amount' => '$100',
5044       'fee_amount' => '$20',
5045       'net_amount' => '$80',
5046       'non_deductible_amount' => '$80',
5047       'sequential' => 1,
5048     ];
5049     $id = $this->callAPISuccess('Contribution', 'create', $params)['id'];
5050     // Reading the return values of the API isn't reliable here; get the data from the db.
5051     $contribution = $this->callAPISuccess('Contribution', 'getsingle', ['id' => $id]);
5052     $this->assertEquals('100.00', $contribution['total_amount']);
5053     $this->assertEquals('20.00', $contribution['fee_amount']);
5054     $this->assertEquals('80.00', $contribution['net_amount']);
5055     $this->assertEquals('80.00', $contribution['non_deductible_amount']);
5056   }
5057
5058   /**
5059    * Create a price set with a quick config price set.
5060    *
5061    * The params to use this look like
5062    *
5063    * ['price_' . $this->ids['PriceField']['basic'] => $this->ids['PriceFieldValue']['basic']]
5064    *
5065    * @param array $contributionPageParams
5066    *
5067    * @return int
5068    *
5069    * @throws \API_Exception
5070    * @throws \CRM_Core_Exception
5071    * @throws \Civi\API\Exception\UnauthorizedException
5072    */
5073   private function createQuickConfigContributionPage(array $contributionPageParams = []): int {
5074     $contributionPageID = $this->callAPISuccess('ContributionPage', 'create', array_merge([
5075       'receipt_from_name' => 'Mickey Mouse',
5076       'receipt_from_email' => 'mickey@mouse.com',
5077       'title' => 'Test Contribution Page',
5078       'financial_type_id' => 'Member Dues',
5079       'currency' => 'CAD',
5080       'is_pay_later' => 1,
5081       'is_quick_config' => TRUE,
5082       'pay_later_text' => 'I will send payment by check',
5083       'pay_later_receipt' => 'This is a pay later receipt',
5084       'is_allow_other_amount' => 1,
5085       'min_amount' => 10.00,
5086       'max_amount' => 10000.00,
5087       'goal_amount' => 100000.00,
5088       'is_email_receipt' => 1,
5089       'is_active' => 1,
5090       'amount_block_is_active' => 1,
5091       'is_billing_required' => 0,
5092     ], $contributionPageParams))['id'];
5093
5094     $priceSetID = PriceSet::create()->setValues([
5095       'name' => 'quick config set',
5096       'title' => 'basic price set',
5097       'is_quick_config' => TRUE,
5098       'extends' => 2,
5099     ])->execute()->first()['id'];
5100
5101     $priceFieldID = PriceField::create()->setValues([
5102       'price_set_id' => $priceSetID,
5103       'name' => 'quick config field name',
5104       'label' => 'quick config field name',
5105       'html_type' => 'Radio',
5106     ])->execute()->first()['id'];
5107     $this->ids['PriceSet']['basic'] = $priceSetID;
5108     $this->ids['PriceField']['basic'] = $priceFieldID;
5109     $this->ids['PriceFieldValue']['basic'] = PriceFieldValue::create()->setValues([
5110       'price_field_id' => $priceFieldID,
5111       'name' => 'quick config price field',
5112       'label' => 'quick config price field',
5113       'amount' => 100,
5114       'financial_type_id:name' => 'Member Dues',
5115     ])->execute()->first()['id'];
5116     CRM_Price_BAO_PriceSet::addTo('civicrm_contribution_page', $contributionPageID, $priceSetID);
5117     return $contributionPageID;
5118   }
5119
5120   /**
5121    * Get the created contribution ID.
5122    *
5123    * @param string $key
5124    *
5125    * @return int
5126    */
5127   protected function getContributionID(string $key = 'first'): int {
5128     return (int) $this->ids['contribution'][$key];
5129   }
5130
5131   /**
5132    * Get the created contribution ID.
5133    *
5134    * @return int
5135    */
5136   protected function getMembershipID(): int {
5137     return (int) $this->_ids['membership'];
5138   }
5139
5140   /**
5141    * Create a paid membership for renewal tests.
5142    */
5143   protected function createSubsequentPendingMembership(): void {
5144     $this->setUpPendingContribution($this->_ids['price_field_value'][1], 'second', [], [], [
5145       'id' => $this->getMembershipID(),
5146     ]);
5147   }
5148
5149   /**
5150    * Create a paid membership for renewal tests.
5151    */
5152   protected function createInitialPaidMembership(): void {
5153     $this->setUpPendingContribution($this->_ids['price_field_value'][1]);
5154     $this->callAPISuccess('Payment', 'create', [
5155       'contribution_id' => $this->getContributionID(),
5156       'total_amount' => 20,
5157     ]);
5158   }
5159
5160 }