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() {
2056     $mut = new CiviMailUtils($this, TRUE);
2057     $this->swapMessageTemplateForTestTemplate();
2058     $this->createLoggedInUser();
2059     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2060     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2061     $this->callAPISuccess('contribution', 'completetransaction', [
2062       'id' => $contribution['id'],
2063     ]);
2064     $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id']]);
2065     $this->assertEquals('SSF', $contribution['contribution_source']);
2066     $this->assertEquals('Completed', $contribution['contribution_status']);
2067     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receipt_date'])));
2068     $mut->checkMailLog([
2069       'email:::anthony_anderson@civicrm.org',
2070       'is_monetary:::1',
2071       'amount:::100.00',
2072       'currency:::USD',
2073       'receive_date:::' . date('Ymd', strtotime($contribution['receive_date'])),
2074       "receipt_date:::\n",
2075       'title:::Contribution',
2076       'contributionStatus:::Completed',
2077     ]);
2078     $mut->stop();
2079     $this->revertTemplateToReservedTemplate();
2080   }
2081
2082   /**
2083    * Test completing a transaction via the API with a non-USD transaction.
2084    */
2085   public function testCompleteTransactionEuro() {
2086     $mut = new CiviMailUtils($this, TRUE);
2087     $this->swapMessageTemplateForTestTemplate();
2088     $this->createLoggedInUser();
2089     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'currency' => 'EUR']);
2090     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2091
2092     $this->callAPISuccess('contribution', 'completetransaction', [
2093       'id' => $contribution['id'],
2094     ]);
2095
2096     $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id']]);
2097     $this->assertEquals('SSF', $contribution['contribution_source']);
2098     $this->assertEquals('Completed', $contribution['contribution_status']);
2099     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receipt_date'])));
2100
2101     $entityFinancialTransactions = $this->getFinancialTransactionsForContribution($contribution['id']);
2102     $entityFinancialTransaction = reset($entityFinancialTransactions);
2103     $financialTrxn = $this->callAPISuccessGetSingle('FinancialTrxn', ['id' => $entityFinancialTransaction['financial_trxn_id']]);
2104     $this->assertEquals('EUR', $financialTrxn['currency']);
2105
2106     $mut->checkMailLog([
2107       'email:::anthony_anderson@civicrm.org',
2108       'is_monetary:::1',
2109       'amount:::100.00',
2110       'currency:::EUR',
2111       'receive_date:::' . date('Ymd', strtotime($contribution['receive_date'])),
2112       "receipt_date:::\n",
2113       'title:::Contribution',
2114       'contributionStatus:::Completed',
2115     ]);
2116     $mut->stop();
2117     $this->revertTemplateToReservedTemplate();
2118   }
2119
2120   /**
2121    * Test to ensure mail is sent for pay later
2122    *
2123    * @throws \CRM_Core_Exception
2124    * @throws \API_Exception
2125    */
2126   public function testPayLater(): void {
2127     $mut = new CiviMailUtils($this, TRUE);
2128     $this->swapMessageTemplateForTestTemplate();
2129     $this->createLoggedInUser();
2130     $contributionPageID = $this->createQuickConfigContributionPage();
2131
2132     $params = [
2133       'id' => $contributionPageID,
2134       'price_' . $this->ids['PriceField']['basic'] => $this->ids['PriceFieldValue']['basic'],
2135       'contact_id' => $this->_individualId,
2136       'email-5' => 'anthony_anderson@civicrm.org',
2137       'payment_processor_id' => 0,
2138       'currencyID' => 'USD',
2139       'is_pay_later' => 1,
2140       'invoiceID' => 'f28e1ddc86f8c4a0ff5bcf46393e4bc8',
2141       'description' => 'Online Contribution: Help Support CiviCRM!',
2142     ];
2143     $this->callAPISuccess('ContributionPage', 'submit', $params);
2144
2145     $mut->checkMailLog([
2146       'is_pay_later:::1',
2147       'email:::anthony_anderson@civicrm.org',
2148       'pay_later_receipt:::This is a pay later receipt',
2149       'contributionPageId:::' . $contributionPageID,
2150       'title:::Test Contribution Page',
2151       'amount:::100',
2152     ]);
2153     $mut->stop();
2154     $this->revertTemplateToReservedTemplate();
2155   }
2156
2157   /**
2158    * Test to check whether contact billing address is used when no contribution address
2159    */
2160   public function testBillingAddress() {
2161     $mut = new CiviMailUtils($this, TRUE);
2162     $this->swapMessageTemplateForTestTemplate();
2163     $this->createLoggedInUser();
2164
2165     //Scenario 1: When Contact don't have any address
2166     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2167     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2168     $this->callAPISuccess('contribution', 'completetransaction', [
2169       'id' => $contribution['id'],
2170     ]);
2171     $mut->checkMailLog([
2172       'address:::',
2173     ]);
2174
2175     // Scenario 2: Contribution using address
2176     $address = $this->callAPISuccess('address', 'create', [
2177       'street_address' => 'contribution billing st',
2178       'location_type_id' => 2,
2179       'contact_id' => $this->_params['contact_id'],
2180     ]);
2181     $params = array_merge($this->_params, [
2182       'contribution_status_id' => 2,
2183       'address_id' => $address['id'],
2184     ]
2185     );
2186     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2187     $this->callAPISuccess('contribution', 'completetransaction', [
2188       'id' => $contribution['id'],
2189     ]);
2190     $mut->checkMailLog([
2191       'address:::contribution billing st',
2192     ]);
2193
2194     // Scenario 3: Contribution wtth no address but contact has a billing address
2195     $this->callAPISuccess('address', 'create', [
2196       'id' => $address['id'],
2197       'street_address' => 'is billing st',
2198       'contact_id' => $this->_params['contact_id'],
2199     ]);
2200     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2201     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2202     $this->callAPISuccess('contribution', 'completetransaction', [
2203       'id' => $contribution['id'],
2204     ]);
2205     $mut->checkMailLog([
2206       'address:::is billing st',
2207     ]);
2208
2209     $mut->stop();
2210     $this->revertTemplateToReservedTemplate();
2211   }
2212
2213   /**
2214    * Test completing a transaction via the API.
2215    *
2216    * Note that we are creating a logged in user because email goes out from
2217    * that person
2218    */
2219   public function testCompleteTransactionFeeAmount() {
2220     $this->createLoggedInUser();
2221     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2222     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2223     $this->callAPISuccess('contribution', 'completetransaction', [
2224       'id' => $contribution['id'],
2225       'fee_amount' => '.56',
2226       'trxn_id' => '7778888',
2227     ]);
2228     $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id'], 'sequential' => 1]);
2229     $this->assertEquals('Completed', $contribution['contribution_status']);
2230     $this->assertEquals('7778888', $contribution['trxn_id']);
2231     $this->assertEquals('0.56', $contribution['fee_amount']);
2232     $this->assertEquals('99.44', $contribution['net_amount']);
2233   }
2234
2235   /**
2236    * CRM-19126 Add test to verify when complete transaction is called tax
2237    * amount is not changed.
2238    *
2239    * We start of with a pending contribution.
2240    *  - total_amount (input) = 100
2241    *  - total_amount post save (based on tax being added) = 105
2242    *  - net_amount = 95
2243    *  - fee_amount = 5
2244    *  - non_deductible_amount = 10
2245    *  - tax rate = 5%
2246    *  - tax_amount = 5
2247    *  - sum of (calculated) line items = 105
2248    *
2249    * Note the fee_amount should really be set when the payment is received
2250    * and whatever the non_deductible amount is, it is ignored.
2251    *
2252    * The fee amount when the payment comes in is 6 rather than 5. The net_amount
2253    * and fee_amount should change, but not the total_amount or
2254    * the line items.
2255    *
2256    * @param string $thousandSeparator
2257    *   punctuation used to refer to thousands.
2258    *
2259    * @throws \API_Exception
2260    * @throws \CRM_Core_Exception
2261    * @dataProvider getThousandSeparators
2262    */
2263   public function testCheckTaxAmount(string $thousandSeparator): void {
2264     $this->setCurrencySeparators($thousandSeparator);
2265     $this->createFinancialTypeWithSalesTax();
2266     $financialTypeId = $this->ids['FinancialType']['taxable'];
2267
2268     $contributionID = $this->callAPISuccess('Order', 'create',
2269       array_merge($this->_params, ['financial_type_id' => $financialTypeId])
2270     )['id'];
2271     $contributionPrePayment = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID, 'return' => ['tax_amount', 'total_amount']]);
2272     $this->validateAllContributions();
2273     $this->callAPISuccess('Contribution', 'completetransaction', [
2274       'id' => $contributionID,
2275       'trxn_id' => '777788888',
2276       'fee_amount' => '6.00',
2277       'sequential' => 1,
2278     ]);
2279     $contributionPostPayment = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID, 'return' => ['tax_amount', 'fee_amount', 'net_amount']]);
2280     $this->assertEquals(4.76, $contributionPrePayment['tax_amount']);
2281     $this->assertEquals(4.76, $contributionPostPayment['tax_amount']);
2282     $this->assertEquals('6.00', $contributionPostPayment['fee_amount']);
2283     $this->assertEquals('94.00', $contributionPostPayment['net_amount']);
2284     $this->validateAllContributions();
2285     $this->validateAllPayments();
2286   }
2287
2288   /**
2289    * Test repeat contribution successfully creates line item.
2290    *
2291    * @throws \CRM_Core_Exception
2292    */
2293   public function testRepeatTransaction(): void {
2294     $originalContribution = $this->setUpRepeatTransaction([], 'single');
2295     $this->callAPISuccess('contribution', 'repeattransaction', [
2296       'original_contribution_id' => $originalContribution['id'],
2297       'contribution_status_id' => 'Completed',
2298       'trxn_id' => 4567,
2299     ]);
2300     $lineItemParams = [
2301       'entity_id' => $originalContribution['id'],
2302       'sequential' => 1,
2303       'return' => [
2304         'entity_table',
2305         'qty',
2306         'unit_price',
2307         'line_total',
2308         'label',
2309         'financial_type_id',
2310         'deductible_amount',
2311         'price_field_value_id',
2312         'price_field_id',
2313       ],
2314     ];
2315     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2316       'entity_id' => $originalContribution['id'],
2317     ]));
2318     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2319       'entity_id' => $originalContribution['id'] + 1,
2320     ]));
2321     unset($lineItem1['values'][0]['id'], $lineItem1['values'][0]['entity_id']);
2322     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2323     $this->assertEquals($lineItem1['values'][0], $lineItem2['values'][0]);
2324     $this->_checkFinancialRecords([
2325       'id' => $originalContribution['id'] + 1,
2326       'payment_instrument_id' => $this->callAPISuccessGetValue('PaymentProcessor', [
2327         'id' => $originalContribution['payment_processor_id'],
2328         'return' => 'payment_instrument_id',
2329       ]),
2330     ], 'online');
2331   }
2332
2333   /**
2334    * Test custom data is copied over from the template transaction.
2335    *
2336    * (Over time various discussions have deemed this to be the most recent one, allowing
2337    * users to alter custom data going forwards. This is implemented for line items already.
2338    *
2339    * @throws \API_Exception
2340    * @throws \CRM_Core_Exception
2341    */
2342   public function testRepeatTransactionWithCustomData(): void {
2343     $this->createCustomGroupWithFieldOfType(['extends' => 'Contribution', 'name' => 'Repeat'], 'text');
2344     $originalContribution = $this->setUpRepeatTransaction([], 'single', [$this->getCustomFieldName('text') => 'first']);
2345     $this->callAPISuccess('contribution', 'repeattransaction', [
2346       'contribution_recur_id' => $originalContribution['contribution_recur_id'],
2347       'contribution_status_id' => 'Completed',
2348       'trxn_id' => 'my_trxn',
2349     ]);
2350
2351     $contribution = Contribution::get()
2352       ->addWhere('trxn_id', '=', 'my_trxn')
2353       ->addSelect('Custom_Group.Enter_text_here')
2354       ->addSelect('id')
2355       ->execute()->first();
2356     $this->assertEquals('first', $contribution['Custom_Group.Enter_text_here']);
2357
2358     Contribution::update()->setValues(['Custom_Group.Enter_text_here' => 'second'])->addWhere('id', '=', $contribution['id'])->execute();
2359
2360     $this->callAPISuccess('contribution', 'repeattransaction', [
2361       'original_contribution_id' => $originalContribution['id'],
2362       'contribution_status_id' => 'Completed',
2363       'trxn_id' => 'number_3',
2364     ]);
2365
2366     $contribution = Contribution::get()
2367       ->addWhere('trxn_id', '=', 'number_3')
2368       ->setSelect(['id', 'Custom_Group.Enter_text_here'])
2369       ->execute()->first();
2370     $this->assertEquals('second', $contribution['Custom_Group.Enter_text_here']);
2371   }
2372
2373   /**
2374    * Test repeat contribution successfully creates line items (plural).
2375    *
2376    * @throws \CRM_Core_Exception
2377    */
2378   public function testRepeatTransactionLineItems(): void {
2379     // CRM-19309
2380     $originalContribution = $this->setUpRepeatTransaction([], 'multiple');
2381     $this->callAPISuccess('contribution', 'repeattransaction', [
2382       'original_contribution_id' => $originalContribution['id'],
2383       'contribution_status_id' => 'Completed',
2384       'trxn_id' => 1234,
2385     ]);
2386
2387     $lineItemParams = [
2388       'entity_id' => $originalContribution['id'],
2389       'sequential' => 1,
2390       'return' => [
2391         'entity_table',
2392         'qty',
2393         'unit_price',
2394         'line_total',
2395         'label',
2396         'financial_type_id',
2397         'deductible_amount',
2398         'price_field_value_id',
2399         'price_field_id',
2400       ],
2401     ];
2402     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2403       'entity_id' => $originalContribution['id'],
2404       'options' => ['sort' => 'qty'],
2405     ]))['values'];
2406     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2407       'entity_id' => $originalContribution['id'] + 1,
2408       'options' => ['sort' => 'qty'],
2409     ]))['values'];
2410
2411     // unset id and entity_id for all of them to be able to compare the lineItems:
2412     unset($lineItem1[0]['id'], $lineItem1[0]['entity_id']);
2413     unset($lineItem2[0]['id'], $lineItem2[0]['entity_id']);
2414     $this->assertEquals($lineItem1[0], $lineItem2[0]);
2415
2416     unset($lineItem1[1]['id'], $lineItem1[1]['entity_id']);
2417     unset($lineItem2[1]['id'], $lineItem2[1]['entity_id']);
2418     $this->assertEquals($lineItem1[1], $lineItem2[1]);
2419
2420     // CRM-19309 so in future we also want to:
2421     // check that financial_line_items have been created for entity_id 3 and 4;
2422
2423     $this->callAPISuccessGetCount('FinancialItem', ['description' => 'Sales Tax', 'amount' => 0], 0);
2424   }
2425
2426   /**
2427    * Test repeat contribution successfully creates is_test transaction.
2428    *
2429    * @throws \CRM_Core_Exception
2430    */
2431   public function testRepeatTransactionIsTest(): void {
2432     $this->_params['is_test'] = 1;
2433     $originalContribution = $this->setUpRepeatTransaction(['is_test' => 1], 'single');
2434
2435     $this->callAPISuccess('contribution', 'repeattransaction', [
2436       'original_contribution_id' => $originalContribution['id'],
2437       'contribution_status_id' => 'Completed',
2438       'trxn_id' => '1234',
2439     ]);
2440     $this->callAPISuccessGetCount('Contribution', ['contribution_test' => 1], 2);
2441   }
2442
2443   /**
2444    * Test repeat contribution passed in status.
2445    *
2446    * @throws \CRM_Core_Exception
2447    */
2448   public function testRepeatTransactionPassedInStatus(): void {
2449     $originalContribution = $this->setUpRepeatTransaction([], 'single');
2450
2451     $this->callAPISuccess('contribution', 'repeattransaction', [
2452       'original_contribution_id' => $originalContribution['id'],
2453       'contribution_status_id' => 'Pending',
2454       'trxn_id' => 1234,
2455     ]);
2456     $this->callAPISuccessGetCount('Contribution', ['contribution_status_id' => 2], 1);
2457   }
2458
2459   /**
2460    * Test repeat contribution accepts recur_id instead of
2461    * original_contribution_id.
2462    *
2463    * @throws \CRM_Core_Exception
2464    */
2465   public function testRepeatTransactionAcceptRecurID(): void {
2466     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2467       'contact_id' => $this->_individualId,
2468       'installments' => '12',
2469       'frequency_interval' => '1',
2470       'amount' => '100',
2471       'contribution_status_id' => 1,
2472       'start_date' => '2012-01-01 00:00:00',
2473       'currency' => 'USD',
2474       'frequency_unit' => 'month',
2475       'payment_processor_id' => $this->paymentProcessorID,
2476     ]);
2477     $this->callAPISuccess('contribution', 'create', array_merge(
2478         $this->_params,
2479         ['contribution_recur_id' => $contributionRecur['id']])
2480     );
2481
2482     $this->callAPISuccess('contribution', 'repeattransaction', [
2483       'contribution_recur_id' => $contributionRecur['id'],
2484       'contribution_status_id' => 'Completed',
2485       'trxn_id' => 1234,
2486     ]);
2487
2488   }
2489
2490   /**
2491    * CRM-19873 Test repeattransaction if contribution_recur_id is a test.
2492    *
2493    * @throws \CRM_Core_Exception
2494    */
2495   public function testRepeatTransactionTestRecurId() {
2496     $contributionRecur = $this->callAPISuccess('ContributionRecur', 'create', [
2497       'contact_id' => $this->_individualId,
2498       'frequency_interval' => '1',
2499       'amount' => '1.00',
2500       'contribution_status_id' => 1,
2501       'start_date' => '2017-01-01 00:00:00',
2502       'currency' => 'USD',
2503       'frequency_unit' => 'month',
2504       'payment_processor_id' => $this->paymentProcessorID,
2505       'is_test' => 1,
2506     ]);
2507     $this->callAPISuccess('contribution', 'create', array_merge(
2508         $this->_params,
2509         [
2510           'contribution_recur_id' => $contributionRecur['id'],
2511           'is_test' => 1,
2512         ])
2513     );
2514
2515     $repeatedContribution = $this->callAPISuccess('contribution', 'repeattransaction', [
2516       'contribution_recur_id' => $contributionRecur['id'],
2517       'contribution_status_id' => 'Completed',
2518       'trxn_id' => 'magic_number',
2519     ]);
2520
2521     $this->assertEquals($contributionRecur['values'][1]['is_test'], $repeatedContribution['values'][2]['is_test']);
2522   }
2523
2524   /**
2525    * CRM-19945 Tests that Contribute.repeattransaction renews a membership when contribution status=Completed
2526    *
2527    * @throws \CRM_Core_Exception
2528    */
2529   public function testRepeatTransactionMembershipRenewCompletedContribution(): void {
2530     [$originalContribution, $membership] = $this->setUpAutoRenewMembership();
2531
2532     $this->callAPISuccess('Contribution', 'repeattransaction', [
2533       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2534       'contribution_status_id' => 'Failed',
2535     ]);
2536
2537     $this->callAPISuccess('membership', 'create', [
2538       'id' => $membership['id'],
2539       'end_date' => 'yesterday',
2540       'status_id' => 'Expired',
2541     ]);
2542
2543     $contribution = $this->callAPISuccess('Contribution', 'repeattransaction', [
2544       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2545       'contribution_status_id' => 'Completed',
2546       'trxn_id' => 'bobsled',
2547     ]);
2548
2549     $membershipStatusId = $this->callAPISuccess('membership', 'getvalue', [
2550       'id' => $membership['id'],
2551       'return' => 'status_id',
2552     ]);
2553
2554     $membership = $this->callAPISuccess('membership', 'get', [
2555       'id' => $membership['id'],
2556     ]);
2557
2558     $this->assertEquals('New', CRM_Core_PseudoConstant::getName('CRM_Member_BAO_Membership', 'status_id', $membershipStatusId));
2559
2560     $lineItem = $this->callAPISuccessGetSingle('LineItem', ['contribution_id' => $contribution['id']]);
2561     $this->assertEquals('civicrm_membership', $lineItem['entity_table']);
2562     $this->callAPISuccessGetCount('MembershipPayment', ['membership_id' => $membership['id']]);
2563   }
2564
2565   /**
2566    * This is one of those tests that locks in existing behaviour.
2567    *
2568    * I feel like correct behaviour is arguable & has been discussed in the past. However, if the membership has
2569    * a date which says it should be expired then the result of repeattransaction is to push that date
2570    * to be one membership term from 'now' with status 'new'.
2571    */
2572   public function testRepeattransactionRenewMembershipOldMembership() {
2573     $entities = $this->setUpAutoRenewMembership();
2574     $newStatusID = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'New');
2575     $membership = $this->callAPISuccess('Membership', 'create', [
2576       'id' => $entities[1]['id'],
2577       'join_date' => '4 months ago',
2578       'start_date' => '3 months ago',
2579       'end_date' => '2 months ago',
2580     ]);
2581     $membership = $membership['values'][$membership['id']];
2582
2583     // This status does not appear to be calculated at all and is set to 'new'. Feels like a bug.
2584     $this->assertEquals($newStatusID, $membership['status_id']);
2585
2586     // So it seems renewing this expired membership results in it's new status being current and it being pushed to a future date
2587     $this->callAPISuccess('Contribution', 'repeattransaction', ['original_contribution_id' => $entities[0]['id'], 'contribution_status_id' => 'Completed']);
2588     $membership = $this->callAPISuccessGetSingle('Membership', ['id' => $membership['id']]);
2589     // If this date calculation winds up being flakey the spirit of the test would be maintained by just checking
2590     // date is greater than today.
2591     $this->assertEquals(date('Y-m-d', strtotime('+ 1 month -1 day')), $membership['end_date']);
2592     $this->assertEquals($newStatusID, $membership['membership_type_id']);
2593   }
2594
2595   /**
2596    * CRM-19945 Tests that Contribute.repeattransaction DOES NOT renew a membership when contribution status=Failed
2597    *
2598    * @dataProvider contributionStatusProvider
2599    *
2600    * @throws \CRM_Core_Exception
2601    */
2602   public function testRepeatTransactionMembershipRenewContributionNotCompleted($contributionStatus): void {
2603     // Completed status should renew so we don't test that here
2604     // In Progress status was never actually intended to be available for contributions.
2605     // Partially paid is not valid.
2606     if (in_array($contributionStatus['name'], ['Completed', 'In Progress', 'Partially paid'])) {
2607       return;
2608     }
2609     [$originalContribution, $membership] = $this->setUpAutoRenewMembership();
2610
2611     $this->callAPISuccess('Contribution', 'repeattransaction', [
2612       'original_contribution_id' => $originalContribution['id'],
2613       'contribution_status_id' => 'Completed',
2614     ]);
2615
2616     $this->callAPISuccess('membership', 'create', [
2617       'id' => $membership['id'],
2618       'end_date' => 'yesterday',
2619       'status_id' => 'Expired',
2620     ]);
2621
2622     $contribution = $this->callAPISuccess('contribution', 'repeattransaction', [
2623       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2624       'contribution_status_id' => $contributionStatus['name'],
2625       'trxn_id' => 'bobsled',
2626     ]);
2627
2628     $updatedMembership = $this->callAPISuccess('membership', 'getsingle', ['id' => $membership['id']]);
2629
2630     $dateTime = new DateTime('yesterday');
2631     $this->assertEquals($dateTime->format('Y-m-d'), $updatedMembership['end_date']);
2632     $this->assertEquals(CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Expired'), $updatedMembership['status_id']);
2633
2634     $lineItem = $this->callAPISuccessGetSingle('LineItem', ['contribution_id' => $contribution['id']]);
2635     $this->assertEquals('civicrm_membership', $lineItem['entity_table']);
2636     $this->callAPISuccessGetCount('MembershipPayment', ['membership_id' => $membership['id']]);
2637   }
2638
2639   /**
2640    * Dataprovider provides contribution status as [optionvalue=>contribution_status_name]
2641    * FIXME: buildOptions seems to die in CRM_Core_Config::_construct when in test mode.
2642    *
2643    * @return array
2644    * @throws \CiviCRM_API3_Exception
2645    */
2646   public function contributionStatusProvider() {
2647     $contributionStatuses = civicrm_api3('OptionValue', 'get', [
2648       'return' => ["id", "name"],
2649       'option_group_id' => "contribution_status",
2650     ]);
2651     foreach ($contributionStatuses['values'] as $statusName) {
2652       $statuses[] = [$statusName];
2653     }
2654     return $statuses;
2655   }
2656
2657   /**
2658    * CRM-16397 test appropriate action if total amount has changed for single
2659    * line items.
2660    *
2661    * @throws \CRM_Core_Exception
2662    */
2663   public function testRepeatTransactionAlteredAmount(): void {
2664     $paymentProcessorID = $this->paymentProcessorCreate();
2665     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2666       'contact_id' => $this->_individualId,
2667       'installments' => '12',
2668       'frequency_interval' => '1',
2669       'amount' => '500',
2670       'contribution_status_id' => 1,
2671       'start_date' => '2012-01-01 00:00:00',
2672       'currency' => 'USD',
2673       'frequency_unit' => 'month',
2674       'payment_processor_id' => $paymentProcessorID,
2675     ]);
2676     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2677         $this->_params,
2678         [
2679           'contribution_recur_id' => $contributionRecur['id'],
2680         ])
2681     );
2682
2683     $this->callAPISuccess('contribution', 'repeattransaction', [
2684       'original_contribution_id' => $originalContribution['id'],
2685       'contribution_status_id' => 'Completed',
2686       'trxn_id' => 1234,
2687       'total_amount' => '400',
2688       'fee_amount' => 50,
2689     ]);
2690
2691     $lineItemParams = [
2692       'entity_id' => $originalContribution['id'],
2693       'sequential' => 1,
2694       'return' => [
2695         'entity_table',
2696         'qty',
2697         'unit_price',
2698         'line_total',
2699         'label',
2700         'financial_type_id',
2701         'deductible_amount',
2702         'price_field_value_id',
2703         'price_field_id',
2704       ],
2705     ];
2706     $this->callAPISuccessGetSingle('contribution', [
2707       'total_amount' => 400,
2708       'fee_amount' => 50,
2709       'net_amount' => 350,
2710     ]);
2711     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2712       'entity_id' => $originalContribution['id'],
2713     ]));
2714     $expectedLineItem = array_merge(
2715       $lineItem1['values'][0], [
2716         'line_total' => '400.00',
2717         'unit_price' => '400.00',
2718       ]
2719     );
2720
2721     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2722       'entity_id' => $originalContribution['id'] + 1,
2723     ]));
2724
2725     unset($expectedLineItem['id'], $expectedLineItem['entity_id'], $lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2726     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2727   }
2728
2729   /**
2730    * Test financial_type_id override behaviour with a single line item.
2731    *
2732    * CRM-17718 a passed in financial_type_id is allowed to override the
2733    * original contribution where there is only one line item.
2734    *
2735    * @throws \CRM_Core_Exception
2736    */
2737   public function testRepeatTransactionPassedInFinancialType() {
2738     $originalContribution = $this->setUpRecurringContribution();
2739
2740     $this->callAPISuccess('Contribution', 'repeattransaction', [
2741       'original_contribution_id' => $originalContribution['id'],
2742       'contribution_status_id' => 'Completed',
2743       'trxn_id' => 12345,
2744       'financial_type_id' => 2,
2745     ]);
2746     $lineItemParams = [
2747       'entity_id' => $originalContribution['id'],
2748       'sequential' => 1,
2749       'return' => [
2750         'entity_table',
2751         'qty',
2752         'unit_price',
2753         'line_total',
2754         'label',
2755         'financial_type_id',
2756         'deductible_amount',
2757         'price_field_value_id',
2758         'price_field_id',
2759       ],
2760     ];
2761
2762     $this->callAPISuccessGetSingle('Contribution', [
2763       'total_amount' => 100,
2764       'financial_type_id' => 2,
2765     ]);
2766     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2767       'entity_id' => $originalContribution['id'],
2768     ]));
2769     $expectedLineItem = array_merge(
2770       $lineItem1['values'][0], [
2771         'line_total' => '100.00',
2772         'unit_price' => '100.00',
2773         'financial_type_id' => 2,
2774         'contribution_type_id' => 2,
2775       ]
2776     );
2777     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2778       'entity_id' => $originalContribution['id'] + 1,
2779     ]));
2780     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
2781     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2782     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2783   }
2784
2785   /**
2786    * Test Contribution with Order api.
2787    *
2788    * @throws \CRM_Core_Exception|\CiviCRM_API3_Exception
2789    */
2790   public function testContributionOrder() {
2791     $this->createContributionAndMembershipOrder();
2792     $contribution = $this->callAPISuccess('contribution', 'get')['values'][$this->ids['Contribution'][0]];
2793     $this->assertEquals('Pending Label**', $contribution['contribution_status']);
2794     $membership = $this->callAPISuccessGetSingle('Membership', ['contact_id' => $this->ids['Contact']['order']]);
2795
2796     $this->callAPISuccess('Payment', 'create', [
2797       'contribution_id' => $this->ids['Contribution'][0],
2798       'payment_instrument_id' => 'Check',
2799       'total_amount' => 300,
2800     ]);
2801     $contribution = $this->callAPISuccess('contribution', 'get')['values'][$this->ids['Contribution'][0]];
2802     $this->assertEquals('Completed', $contribution['contribution_status']);
2803
2804     $lineItem = $this->callAPISuccess('LineItem', 'get', [
2805       'sequential' => 1,
2806       'contribution_id' => $this->ids['Contribution'][0],
2807     ])['values'];
2808     $this->assertCount(2, $lineItem);
2809     $this->assertEquals($this->ids['Contribution'][0], $lineItem[0]['entity_id']);
2810     $this->assertEquals('civicrm_contribution', $lineItem[0]['entity_table']);
2811     $this->assertEquals($this->ids['Contribution'][0], $lineItem[0]['contribution_id']);
2812     $this->assertEquals($this->ids['Contribution'][0], $lineItem[1]['contribution_id']);
2813     $this->assertEquals('100.00', $lineItem[0]['line_total']);
2814     $this->assertEquals('200.00', $lineItem[1]['line_total']);
2815     $this->assertEquals($membership['id'], $lineItem[1]['entity_id']);
2816     $this->assertEquals('civicrm_membership', $lineItem[1]['entity_table']);
2817   }
2818
2819   /**
2820    * Test financial_type_id override behaviour with a single line item.
2821    *
2822    * CRM-17718 a passed in financial_type_id is not allowed to override the
2823    * original contribution where there is more than one line item.
2824    *
2825    * @throws \CRM_Core_Exception
2826    */
2827   public function testRepeatTransactionPassedInFinancialTypeTwoLineItems(): void {
2828     $this->_params = $this->getParticipantOrderParams();
2829     $originalContribution = $this->setUpRecurringContribution();
2830
2831     $this->callAPISuccess('Contribution', 'repeattransaction', [
2832       'original_contribution_id' => $originalContribution['id'],
2833       'contribution_status_id' => 'Completed',
2834       'trxn_id' => 'repeat',
2835       'financial_type_id' => 2,
2836     ]);
2837
2838     // Retrieve the new contribution and note the financial type passed in has been ignored.
2839     $contribution = $this->callAPISuccessGetSingle('Contribution', [
2840       'trxn_id' => 'repeat',
2841     ]);
2842     $this->assertEquals(4, $contribution['financial_type_id']);
2843
2844     $lineItems = $this->callAPISuccess('line_item', 'get', [
2845       'entity_id' => $contribution['id'],
2846     ])['values'];
2847     foreach ($lineItems as $lineItem) {
2848       $this->assertNotEquals(2, $lineItem['financial_type_id']);
2849     }
2850   }
2851
2852   /**
2853    * CRM-17718 test appropriate action if financial type has changed for single
2854    * line items.
2855    *
2856    * @throws \CRM_Core_Exception
2857    */
2858   public function testRepeatTransactionUpdatedFinancialType(): void {
2859     $originalContribution = $this->setUpRecurringContribution([], ['financial_type_id' => 2]);
2860
2861     $this->callAPISuccess('contribution', 'repeattransaction', [
2862       'contribution_recur_id' => $originalContribution['id'],
2863       'contribution_status_id' => 'Completed',
2864       'trxn_id' => 234,
2865     ]);
2866     $lineItemParams = [
2867       'entity_id' => $originalContribution['id'],
2868       'sequential' => 1,
2869       'return' => [
2870         'entity_table',
2871         'qty',
2872         'unit_price',
2873         'line_total',
2874         'label',
2875         'financial_type_id',
2876         'deductible_amount',
2877         'price_field_value_id',
2878         'price_field_id',
2879       ],
2880     ];
2881
2882     $this->callAPISuccessGetSingle('contribution', [
2883       'total_amount' => 100,
2884       'financial_type_id' => 2,
2885     ]);
2886     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2887       'entity_id' => $originalContribution['id'],
2888     ]))['values'][0];
2889     $expectedLineItem = array_merge(
2890       $lineItem1, [
2891         'line_total' => '100.00',
2892         'unit_price' => '100.00',
2893         'financial_type_id' => 2,
2894         'contribution_type_id' => 2,
2895       ]
2896     );
2897
2898     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2899       'entity_id' => $originalContribution['id'] + 1,
2900     ]));
2901     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
2902     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2903     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2904   }
2905
2906   /**
2907    * CRM-16397 test appropriate action if campaign has been passed in.
2908    */
2909   public function testRepeatTransactionPassedInCampaign() {
2910     $paymentProcessorID = $this->paymentProcessorCreate();
2911     $campaignID = $this->campaignCreate();
2912     $campaignID2 = $this->campaignCreate();
2913     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2914       'contact_id' => $this->_individualId,
2915       'installments' => '12',
2916       'frequency_interval' => '1',
2917       'amount' => '100',
2918       'contribution_status_id' => 1,
2919       'start_date' => '2012-01-01 00:00:00',
2920       'currency' => 'USD',
2921       'frequency_unit' => 'month',
2922       'payment_processor_id' => $paymentProcessorID,
2923     ]);
2924     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2925       $this->_params,
2926       [
2927         'contribution_recur_id' => $contributionRecur['id'],
2928         'campaign_id' => $campaignID,
2929       ])
2930     );
2931
2932     $this->callAPISuccess('contribution', 'repeattransaction', [
2933       'original_contribution_id' => $originalContribution['id'],
2934       'contribution_status_id' => 'Completed',
2935       'trxn_id' => 2345,
2936       'campaign_id' => $campaignID2,
2937     ]);
2938
2939     $this->callAPISuccessGetSingle('contribution', [
2940       'total_amount' => 100,
2941       'campaign_id' => $campaignID2,
2942     ]);
2943   }
2944
2945   /**
2946    * CRM-17718 campaign stored on contribution recur gets priority.
2947    *
2948    * This reflects the fact we permit people to update them.
2949    *
2950    * @throws \CRM_Core_Exception
2951    */
2952   public function testRepeatTransactionUpdatedCampaign(): void {
2953     $paymentProcessorID = $this->paymentProcessorCreate();
2954     $campaignID = $this->campaignCreate();
2955     $campaignID2 = $this->campaignCreate();
2956     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2957       'contact_id' => $this->_individualId,
2958       'installments' => '12',
2959       'frequency_interval' => '1',
2960       'amount' => '100',
2961       'contribution_status_id' => 1,
2962       'start_date' => '2012-01-01 00:00:00',
2963       'currency' => 'USD',
2964       'frequency_unit' => 'month',
2965       'payment_processor_id' => $paymentProcessorID,
2966       'campaign_id' => $campaignID,
2967     ]);
2968     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2969       $this->_params,
2970       [
2971         'contribution_recur_id' => $contributionRecur['id'],
2972         'campaign_id' => $campaignID2,
2973       ])
2974     );
2975
2976     $this->callAPISuccess('contribution', 'repeattransaction', [
2977       'original_contribution_id' => $originalContribution['id'],
2978       'contribution_status_id' => 'Completed',
2979       'trxn_id' => 789,
2980     ]);
2981
2982     $this->callAPISuccessGetSingle('Contribution', [
2983       'total_amount' => 100,
2984       'campaign_id' => $campaignID,
2985     ]);
2986   }
2987
2988   /**
2989    * CRM-20685 Repeattransaction produces incorrect Financial Type ID (in
2990    * specific circumstance) - if number of lineItems = 1.
2991    *
2992    * This case happens when the line item & contribution do not have the same
2993    * type in his initiating transaction.
2994    *
2995    * @throws \CRM_Core_Exception
2996    */
2997   public function testRepeatTransactionUpdatedFinancialTypeAndNotEquals(): void {
2998     $originalContribution = $this->setUpRecurringContribution([], ['financial_type_id' => 2]);
2999     // This will made the trick to get the not equals behaviour.
3000     $this->callAPISuccess('line_item', 'create', ['id' => 1, 'financial_type_id' => 4]);
3001     $this->callAPISuccess('contribution', 'repeattransaction', [
3002       'contribution_recur_id' => $originalContribution['id'],
3003       'contribution_status_id' => 'Completed',
3004       'trxn_id' => 1234,
3005     ]);
3006     $lineItemParams = [
3007       'entity_id' => $originalContribution['id'],
3008       'sequential' => 1,
3009       'return' => [
3010         'entity_table',
3011         'qty',
3012         'unit_price',
3013         'line_total',
3014         'label',
3015         'financial_type_id',
3016         'deductible_amount',
3017         'price_field_value_id',
3018         'price_field_id',
3019       ],
3020     ];
3021     $this->callAPISuccessGetSingle('contribution', [
3022       'total_amount' => 100,
3023       'financial_type_id' => 2,
3024     ]);
3025     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
3026       'entity_id' => $originalContribution['id'],
3027     ]));
3028     $expectedLineItem = array_merge(
3029       $lineItem1['values'][0], [
3030         'line_total' => '100.00',
3031         'unit_price' => '100.00',
3032         'financial_type_id' => 4,
3033         'contribution_type_id' => 4,
3034       ]
3035     );
3036
3037     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
3038       'entity_id' => $originalContribution['id'] + 1,
3039     ]));
3040     $this->callAPISuccess('line_item', 'create', ['id' => 1, 'financial_type_id' => 1]);
3041     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
3042     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
3043     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
3044   }
3045
3046   /**
3047    * Test completing a transaction does not 'mess' with net amount (CRM-15960).
3048    */
3049   public function testCompleteTransactionNetAmountOK() {
3050     $this->createLoggedInUser();
3051     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
3052     unset($params['net_amount']);
3053     $contribution = $this->callAPISuccess('contribution', 'create', $params);
3054     $this->callAPISuccess('contribution', 'completetransaction', [
3055       'id' => $contribution['id'],
3056     ]);
3057     $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id']]);
3058     $this->assertEquals('Completed', $contribution['contribution_status']);
3059     $this->assertTrue(($contribution['total_amount'] - $contribution['net_amount']) == $contribution['fee_amount']);
3060   }
3061
3062   /**
3063    * CRM-14151 - Test completing a transaction via the API.
3064    */
3065   public function testCompleteTransactionWithReceiptDateSet() {
3066     $this->swapMessageTemplateForTestTemplate();
3067     $mut = new CiviMailUtils($this, TRUE);
3068     $this->createLoggedInUser();
3069     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'receipt_date' => 'now']);
3070     $contribution = $this->callAPISuccess('contribution', 'create', $params);
3071     $this->callAPISuccess('contribution', 'completetransaction', ['id' => $contribution['id'], 'trxn_date' => date('Y-m-d')]);
3072     $contribution = $this->callAPISuccess('contribution', 'get', ['id' => $contribution['id'], 'sequential' => 1]);
3073     $this->assertEquals('Completed', $contribution['values'][0]['contribution_status']);
3074     // Make sure receive_date is original date and make sure payment date is today
3075     $this->assertEquals('2012-05-11', date('Y-m-d', strtotime($contribution['values'][0]['receive_date'])));
3076     $payment = $this->callAPISuccess('payment', 'get', ['contribution_id' => $contribution['id'], 'sequential' => 1]);
3077     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($payment['values'][0]['trxn_date'])));
3078     $mut->checkMailLog([
3079       'Receipt - Contribution',
3080       'receipt_date:::' . date('Ymd'),
3081     ]);
3082     $mut->stop();
3083     $this->revertTemplateToReservedTemplate();
3084   }
3085
3086   /**
3087    * CRM-1960 - Test to ensure that completetransaction respects the is_email_receipt setting
3088    */
3089   public function testCompleteTransactionWithEmailReceiptInput() {
3090     $contributionPage = $this->createReceiptableContributionPage();
3091
3092     $this->_params['contribution_page_id'] = $contributionPage['id'];
3093     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
3094     $contribution = $this->callAPISuccess('contribution', 'create', $params);
3095     // Complete the transaction overriding is_email_receipt to = FALSE
3096     $this->callAPISuccess('contribution', 'completetransaction', [
3097       'id' => $contribution['id'],
3098       'trxn_date' => date('2011-04-09'),
3099       'trxn_id' => 'kazam',
3100       'is_email_receipt' => 0,
3101     ]);
3102     // Check if a receipt was issued
3103     $receipt_date = $this->callAPISuccess('Contribution', 'getvalue', ['id' => $contribution['id'], 'return' => 'receipt_date']);
3104     $this->assertEquals('', $receipt_date);
3105   }
3106
3107   /**
3108    * Test that $is_recur is assigned to the receipt.
3109    */
3110   public function testCompleteTransactionForRecurring() {
3111     $this->mut = new CiviMailUtils($this, TRUE);
3112     $this->swapMessageTemplateForTestTemplate();
3113     $recurring = $this->setUpRecurringContribution();
3114     $contributionPage = $this->createReceiptableContributionPage(['is_recur' => TRUE, 'recur_frequency_unit' => 'month', 'recur_interval' => 1]);
3115
3116     $this->_params['contribution_page_id'] = $contributionPage['id'];
3117     $this->_params['contribution_recur_id'] = $recurring['id'];
3118
3119     $contribution = $this->setUpForCompleteTransaction();
3120
3121     $this->callAPISuccess('contribution', 'completetransaction', [
3122       'id' => $contribution['id'],
3123       'trxn_date' => date('2011-04-09'),
3124       'trxn_id' => 'kazam',
3125       'is_email_receipt' => 1,
3126     ]);
3127
3128     $this->mut->checkMailLog([
3129       'is_recur:::1',
3130       'cancelSubscriptionUrl:::' . CIVICRM_UF_BASEURL,
3131     ]);
3132     $this->mut->stop();
3133     $this->revertTemplateToReservedTemplate();
3134   }
3135
3136   /**
3137    * CRM-19710 - Test to ensure that completetransaction respects the input for
3138    * is_email_receipt setting.
3139    *
3140    * If passed in it will override the default from contribution page.
3141    *
3142    * @throws \CRM_Core_Exception
3143    */
3144   public function testCompleteTransactionWithEmailReceiptInputTrue(): void {
3145     $mut = new CiviMailUtils($this, TRUE);
3146     $this->createLoggedInUser();
3147     $contributionPageParams = ['is_email_receipt' => 0];
3148     // Create a Contribution Page with is_email_receipt = FALSE
3149     $contributionPageID = $this->createQuickConfigContributionPage($contributionPageParams);
3150     $this->_params['contribution_page_id'] = $contributionPageID;
3151     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'receipt_date' => 'now']);
3152     $contribution = $this->callAPISuccess('contribution', 'create', $params);
3153     // Complete the transaction overriding is_email_receipt to = TRUE
3154     $this->callAPISuccess('contribution', 'completetransaction', [
3155       'id' => $contribution['id'],
3156       'is_email_receipt' => 1,
3157     ]);
3158     $mut->checkMailLog([
3159       'Contribution Information',
3160     ]);
3161     $mut->stop();
3162   }
3163
3164   /**
3165    * Complete the transaction using the template with all the possible.
3166    */
3167   public function testCompleteTransactionWithTestTemplate() {
3168     $this->swapMessageTemplateForTestTemplate();
3169     $contribution = $this->setUpForCompleteTransaction();
3170     $this->callAPISuccess('contribution', 'completetransaction', [
3171       'id' => $contribution['id'],
3172       'trxn_date' => date('2011-04-09'),
3173       'trxn_id' => 'kazam',
3174     ]);
3175     $receive_date = $this->callAPISuccess('Contribution', 'getvalue', ['id' => $contribution['id'], 'return' => 'receive_date']);
3176     $this->mut->checkMailLog([
3177       'email:::anthony_anderson@civicrm.org',
3178       'is_monetary:::1',
3179       'amount:::100.00',
3180       'currency:::USD',
3181       'receive_date:::' . date('Ymd', strtotime($receive_date)),
3182       'receipt_date:::' . date('Ymd'),
3183       'title:::Contribution',
3184       'trxn_id:::kazam',
3185       'contactID:::' . $this->_params['contact_id'],
3186       'contributionID:::' . $contribution['id'],
3187       'financialTypeId:::1',
3188       'financialTypeName:::Donation',
3189     ]);
3190     $this->mut->stop();
3191     $this->revertTemplateToReservedTemplate();
3192   }
3193
3194   /**
3195    * Complete the transaction using the template with all the possible.
3196    */
3197   public function testCompleteTransactionContributionPageFromAddress() {
3198     $contributionPage = $this->callAPISuccess('ContributionPage', 'create', [
3199       'receipt_from_name' => 'Mickey Mouse',
3200       'receipt_from_email' => 'mickey@mouse.com',
3201       'title' => "Test Contribution Page",
3202       'financial_type_id' => 1,
3203       'currency' => 'NZD',
3204       'goal_amount' => 50,
3205       'is_pay_later' => 1,
3206       'is_monetary' => TRUE,
3207       'is_email_receipt' => TRUE,
3208     ]);
3209     $this->_params['contribution_page_id'] = $contributionPage['id'];
3210     $contribution = $this->setUpForCompleteTransaction();
3211     $this->callAPISuccess('contribution', 'completetransaction', ['id' => $contribution['id']]);
3212     $this->mut->checkMailLog([
3213       'mickey@mouse.com',
3214       'Mickey Mouse <',
3215     ]);
3216     $this->mut->stop();
3217   }
3218
3219   /**
3220    * Test completing first transaction in a recurring series.
3221    *
3222    * The status should be set to 'in progress' and the next scheduled payment date calculated.
3223    *
3224    * @dataProvider getScheduledDateData
3225    *
3226    * @param array $dataSet
3227    *
3228    * @throws \Exception
3229    */
3230   public function testCompleteTransactionSetStatusToInProgress($dataSet) {
3231     $paymentProcessorID = $this->paymentProcessorCreate();
3232     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
3233       'contact_id' => $this->_individualId,
3234       'installments' => '2',
3235       'frequency_interval' => '1',
3236       'amount' => '500',
3237       'contribution_status_id' => 'Pending',
3238       'start_date' => '2012-01-01 00:00:00',
3239       'currency' => 'USD',
3240       'frequency_unit' => 'month',
3241       'payment_processor_id' => $paymentProcessorID,
3242     ], $dataSet['data']));
3243     $contribution = $this->callAPISuccess('contribution', 'create', array_merge(
3244       $this->_params,
3245       [
3246         'contribution_recur_id' => $contributionRecur['id'],
3247         'contribution_status_id' => 'Pending',
3248         'receive_date' => $dataSet['receive_date'],
3249       ])
3250     );
3251     $this->callAPISuccess('Contribution', 'completetransaction', [
3252       'id' => $contribution,
3253       'receive_date' => $dataSet['receive_date'],
3254     ]);
3255     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
3256       'id' => $contributionRecur['id'],
3257       'return' => ['next_sched_contribution_date', 'contribution_status_id'],
3258     ]);
3259     $this->assertEquals(5, $contributionRecur['contribution_status_id']);
3260     $this->assertEquals($dataSet['expected'], $contributionRecur['next_sched_contribution_date']);
3261     $this->callAPISuccess('Contribution', 'create', array_merge(
3262       $this->_params,
3263       [
3264         'contribution_recur_id' => $contributionRecur['id'],
3265         'contribution_status_id' => 'Completed',
3266       ]
3267     ));
3268     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
3269       'id' => $contributionRecur['id'],
3270       'return' => ['contribution_status_id'],
3271     ]);
3272     $this->assertEquals(1, $contributionRecur['contribution_status_id']);
3273   }
3274
3275   /**
3276    * Get dates for testing.
3277    *
3278    * @return array
3279    */
3280   public function getScheduledDateData() {
3281     $result = [];
3282     $result[]['2016-08-31-1-month'] = [
3283       'data' => [
3284         'start_date' => '2016-08-31',
3285         'frequency_interval' => 1,
3286         'frequency_unit' => 'month',
3287       ],
3288       'receive_date' => '2016-08-31',
3289       'expected' => '2016-10-01 00:00:00',
3290     ];
3291     $result[]['2012-01-01-1-month'] = [
3292       'data' => [
3293         'start_date' => '2012-01-01',
3294         'frequency_interval' => 1,
3295         'frequency_unit' => 'month',
3296       ],
3297       'receive_date' => '2012-01-01',
3298       'expected' => '2012-02-01 00:00:00',
3299     ];
3300     $result[]['2012-01-01-1-month'] = [
3301       'data' => [
3302         'start_date' => '2012-01-01',
3303         'frequency_interval' => 1,
3304         'frequency_unit' => 'month',
3305       ],
3306       'receive_date' => '2012-02-29',
3307       'expected' => '2012-03-29 00:00:00',
3308     ];
3309     $result['receive_date_includes_time']['2012-01-01-1-month'] = [
3310       'data' => [
3311         'start_date' => '2012-01-01',
3312         'frequency_interval' => 1,
3313         'frequency_unit' => 'month',
3314         'next_sched_contribution_date' => '2012-02-29',
3315       ],
3316       'receive_date' => '2012-02-29 16:00:00',
3317       'expected' => '2012-03-29 00:00:00',
3318     ];
3319     return $result;
3320   }
3321
3322   /**
3323    * Test completing a pledge with the completeTransaction api..
3324    *
3325    * Note that we are creating a logged in user because email goes out from
3326    * that person.
3327    */
3328   public function testCompleteTransactionUpdatePledgePayment() {
3329     $this->swapMessageTemplateForTestTemplate();
3330     $mut = new CiviMailUtils($this, TRUE);
3331     $mut->clearMessages();
3332     $this->createLoggedInUser();
3333     $contributionID = $this->createPendingPledgeContribution();
3334     $this->callAPISuccess('contribution', 'completetransaction', [
3335       'id' => $contributionID,
3336       'trxn_date' => '1 Feb 2013',
3337     ]);
3338     $pledge = $this->callAPISuccessGetSingle('Pledge', [
3339       'id' => $this->_ids['pledge'],
3340     ]);
3341     $this->assertEquals('Completed', $pledge['pledge_status']);
3342
3343     $status = $this->callAPISuccessGetValue('PledgePayment', [
3344       'pledge_id' => $this->_ids['pledge'],
3345       'return' => 'status_id',
3346     ]);
3347     $this->assertEquals(1, $status);
3348     $mut->checkMailLog([
3349       'amount:::500.00',
3350       // The `receive_date` should remain as it was created.
3351       // TODO: the latest payment transaction date (and maybe other details,
3352       // such as amount and payment instrument) would be a useful token to make
3353       // available.
3354       'receive_date:::20120511000000',
3355       "receipt_date:::\n",
3356     ]);
3357     $mut->stop();
3358     $this->revertTemplateToReservedTemplate();
3359   }
3360
3361   /**
3362    * Test completing a transaction with an event via the API.
3363    *
3364    * Note that we are creating a logged in user because email goes out from
3365    * that person
3366    *
3367    * @throws \CRM_Core_Exception
3368    */
3369   public function testCompleteTransactionWithParticipantRecord(): void {
3370     $mut = new CiviMailUtils($this, TRUE);
3371     $mut->clearMessages();
3372     $this->_individualId = $this->createLoggedInUser();
3373     $this->_params['source'] = 'Online Event Registration: Annual CiviCRM meet';
3374     $contributionID = $this->createPendingParticipantContribution();
3375     $this->createJoinedProfile(['entity_id' => $this->_ids['event']['test'], 'entity_table' => 'civicrm_event']);
3376     $this->createJoinedProfile(['entity_id' => $this->_ids['event']['test'], 'entity_table' => 'civicrm_event', 'weight' => 2], ['name' => 'post_1', 'title' => 'title_post_2', 'frontend_title' => 'public 2']);
3377     $this->createJoinedProfile(['entity_id' => $this->_ids['event']['test'], 'entity_table' => 'civicrm_event', 'weight' => 3], ['name' => 'post_2', 'title' => 'title_post_3', 'frontend_title' => 'public 3']);
3378     $this->eliminateUFGroupOne();
3379
3380     $this->callAPISuccess('contribution', 'completetransaction', ['id' => $contributionID]);
3381     $contribution = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID, 'return' => ['contribution_source']]);
3382     $this->assertEquals('Online Event Registration: Annual CiviCRM meet', $contribution['contribution_source']);
3383     $participantStatus = $this->callAPISuccessGetValue('participant', [
3384       'id' => $this->_ids['participant'],
3385       'return' => 'participant_status_id',
3386     ]);
3387     $this->assertEquals(1, $participantStatus);
3388
3389     //Assert only three activities are created.
3390     $activities = $this->callAPISuccess('Activity', 'get', [
3391       'contact_id' => $this->_individualId,
3392     ])['values'];
3393
3394     $this->assertCount(3, $activities);
3395     $activityNames = array_count_values(CRM_Utils_Array::collect('activity_name', $activities));
3396     // record two activities before and after completing payment for Event registration
3397     $this->assertEquals(2, $activityNames['Event Registration']);
3398     // update the original 'Contribution' activity created after completing payment
3399     $this->assertEquals(1, $activityNames['Contribution']);
3400
3401     $mut->checkMailLog([
3402       'Annual CiviCRM meet',
3403       'Event',
3404       'This is a confirmation that your registration has been received and your status has been updated to Registered.',
3405       'First Name: Logged In',
3406       'Public title',
3407       'public 2',
3408       'public 3',
3409     ], ['Back end title', 'title_post_2', 'title_post_3']);
3410     $mut->stop();
3411   }
3412
3413   /**
3414    * Test membership is renewed when transaction completed.
3415    *
3416    * @throws \API_Exception
3417    */
3418   public function testCompleteTransactionMembershipPriceSet(): void {
3419     $this->createPriceSetWithPage('membership');
3420     $this->createInitialPaidMembership();
3421     $membership = $this->callAPISuccess('Membership', 'getsingle', [
3422       'id' => $this->getMembershipID(),
3423       'status_id' => 'Grace',
3424       'return' => ['end_date'],
3425     ]);
3426     $this->assertEquals(date('Y-m-d', strtotime('yesterday')), $membership['end_date']);
3427
3428     $this->createSubsequentPendingMembership();
3429     $this->callAPISuccess('Payment', 'create', [
3430       'contribution_id' => $this->getContributionID('second'),
3431       'total_amount' => 20,
3432     ]);
3433     $membership = $this->callAPISuccess('membership', 'getsingle', ['id' => $this->_ids['membership']]);
3434     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 2 year')), $membership['end_date']);
3435     $logs = $this->callAPISuccess('MembershipLog', 'get', [
3436       'membership_id' => $this->getMembershipID(),
3437     ]);
3438     $this->assertEquals(4, $logs['count']);
3439     //Assert only three activities are created.
3440     $activityNames = (array) ActivityContact::get(FALSE)
3441       ->addWhere('contact_id', '=', $this->_ids['contact'])
3442       ->addSelect('activity_id.activity_type_id:name')->execute()->indexBy('activity_id.activity_type_id:name');
3443     $this->assertArrayHasKey('Contribution', $activityNames);
3444     $this->assertArrayHasKey('Membership Signup', $activityNames);
3445     $this->assertArrayHasKey('Change Membership Status', $activityNames);
3446   }
3447
3448   /**
3449    * Test if renewal activity is create after changing Pending contribution to
3450    * Completed via offline
3451    *
3452    * @throws \CRM_Core_Exception
3453    * @throws \CRM_Core_Exception
3454    * @throws \CiviCRM_API3_Exception
3455    */
3456   public function testPendingToCompleteContribution(): void {
3457     $this->createPriceSetWithPage('membership');
3458     $this->setUpPendingContribution($this->_ids['price_field_value'][0]);
3459     $this->callAPISuccess('membership', 'getsingle', ['id' => $this->_ids['membership']]);
3460     // Case 1: Assert that Membership Signup Activity is created on Pending to Completed Contribution via backoffice
3461     $activity = $this->callAPISuccess('Activity', 'get', [
3462       'activity_type_id' => 'Membership Signup',
3463       'source_record_id' => $this->_ids['membership'],
3464       'status_id' => 'Scheduled',
3465     ]);
3466     $this->assertEquals(1, $activity['count']);
3467
3468     // change pending contribution to completed
3469     $form = new CRM_Contribute_Form_Contribution();
3470
3471     $form->_params = [
3472       'id' => $this->getContributionID(),
3473       'total_amount' => 20,
3474       'net_amount' => 20,
3475       'fee_amount' => 0,
3476       'financial_type_id' => 1,
3477       'contact_id' => $this->_individualId,
3478       'contribution_status_id' => 1,
3479       'billing_middle_name' => '',
3480       'billing_last_name' => 'Adams',
3481       'billing_street_address-5' => '790L Lincoln St S',
3482       'billing_city-5' => 'Mary knoll',
3483       'billing_state_province_id-5' => 1031,
3484       'billing_postal_code-5' => 10545,
3485       'billing_country_id-5' => 1228,
3486       'frequency_interval' => 1,
3487       'frequency_unit' => 'month',
3488       'installments' => '',
3489       'hidden_AdditionalDetail' => 1,
3490       'hidden_Premium' => 1,
3491       'from_email_address' => '"civi45" <civi45@civicrm.com>',
3492       'receipt_date' => '',
3493       'receipt_date_time' => '',
3494       'payment_processor_id' => $this->paymentProcessorID,
3495       'currency' => 'USD',
3496       'contribution_page_id' => $this->_ids['contribution_page'],
3497       'source' => 'Membership Signup and Renewal',
3498     ];
3499
3500     $form->testSubmit($form->_params, CRM_Core_Action::UPDATE);
3501
3502     // Case 2: After successful payment for Pending backoffice there are three activities created
3503     //  2.a Update status of existing Scheduled Membership Signup (created in step 1) to Completed
3504     $activity = $this->callAPISuccess('Activity', 'get', [
3505       'activity_type_id' => 'Membership Signup',
3506       'source_record_id' => $this->getMembershipID(),
3507       'status_id' => 'Completed',
3508     ]);
3509     $this->assertEquals(1, $activity['count']);
3510     // 2.b Contribution activity created to record successful payment
3511     $activity = $this->callAPISuccess('Activity', 'get', [
3512       'activity_type_id' => 'Contribution',
3513       'source_record_id' => $this->getContributionID(),
3514       'status_id' => 'Completed',
3515     ]);
3516     $this->assertEquals(1, $activity['count']);
3517
3518     // 2.c 'Change membership type' activity created to record Membership status change from Grace to Current
3519     $activity = $this->callAPISuccess('Activity', 'get', [
3520       'activity_type_id' => 'Change Membership Status',
3521       'source_record_id' => $this->getMembershipID(),
3522       'status_id' => 'Completed',
3523     ]);
3524     $this->assertEquals(1, $activity['count']);
3525     $this->assertEquals('Status changed from Pending to New', $activity['values'][$activity['id']]['subject']);
3526     $membershipLogs = $this->callAPISuccess('MembershipLog', 'get', ['sequential' => 1])['values'];
3527     $this->assertEquals('Pending', CRM_Core_PseudoConstant::getName('CRM_Member_BAO_Membership', 'status_id', $membershipLogs[0]['status_id']));
3528     $this->assertEquals('New', CRM_Core_PseudoConstant::getName('CRM_Member_BAO_Membership', 'status_id', $membershipLogs[1]['status_id']));
3529     //Create another pending contribution for renewal
3530     $this->setUpPendingContribution($this->_ids['price_field_value'][0], 'second', [], ['entity_id' => $this->getMembershipID()], ['id' => $this->getMembershipID()]);
3531
3532     //Update it to Failed.
3533     $form->_params['id'] = $this->getContributionID('second');
3534     $form->_params['contribution_status_id'] = 4;
3535
3536     $form->testSubmit($form->_params, CRM_Core_Action::UPDATE);
3537     //Existing membership should not get updated to expired.
3538     $membership = $this->callAPISuccess('Membership', 'getsingle', ['id' => $this->_ids['membership']]);
3539     $this->assertNotEquals(4, $membership['status_id']);
3540   }
3541
3542   /**
3543    * Test membership is renewed for 2 terms when transaction completed based on the line item having 2 terms as qty.
3544    *
3545    * Also check that altering the qty for the most recent contribution results in repeattransaction picking it up.
3546    */
3547   public function testCompleteTransactionMembershipPriceSetTwoTerms(): void {
3548     $this->createPriceSetWithPage('membership');
3549     $this->createInitialPaidMembership();
3550     $this->createSubsequentPendingMembership();
3551
3552     $this->callAPISuccess('Payment', 'create', [
3553       'contribution_id' => $this->getContributionID('second'),
3554       'total_amount' => 20,
3555     ]);
3556
3557     $membership = $this->callAPISuccessGetSingle('membership', ['id' => $this->getMembershipID()]);
3558     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 2 years')), $membership['end_date']);
3559
3560     $paymentProcessorID = $this->paymentProcessorAuthorizeNetCreate();
3561
3562     $contributionRecurID = $this->callAPISuccess('ContributionRecur', 'create', ['contact_id' => $membership['contact_id'], 'payment_processor_id' => $paymentProcessorID, 'amount' => 20, 'frequency_interval' => 1])['id'];
3563     $this->callAPISuccess('Contribution', 'create', ['id' => $this->getContributionID(), 'contribution_recur_id' => $contributionRecurID]);
3564     $this->callAPISuccess('contribution', 'repeattransaction', ['contribution_recur_id' => $contributionRecurID, 'contribution_status_id' => 'Completed']);
3565     $membership = $this->callAPISuccessGetSingle('membership', ['id' => $this->getMembershipID()]);
3566     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 4 years')), $membership['end_date']);
3567
3568     // 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.
3569     $contribution = Contribution::get()->setOrderBy(['id' => 'DESC'])->setSelect(['id'])->execute()->first();
3570     CRM_Core_DAO::executeQuery('UPDATE civicrm_line_item SET price_field_value_id = ' . $this->_ids['price_field_value'][0] . ' WHERE contribution_id = ' . $contribution['id']);
3571     $this->callAPISuccess('contribution', 'repeattransaction', ['contribution_recur_id' => $contributionRecurID, 'contribution_status_id' => 'Completed']);
3572     $membership = $this->callAPISuccessGetSingle('membership', ['id' => $this->_ids['membership']]);
3573     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 5 years')), $membership['end_date']);
3574   }
3575
3576   public function cleanUpAfterPriceSets() {
3577     $this->quickCleanUpFinancialEntities();
3578     $this->contactDelete($this->_ids['contact']);
3579   }
3580
3581   /**
3582    * Set up a pending transaction with a specific price field id.
3583    *
3584    * @param int $priceFieldValueID
3585    * @param string $key
3586    * @param array $contributionParams
3587    * @param array $lineParams
3588    * @param array $membershipParams
3589    */
3590   public function setUpPendingContribution(int $priceFieldValueID, string $key = 'first', array $contributionParams = [], array $lineParams = [], array $membershipParams = []): void {
3591     $contactID = $this->individualCreate();
3592     $membershipParams = array_merge([
3593       'contact_id' => $contactID,
3594       'membership_type_id' => $this->_ids['membership_type'],
3595     ], $membershipParams);
3596     if ($key === 'first') {
3597       // If we want these after the initial we will set them.
3598       $membershipParams['start_date'] = 'yesterday - 1 year';
3599       $membershipParams['end_date'] = 'yesterday';
3600       $membershipParams['join_date'] = 'yesterday - 1 year';
3601     }
3602     $contribution = $this->callAPISuccess('Order', 'create', array_merge([
3603       'domain_id' => 1,
3604       'contact_id' => $contactID,
3605       'receive_date' => date('Ymd'),
3606       'total_amount' => 20.00,
3607       'financial_type_id' => 1,
3608       'payment_instrument_id' => 'Credit Card',
3609       'non_deductible_amount' => 10.00,
3610       'source' => 'SSF',
3611       'contribution_page_id' => $this->_ids['contribution_page'],
3612       'line_items' => [
3613         [
3614           'line_item' => [
3615             array_merge([
3616               'price_field_id' => $this->_ids['price_field'][0],
3617               'qty' => 1,
3618               'entity_table' => 'civicrm_membership',
3619               'unit_price' => 20,
3620               'line_total' => 20,
3621               'financial_type_id' => 1,
3622               'price_field_value_id' => $priceFieldValueID,
3623             ], $lineParams),
3624           ],
3625           'params' => $membershipParams,
3626         ],
3627       ],
3628     ], $contributionParams));
3629
3630     $this->_ids['contact'] = $contactID;
3631     $this->ids['contribution'][$key] = $contribution['id'];
3632     $this->_ids['membership'] = $this->callAPISuccessGetValue('MembershipPayment', ['return' => 'membership_id', 'contribution_id' => $contribution['id']]);
3633   }
3634
3635   /**
3636    * Test sending a mail via the API.
3637    *
3638    * @throws \CRM_Core_Exception
3639    */
3640   public function testSendMail(): void {
3641     $mut = new CiviMailUtils($this, TRUE);
3642     $orderParams = $this->_params;
3643     $orderParams['contribution_status_id'] = 'Pending';
3644     $orderParams['api.PaymentProcessor.pay'] = [
3645       'payment_processor_id' => $this->paymentProcessorID,
3646       'credit_card_type' => 'Visa',
3647       'credit_card_number' => 41111111111111,
3648       'amount' => 5,
3649     ];
3650
3651     $order = $this->callAPISuccess('Order', 'create', $orderParams);
3652     $this->callAPISuccess('Payment', 'create', ['total_amount' => 5, 'is_send_notification' => 0, 'order_id' => $order['id']]);
3653     $address = $this->callAPISuccess('Address', 'create', ['contribution_id' => $order['id'], 'name' => 'bob', 'contact_id' => 1, 'street_address' => 'blah']);
3654     $this->callAPISuccess('Contribution', 'create', ['id' => $order['id'], 'address_id' => $address['id']]);
3655     $this->callAPISuccess('contribution', 'sendconfirmation', [
3656       'id' => $order['id'],
3657       'receipt_from_email' => 'api@civicrm.org',
3658     ]);
3659     $mut->checkMailLog([
3660       '$ 100.00',
3661       'Contribution Information',
3662     ], [
3663       'Event',
3664     ]);
3665
3666     $this->checkCreditCardDetails($mut, $order['id']);
3667     $mut->stop();
3668     $tplVars = CRM_Core_Smarty::singleton()->get_template_vars();
3669     $this->assertEquals('bob', $tplVars['billingName']);
3670   }
3671
3672   /**
3673    * Test sending a mail via the API.
3674    * This simulates webform_civicrm using pay later contribution page
3675    *
3676    * @throws \CRM_Core_Exception
3677    * @throws \CiviCRM_API3_Exception
3678    */
3679   public function testSendConfirmationPayLater(): void {
3680     $mut = new CiviMailUtils($this, TRUE);
3681     // Create contribution page
3682     $pageParams = [
3683       'title' => 'Webform Contributions',
3684       'financial_type_id' => 1,
3685       'contribution_type_id' => 1,
3686       'is_confirm_enabled' => 1,
3687       'is_pay_later' => 1,
3688       'pay_later_text' => 'I will send payment by cheque',
3689       'pay_later_receipt' => 'Send your cheque payable to "CiviCRM LLC" to the office',
3690     ];
3691     $contributionPage = $this->callAPISuccess('ContributionPage', 'create', $pageParams);
3692
3693     // Create pay later contribution
3694     $contribution = $this->callAPISuccess('Order', 'create', [
3695       'contact_id' => $this->_individualId,
3696       'financial_type_id' => 1,
3697       'is_pay_later' => 1,
3698       'contribution_status_id' => 2,
3699       'contribution_page_id' => $contributionPage['id'],
3700       'total_amount' => '10.00',
3701       'line_items' => [
3702         [
3703           'line_item' => [
3704             [
3705               'entity_table' => 'civicrm_contribution',
3706               'label' => 'My lineitem label',
3707               'qty' => 1,
3708               'unit_price' => '10.00',
3709               'line_total' => '10.00',
3710             ],
3711           ],
3712         ],
3713       ],
3714     ]);
3715
3716     // Create email
3717     try {
3718       civicrm_api3('contribution', 'sendconfirmation', [
3719         'id' => $contribution['id'],
3720         'receipt_from_email' => 'api@civicrm.org',
3721       ]);
3722     }
3723     catch (Exception $e) {
3724       // Need to figure out how to stop this some other day
3725       // We don't care about the Payment Processor because this is Pay Later
3726       // The point of this test is to check we get the pay_later version of the mail
3727       if ($e->getMessage() !== "Undefined variable: CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage") {
3728         throw $e;
3729       }
3730     }
3731
3732     // Retrieve mail & check it has the pay_later_receipt info
3733     $mut->getMostRecentEmail('raw');
3734     $mut->checkMailLog([
3735       (string) 10,
3736       $pageParams['pay_later_receipt'],
3737     ], [
3738       'Event',
3739     ]);
3740     $this->checkReceiptDetails($mut, $contributionPage['id'], $contribution['id'], $pageParams);
3741     $mut->stop();
3742   }
3743
3744   /**
3745    * Check credit card details in sent mail via API
3746    *
3747    * @param CiviMailUtils $mut
3748    * @param int $contributionID Contribution ID
3749    *
3750    * @throws \CRM_Core_Exception
3751    */
3752   public function checkCreditCardDetails($mut, $contributionID) {
3753     $this->callAPISuccess('contribution', 'create', $this->_params);
3754     $this->callAPISuccess('contribution', 'sendconfirmation', [
3755       'id' => $contributionID,
3756       'receipt_from_email' => 'api@civicrm.org',
3757       'payment_processor_id' => $this->paymentProcessorID,
3758     ]);
3759     $mut->checkMailLog([
3760       // billing header
3761       'Billing Name and Address',
3762       // billing name
3763       'anthony_anderson@civicrm.org',
3764     ], [
3765       'Event',
3766     ]);
3767   }
3768
3769   /**
3770    * Check receipt details in sent mail via API
3771    *
3772    * @param CiviMailUtils $mut
3773    * @param int $pageID Page ID
3774    * @param int $contributionID Contribution ID
3775    * @param array $pageParams
3776    *
3777    * @throws \CRM_Core_Exception
3778    */
3779   public function checkReceiptDetails($mut, $pageID, $contributionID, $pageParams): void {
3780     $pageReceipt = [
3781       'receipt_from_name' => 'Page FromName',
3782       'receipt_from_email' => 'page_from@email.com',
3783       'cc_receipt' => 'page_cc@email.com',
3784       'receipt_text' => 'Page Receipt Text',
3785       'pay_later_receipt' => $pageParams['pay_later_receipt'],
3786     ];
3787     $customReceipt = [
3788       'receipt_from_name' => 'Custom FromName',
3789       'receipt_from_email' => 'custom_from@email.com',
3790       'cc_receipt' => 'custom_cc@email.com',
3791       'receipt_text' => 'Test Custom Receipt Text',
3792       'pay_later_receipt' => 'Mail your check to test@example.com within 3 business days.',
3793     ];
3794     $this->callAPISuccess('ContributionPage', 'create', array_merge([
3795       'id' => $pageID,
3796       'is_email_receipt' => 1,
3797     ], $pageReceipt));
3798
3799     $this->callAPISuccess('contribution', 'sendconfirmation', array_merge([
3800       'id' => $contributionID,
3801       'payment_processor_id' => $this->paymentProcessorID,
3802     ], $customReceipt));
3803
3804     //Verify if custom receipt details are present in email.
3805     //Page receipt details shouldn't be included.
3806     $mut->checkMailLog(array_values($customReceipt), array_values($pageReceipt));
3807   }
3808
3809   /**
3810    * Test sending a mail via the API.
3811    */
3812   public function testSendMailEvent() {
3813     $mut = new CiviMailUtils($this, TRUE);
3814     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
3815     $event = $this->eventCreate([
3816       'is_email_confirm' => 1,
3817       'confirm_from_email' => 'test@civicrm.org',
3818     ]);
3819     $this->_eventID = $event['id'];
3820     $participantParams = [
3821       'contact_id' => $this->_individualId,
3822       'event_id' => $this->_eventID,
3823       'status_id' => 1,
3824       'role_id' => 1,
3825       // to ensure it matches later on
3826       'register_date' => '2007-07-21 00:00:00',
3827       'source' => 'Online Event Registration: API Testing',
3828
3829     ];
3830     $participant = $this->callAPISuccess('participant', 'create', $participantParams);
3831     $this->callAPISuccess('participant_payment', 'create', [
3832       'participant_id' => $participant['id'],
3833       'contribution_id' => $contribution['id'],
3834     ]);
3835     $this->callAPISuccess('contribution', 'sendconfirmation', [
3836       'id' => $contribution['id'],
3837       'receipt_from_email' => 'api@civicrm.org',
3838     ]);
3839
3840     $mut->checkMailLog([
3841       'Annual CiviCRM meet',
3842       'Event',
3843       'To: "Mr. Anthony Anderson II" <anthony_anderson@civicrm.org>',
3844     ], []);
3845     $mut->stop();
3846   }
3847
3848   /**
3849    * This function does a GET & compares the result against the $params.
3850    *
3851    * Use as a double check on Creates.
3852    *
3853    * @param array $params
3854    * @param int $id
3855    * @param bool $delete
3856    *
3857    * @throws \CRM_Core_Exception
3858    */
3859   public function contributionGetnCheck(array $params, int $id, bool $delete = TRUE): void {
3860     $contribution = $this->callAPISuccess('Contribution', 'Get', [
3861       'id' => $id,
3862       'return' => array_merge(['contribution_source'], array_keys($params)),
3863     ]);
3864     if ($delete) {
3865       $this->callAPISuccess('contribution', 'delete', ['id' => $id]);
3866     }
3867     $this->assertAPISuccess($contribution, 0);
3868     $values = $contribution['values'][$contribution['id']];
3869     $params['receive_date'] = date('Y-m-d H:i:s', strtotime($params['receive_date']));
3870     // this is not returned in id format
3871     unset($params['payment_instrument_id']);
3872     $params['contribution_source'] = $params['source'];
3873     unset($params['source'], $params['sequential']);
3874     foreach ($params as $key => $value) {
3875       $this->assertEquals($value, $values[$key], $key . " value: $value doesn't match " . print_r($values, TRUE));
3876     }
3877   }
3878
3879   /**
3880    * Create a pending contribution & linked pending pledge record.
3881    *
3882    * @throws \CRM_Core_Exception
3883    */
3884   public function createPendingPledgeContribution() {
3885
3886     $pledgeID = $this->pledgeCreate(['contact_id' => $this->_individualId, 'installments' => 1, 'amount' => 500]);
3887     $this->_ids['pledge'] = $pledgeID;
3888     $contribution = $this->callAPISuccess('Contribution', 'create', array_merge($this->_params, [
3889       'contribution_status_id' => 'Pending',
3890       'total_amount' => 500,
3891     ]));
3892     $paymentID = $this->callAPISuccessGetValue('PledgePayment', [
3893       'options' => ['limit' => 1],
3894       'return' => 'id',
3895     ]);
3896     $this->callAPISuccess('PledgePayment', 'create', [
3897       'id' => $paymentID,
3898       'contribution_id' =>
3899       $contribution['id'],
3900       'status_id' => 'Pending',
3901       'scheduled_amount' => 500,
3902     ]);
3903
3904     return $contribution['id'];
3905   }
3906
3907   /**
3908    * Create a pending contribution & linked pending participant record (along
3909    * with an event).
3910    *
3911    * @throws \CRM_Core_Exception
3912    */
3913   public function createPendingParticipantContribution() {
3914     $this->_ids['event']['test'] = $this->eventCreate(['is_email_confirm' => 1, 'confirm_from_email' => 'test@civicrm.org'])['id'];
3915     $participantID = $this->participantCreate(['event_id' => $this->_ids['event']['test'], 'status_id' => 6, 'contact_id' => $this->_individualId]);
3916     $this->_ids['participant'] = $participantID;
3917     $params = array_merge($this->_params, ['contact_id' => $this->_individualId, 'contribution_status_id' => 2, 'financial_type_id' => 'Event Fee']);
3918     $contribution = $this->callAPISuccess('contribution', 'create', $params);
3919     $this->callAPISuccess('participant_payment', 'create', [
3920       'contribution_id' => $contribution['id'],
3921       'participant_id' => $participantID,
3922     ]);
3923     $this->callAPISuccess('line_item', 'get', [
3924       'entity_id' => $contribution['id'],
3925       'entity_table' => 'civicrm_contribution',
3926       'api.line_item.create' => [
3927         'entity_id' => $participantID,
3928         'entity_table' => 'civicrm_participant',
3929       ],
3930     ]);
3931     return $contribution['id'];
3932   }
3933
3934   /**
3935    * Get financial transaction amount.
3936    *
3937    * @param int $contId
3938    *
3939    * @return null|string
3940    */
3941   public function _getFinancialTrxnAmount($contId) {
3942     $query = "SELECT
3943      SUM( ft.total_amount ) AS total
3944      FROM civicrm_financial_trxn AS ft
3945      LEFT JOIN civicrm_entity_financial_trxn AS ceft ON ft.id = ceft.financial_trxn_id
3946      WHERE ceft.entity_table = 'civicrm_contribution'
3947      AND ceft.entity_id = {$contId}";
3948
3949     return CRM_Core_DAO::singleValueQuery($query);
3950   }
3951
3952   /**
3953    * @param int $contId
3954    *
3955    * @return null|string
3956    */
3957   public function _getFinancialItemAmount($contId) {
3958     $lineItem = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
3959     $query = "SELECT
3960      SUM(amount)
3961      FROM civicrm_financial_item
3962      WHERE entity_table = 'civicrm_line_item'
3963      AND entity_id = {$lineItem}";
3964     return CRM_Core_DAO::singleValueQuery($query);
3965   }
3966
3967   /**
3968    * @param int $contId
3969    * @param $context
3970    */
3971   public function _checkFinancialItem($contId, $context) {
3972     if ($context !== 'paylater') {
3973       $params = [
3974         'entity_id' => $contId,
3975         'entity_table' => 'civicrm_contribution',
3976       ];
3977       $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($params, TRUE));
3978       $entityParams = [
3979         'financial_trxn_id' => $trxn['financial_trxn_id'],
3980         'entity_table' => 'civicrm_financial_item',
3981       ];
3982       $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
3983       $params = [
3984         'id' => $entityTrxn['entity_id'],
3985       ];
3986     }
3987     if ($context === 'paylater') {
3988       $lineItems = CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution');
3989       foreach ($lineItems as $key => $item) {
3990         $params = [
3991           'entity_id' => $key,
3992           'entity_table' => 'civicrm_line_item',
3993         ];
3994         $compareParams = ['status_id' => 1];
3995         $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
3996       }
3997     }
3998     elseif ($context === 'refund') {
3999       $compareParams = [
4000         'status_id' => 1,
4001         'financial_account_id' => 1,
4002         'amount' => -100,
4003       ];
4004     }
4005     elseif ($context === 'cancelPending') {
4006       $compareParams = [
4007         'status_id' => 3,
4008         'financial_account_id' => 1,
4009         'amount' => -100,
4010       ];
4011     }
4012     elseif ($context === 'changeFinancial') {
4013       $lineKey = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
4014       $params = [
4015         'entity_id' => $lineKey,
4016         'amount' => -100,
4017       ];
4018       $compareParams = [
4019         'financial_account_id' => 1,
4020       ];
4021       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
4022       $params = [
4023         'financial_account_id' => 3,
4024         'entity_id' => $lineKey,
4025       ];
4026       $compareParams = [
4027         'amount' => 100,
4028       ];
4029     }
4030     if ($context !== 'paylater') {
4031       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
4032     }
4033   }
4034
4035   /**
4036    * Check correct financial transaction entries were created for the change in payment instrument.
4037    *
4038    * @param int $contributionID
4039    * @param int $originalInstrumentID
4040    * @param int $newInstrumentID
4041    * @param int $amount
4042    */
4043   public function checkFinancialTrxnPaymentInstrumentChange($contributionID, $originalInstrumentID, $newInstrumentID, $amount = 100) {
4044
4045     $entityFinancialTrxns = $this->getFinancialTransactionsForContribution($contributionID);
4046
4047     $originalTrxnParams = [
4048       'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($originalInstrumentID),
4049       'payment_instrument_id' => $originalInstrumentID,
4050       'amount' => $amount,
4051       'status_id' => 1,
4052     ];
4053
4054     $reversalTrxnParams = [
4055       'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($originalInstrumentID),
4056       'payment_instrument_id' => $originalInstrumentID,
4057       'amount' => -$amount,
4058       'status_id' => 1,
4059     ];
4060
4061     $newTrxnParams = [
4062       'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($newInstrumentID),
4063       'payment_instrument_id' => $newInstrumentID,
4064       'amount' => $amount,
4065       'status_id' => 1,
4066     ];
4067
4068     foreach ([$originalTrxnParams, $reversalTrxnParams, $newTrxnParams] as $index => $transaction) {
4069       $entityFinancialTrxn = $entityFinancialTrxns[$index];
4070       $this->assertEquals($entityFinancialTrxn['amount'], $transaction['amount']);
4071
4072       $financialTrxn = $this->callAPISuccessGetSingle('FinancialTrxn', [
4073         'id' => $entityFinancialTrxn['financial_trxn_id'],
4074       ]);
4075       $this->assertEquals($transaction['status_id'], $financialTrxn['status_id']);
4076       $this->assertEquals($transaction['amount'], $financialTrxn['total_amount']);
4077       $this->assertEquals($transaction['amount'], $financialTrxn['net_amount']);
4078       $this->assertEquals(0, $financialTrxn['fee_amount']);
4079       $this->assertEquals($transaction['payment_instrument_id'], $financialTrxn['payment_instrument_id']);
4080       $this->assertEquals($transaction['to_financial_account_id'], $financialTrxn['to_financial_account_id']);
4081
4082       // Generic checks.
4083       $this->assertEquals(1, $financialTrxn['is_payment']);
4084       $this->assertEquals('USD', $financialTrxn['currency']);
4085       $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($financialTrxn['trxn_date'])));
4086     }
4087   }
4088
4089   /**
4090    * Check financial transaction.
4091    *
4092    * @todo break this down into sensible functions - most calls to it only use a few lines out of the big if.
4093    *
4094    * @param array $contribution
4095    * @param string $context
4096    * @param int $instrumentId
4097    * @param array $extraParams
4098    */
4099   public function _checkFinancialTrxn($contribution, $context, $instrumentId = NULL, $extraParams = []) {
4100     $financialTrxns = $this->getFinancialTransactionsForContribution($contribution['id']);
4101     $trxn = array_pop($financialTrxns);
4102
4103     $params = [
4104       'id' => $trxn['financial_trxn_id'],
4105     ];
4106     if ($context === 'payLater') {
4107       $compareParams = [
4108         'status_id' => 1,
4109         'from_financial_account_id' => CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($contribution['financial_type_id'], 'Accounts Receivable Account is'),
4110       ];
4111     }
4112     elseif ($context === 'refund') {
4113       $compareParams = [
4114         'to_financial_account_id' => 6,
4115         'total_amount' => -100,
4116         'status_id' => 7,
4117         'trxn_date' => '2015-01-01 09:00:00',
4118         'trxn_id' => 'the refund',
4119       ];
4120     }
4121     elseif ($context === 'cancelPending') {
4122       $compareParams = [
4123         'to_financial_account_id' => 7,
4124         'total_amount' => -100,
4125         'status_id' => 3,
4126       ];
4127     }
4128     elseif ($context === 'changeFinancial' || $context === 'paymentInstrument') {
4129       // @todo checkFinancialTrxnPaymentInstrumentChange instead for paymentInstrument.
4130       // It does the same thing with greater readability.
4131       // @todo remove handling for
4132
4133       $entityParams = [
4134         'entity_id' => $contribution['id'],
4135         'entity_table' => 'civicrm_contribution',
4136         'amount' => -100,
4137       ];
4138       $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
4139       $trxnParams1 = [
4140         'id' => $trxn['financial_trxn_id'],
4141       ];
4142       if (empty($extraParams)) {
4143         $compareParams = [
4144           'total_amount' => -100,
4145           'status_id' => 1,
4146         ];
4147       }
4148       elseif ($context !== 'changeFinancial') {
4149         $compareParams = [
4150           'total_amount' => 100,
4151           'status_id' => 1,
4152         ];
4153       }
4154       if ($context === 'paymentInstrument') {
4155         $compareParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($instrumentId);
4156         $compareParams['payment_instrument_id'] = $instrumentId;
4157       }
4158       else {
4159         $compareParams['to_financial_account_id'] = 12;
4160       }
4161       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams1, array_merge($compareParams, $extraParams));
4162       $compareParams['total_amount'] = 100;
4163       // Reverse the extra params now that we will be checking the new positive transaction.
4164       if ($context === 'changeFinancial' && !empty($extraParams)) {
4165         foreach ($extraParams as $param => $value) {
4166           $extraParams[$param] = 0 - $value;
4167         }
4168       }
4169     }
4170
4171     $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $params, array_merge($compareParams, $extraParams));
4172   }
4173
4174   /**
4175    * @return mixed
4176    */
4177   public function _addPaymentInstrument() {
4178     $gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'payment_instrument', 'id', 'name');
4179     $optionParams = [
4180       'option_group_id' => $gId,
4181       'label' => 'Test Card',
4182       'name' => 'Test Card',
4183       'value' => '6',
4184       'weight' => '6',
4185       'is_active' => 1,
4186     ];
4187     $optionValue = $this->callAPISuccess('option_value', 'create', $optionParams);
4188     $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
4189     $financialParams = [
4190       'entity_table' => 'civicrm_option_value',
4191       'entity_id' => $optionValue['id'],
4192       'account_relationship' => $relationTypeId,
4193       'financial_account_id' => 7,
4194     ];
4195     CRM_Financial_BAO_FinancialTypeAccount::add($financialParams);
4196     $this->assertNotEmpty($optionValue['values'][$optionValue['id']]['value']);
4197     return $optionValue['values'][$optionValue['id']]['value'];
4198   }
4199
4200   public function _deletedAddedPaymentInstrument() {
4201     $result = $this->callAPISuccess('OptionValue', 'get', [
4202       'option_group_id' => 'payment_instrument',
4203       'name' => 'Test Card',
4204       'value' => '6',
4205       'is_active' => 1,
4206     ]);
4207     if ($id = CRM_Utils_Array::value('id', $result)) {
4208       $this->callAPISuccess('OptionValue', 'delete', ['id' => $id]);
4209     }
4210   }
4211
4212   /**
4213    * Set up the basic recurring contribution for tests.
4214    *
4215    * @param array $generalParams
4216    *   Parameters that can be merged into the recurring AND the contribution.
4217    *
4218    * @param array $recurParams
4219    *   Parameters to merge into the recur only.
4220    *
4221    * @return array|int
4222    * @throws \CRM_Core_Exception
4223    */
4224   protected function setUpRecurringContribution($generalParams = [], $recurParams = []) {
4225     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
4226       'contact_id' => $this->_individualId,
4227       'installments' => '12',
4228       'frequency_interval' => '1',
4229       'amount' => '100',
4230       'contribution_status_id' => 1,
4231       'start_date' => '2012-01-01 00:00:00',
4232       'currency' => 'USD',
4233       'frequency_unit' => 'month',
4234       'payment_processor_id' => $this->paymentProcessorID,
4235     ], $generalParams, $recurParams));
4236     $contributionParams = array_merge(
4237       $this->_params,
4238       [
4239         'contribution_recur_id' => $contributionRecur['id'],
4240         'contribution_status_id' => 'Pending',
4241       ], $generalParams);
4242     $contributionParams['api.Payment.create'] = ['total_amount' => $contributionParams['total_amount']];
4243     $originalContribution = $this->callAPISuccess('Order', 'create', $contributionParams);
4244     return $originalContribution;
4245   }
4246
4247   /**
4248    * Set up a basic auto-renew membership for tests.
4249    *
4250    * @param array $generalParams
4251    *   Parameters that can be merged into the recurring AND the contribution.
4252    *
4253    * @param array $recurParams
4254    *   Parameters to merge into the recur only.
4255    *
4256    * @return array|int
4257    * @throws \CRM_Core_Exception
4258    */
4259   protected function setUpAutoRenewMembership($generalParams = [], $recurParams = []) {
4260     $newContact = $this->callAPISuccess('Contact', 'create', [
4261       'contact_type' => 'Individual',
4262       'sort_name' => 'McTesterson, Testy',
4263       'display_name' => 'Testy McTesterson',
4264       'preferred_language' => 'en_US',
4265       'preferred_mail_format' => 'Both',
4266       'first_name' => 'Testy',
4267       'last_name' => 'McTesterson',
4268       'contact_is_deleted' => '0',
4269       'email_id' => '4',
4270       'email' => 'tmctesterson@example.com',
4271       'on_hold' => '0',
4272     ]);
4273     $membershipType = $this->callAPISuccess('MembershipType', 'create', [
4274       'domain_id' => 'Default Domain Name',
4275       'member_of_contact_id' => 1,
4276       'financial_type_id' => 'Member Dues',
4277       'duration_unit' => 'month',
4278       'duration_interval' => 1,
4279       'period_type' => 'rolling',
4280       'name' => 'Standard Member',
4281       'minimum_fee' => 100,
4282     ]);
4283     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
4284       'contact_id' => $newContact['id'],
4285       'installments' => '12',
4286       'frequency_interval' => '1',
4287       'amount' => '100',
4288       'contribution_status_id' => 1,
4289       'start_date' => '2012-01-01 00:00:00',
4290       'currency' => 'USD',
4291       'frequency_unit' => 'month',
4292       'payment_processor_id' => $this->paymentProcessorID,
4293     ], $generalParams, $recurParams));
4294
4295     $originalContribution = $this->callAPISuccess('Order', 'create', array_merge(
4296       $this->_params,
4297       [
4298         'contact_id' => $newContact['id'],
4299         'contribution_recur_id' => $contributionRecur['id'],
4300         'financial_type_id' => 'Member Dues',
4301         'api.Payment.create' => ['total_amount' => 100, 'payment_instrument_id' => 'Credit card'],
4302         'invoice_id' => 2345,
4303         'line_items' => [
4304           [
4305             'line_item' => [
4306               [
4307                 'membership_type_id' => $membershipType['id'],
4308                 'financial_type_id' => 'Member Dues',
4309                 'line_total' => $generalParams['total_amount'] ?? 100,
4310               ],
4311             ],
4312             'params' => [
4313               'contact_id' => $newContact['id'],
4314               'contribution_recur_id' => $contributionRecur['id'],
4315               'membership_type_id' => $membershipType['id'],
4316               'num_terms' => 1,
4317             ],
4318           ],
4319         ],
4320       ], $generalParams)
4321     );
4322     $lineItem = $this->callAPISuccess('LineItem', 'getsingle', []);
4323     $this->assertEquals('civicrm_membership', $lineItem['entity_table']);
4324     $membership = $this->callAPISuccess('Membership', 'getsingle', ['id' => $lineItem['entity_id']]);
4325     $this->callAPISuccess('LineItem', 'getsingle', []);
4326     $this->callAPISuccessGetCount('MembershipPayment', ['membership_id' => $membership['id']], 1);
4327
4328     return [$originalContribution, $membership];
4329   }
4330
4331   /**
4332    * Set up a repeat transaction.
4333    *
4334    * @param array $recurParams
4335    * @param string $flag
4336    * @param array $contributionParams
4337    *
4338    * @return array
4339    */
4340   protected function setUpRepeatTransaction(array $recurParams, $flag, array $contributionParams = []) {
4341     $paymentProcessorID = $this->paymentProcessorCreate();
4342     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
4343       'contact_id' => $this->_individualId,
4344       'installments' => '12',
4345       'frequency_interval' => '1',
4346       'amount' => '500',
4347       'contribution_status_id' => 1,
4348       'start_date' => '2012-01-01 00:00:00',
4349       'currency' => 'USD',
4350       'frequency_unit' => 'month',
4351       'payment_processor_id' => $paymentProcessorID,
4352     ], $recurParams));
4353
4354     $originalContribution = '';
4355     if ($flag === 'multiple') {
4356       // CRM-19309 create a contribution + also add in line_items (plural):
4357       $this->createContributionWithTwoLineItemsAgainstPriceSet([
4358         'contact_id' => $this->_individualId,
4359         'contribution_recur_id' => $contributionRecur['id'],
4360       ]);
4361       $originalContribution = $this->callAPISuccessGetSingle('Contribution', ['contribution_recur_id' => $contributionRecur['id'], 'return' => 'id']);
4362     }
4363     elseif ($flag === 'single') {
4364       $params = array_merge($this->_params, ['contribution_recur_id' => $contributionRecur['id']]);
4365       $params = array_merge($params, $contributionParams);
4366       $originalContribution = $this->callAPISuccess('Order', 'create', $params);
4367       // Note the saved contribution amount will include tax.
4368       $this->callAPISuccess('Payment', 'create', [
4369         'contribution_id' => $originalContribution['id'],
4370         'total_amount' => $originalContribution['values'][$originalContribution['id']]['total_amount'],
4371       ]);
4372     }
4373     $originalContribution['contribution_recur_id'] = $contributionRecur['id'];
4374     $originalContribution['payment_processor_id'] = $paymentProcessorID;
4375     return $originalContribution;
4376   }
4377
4378   /**
4379    * Common set up routine.
4380    *
4381    * @return array
4382    * @throws \CRM_Core_Exception
4383    */
4384   protected function setUpForCompleteTransaction(): array {
4385     $this->mut = new CiviMailUtils($this, TRUE);
4386     $this->createLoggedInUser();
4387     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'receipt_date' => 'now']);
4388     return $this->callAPISuccess('Contribution', 'create', $params);
4389   }
4390
4391   /**
4392    * Test repeat contribution uses the Payment Processor' payment_instrument setting.
4393    *
4394    * @throws \CRM_Core_Exception
4395    */
4396   public function testRepeatTransactionWithNonCreditCardDefault() {
4397     $contributionRecur = $this->callAPISuccess('ContributionRecur', 'create', [
4398       'contact_id' => $this->_individualId,
4399       'installments' => '12',
4400       'frequency_interval' => '1',
4401       'amount' => '100',
4402       'contribution_status_id' => 1,
4403       'start_date' => '2012-01-01 00:00:00',
4404       'currency' => 'USD',
4405       'frequency_unit' => 'month',
4406       'payment_processor_id' => $this->paymentProcessorID,
4407     ]);
4408     $contribution1 = $this->callAPISuccess('contribution', 'create', array_merge(
4409         $this->_params,
4410         ['contribution_recur_id' => $contributionRecur['id'], 'payment_instrument_id' => 2])
4411     );
4412     $contribution2 = $this->callAPISuccess('contribution', 'repeattransaction', [
4413       'contribution_status_id' => 'Completed',
4414       'trxn_id' => 'blah',
4415       'original_contribution_id' => $contribution1,
4416     ]);
4417     $this->assertEquals('Debit Card', CRM_Contribute_PseudoConstant::getLabel('CRM_Contribute_BAO_Contribution', 'payment_instrument_id', $contribution2['values'][$contribution2['id']]['payment_instrument_id']));
4418   }
4419
4420   /**
4421    * CRM-20008 Tests repeattransaction creates pending membership.
4422    *
4423    * @throws \CRM_Core_Exception
4424    */
4425   public function testRepeatTransactionMembershipCreatePendingContribution(): void {
4426     [$originalContribution, $membership] = $this->setUpAutoRenewMembership();
4427     $this->callAPISuccess('membership', 'create', [
4428       'id' => $membership['id'],
4429       'end_date' => 'yesterday',
4430       'status_id' => 'Expired',
4431     ]);
4432     $repeatedContribution = $this->callAPISuccess('contribution', 'repeattransaction', [
4433       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
4434       'contribution_status_id' => 'Pending',
4435       'trxn_id' => 1234,
4436     ]);
4437     $membershipStatusId = $this->callAPISuccess('membership', 'getvalue', [
4438       'id' => $membership['id'],
4439       'return' => 'status_id',
4440     ]);
4441
4442     // Let's see if the membership payments got created while we're at it.
4443     $membershipPayments = $this->callAPISuccess('MembershipPayment', 'get', [
4444       'membership_id' => $membership['id'],
4445     ]);
4446     $this->assertEquals(2, $membershipPayments['count']);
4447
4448     $this->assertEquals('Expired', CRM_Core_PseudoConstant::getLabel('CRM_Member_BAO_Membership', 'status_id', $membershipStatusId));
4449     $this->callAPISuccess('Contribution', 'completetransaction', ['id' => $repeatedContribution['id']]);
4450     $membership = $this->callAPISuccessGetSingle('membership', [
4451       'id' => $membership['id'],
4452       'return' => 'status_id, end_date',
4453     ]);
4454     $this->assertEquals('New', CRM_Core_PseudoConstant::getName('CRM_Member_BAO_Membership', 'status_id', $membership['status_id']));
4455     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 1 month')), $membership['end_date']);
4456   }
4457
4458   /**
4459    * Test sending a mail via the API.
4460    *
4461    * @throws \CRM_Core_Exception
4462    */
4463   public function testSendMailWithAPISetFromDetails() {
4464     $mut = new CiviMailUtils($this, TRUE);
4465     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
4466     $this->callAPISuccess('contribution', 'sendconfirmation', [
4467       'id' => $contribution['id'],
4468       'receipt_from_email' => 'api@civicrm.org',
4469       'receipt_from_name' => 'CiviCRM LLC',
4470     ]);
4471     $mut->checkMailLog([
4472       'From: CiviCRM LLC <api@civicrm.org>',
4473       'Contribution Information',
4474     ], [
4475       'Event',
4476     ]);
4477     $mut->stop();
4478   }
4479
4480   /**
4481    * Test sending a mail via the API.
4482    */
4483   public function testSendMailWithNoFromSetFallToDomain() {
4484     $this->createLoggedInUser();
4485     $mut = new CiviMailUtils($this, TRUE);
4486     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
4487     $this->callAPISuccess('contribution', 'sendconfirmation', [
4488       'id' => $contribution['id'],
4489     ]);
4490     $domain = $this->callAPISuccess('domain', 'getsingle', ['id' => 1]);
4491     $mut->checkMailLog([
4492       'From: ' . $domain['from_name'] . ' <' . $domain['from_email'] . '>',
4493       'Contribution Information',
4494     ], [
4495       'Event',
4496     ]);
4497     $mut->stop();
4498   }
4499
4500   /**
4501    * Test sending a mail via the API.
4502    *
4503    * @throws \CRM_Core_Exception
4504    */
4505   public function testSendMailWithRepeatTransactionAPIFalltoDomain() {
4506     $this->createLoggedInUser();
4507     $mut = new CiviMailUtils($this, TRUE);
4508     $contribution = $this->setUpRepeatTransaction([], 'single');
4509     $this->callAPISuccess('contribution', 'repeattransaction', [
4510       'contribution_status_id' => 'Completed',
4511       'trxn_id' => 7890,
4512       'original_contribution_id' => $contribution,
4513     ]);
4514     $domain = $this->callAPISuccess('domain', 'getsingle', ['id' => 1]);
4515     $mut->checkMailLog([
4516       'From: ' . $domain['from_name'] . ' <' . $domain['from_email'] . '>',
4517       'Contribution Information',
4518     ], [
4519       'Event',
4520     ]
4521     );
4522     $mut->stop();
4523   }
4524
4525   /**
4526    * Test sending a mail via the API.
4527    *
4528    * @throws \CRM_Core_Exception
4529    */
4530   public function testSendMailWithRepeatTransactionAPIFalltoContributionPage() {
4531     $mut = new CiviMailUtils($this, TRUE);
4532     $contributionPage = $this->contributionPageCreate(['receipt_from_name' => 'CiviCRM LLC', 'receipt_from_email' => 'contributionpage@civicrm.org', 'is_email_receipt' => 1]);
4533     $paymentProcessorID = $this->paymentProcessorCreate();
4534     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
4535       'contact_id' => $this->_individualId,
4536       'installments' => '12',
4537       'frequency_interval' => '1',
4538       'amount' => '500',
4539       'contribution_status_id' => 1,
4540       'start_date' => '2012-01-01 00:00:00',
4541       'currency' => 'USD',
4542       'frequency_unit' => 'month',
4543       'payment_processor_id' => $paymentProcessorID,
4544     ]);
4545     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
4546       $this->_params,
4547       [
4548         'contribution_recur_id' => $contributionRecur['id'],
4549         'contribution_page_id' => $contributionPage['id'],
4550       ])
4551     );
4552     $this->callAPISuccess('Contribution', 'repeattransaction', [
4553       'contribution_status_id' => 'Completed',
4554       'trxn_id' => 5678,
4555       'original_contribution_id' => $originalContribution,
4556     ]
4557     );
4558     $mut->checkMailLog([
4559       'From: CiviCRM LLC <contributionpage@civicrm.org>',
4560       'Contribution Information',
4561     ], [
4562       'Event',
4563     ]);
4564     $mut->stop();
4565   }
4566
4567   /**
4568    * Test sending a mail via the API.
4569    *
4570    * @throws \CRM_Core_Exception
4571    */
4572   public function testSendMailWithRepeatTransactionAPIFalltoSystemFromNoDefaultFrom(): void {
4573     $mut = new CiviMailUtils($this, TRUE);
4574     $originalContribution = $this->setUpRepeatTransaction([], 'single');
4575     $fromEmail = $this->callAPISuccess('optionValue', 'get', ['is_default' => 1, 'option_group_id' => 'from_email_address', 'sequential' => 1]);
4576     foreach ($fromEmail['values'] as $from) {
4577       $this->callAPISuccess('optionValue', 'create', ['is_default' => 0, 'id' => $from['id']]);
4578     }
4579     $domain = $this->callAPISuccess('domain', 'getsingle', ['id' => CRM_Core_Config::domainID()]);
4580     $this->callAPISuccess('contribution', 'repeattransaction', [
4581       'contribution_status_id' => 'Completed',
4582       'trxn_id' => 4567,
4583       'original_contribution_id' => $originalContribution,
4584     ]);
4585     $mut->checkMailLog([
4586       'From: ' . $domain['name'] . ' <' . $domain['domain_email'] . '>',
4587       'Contribution Information',
4588     ], [
4589       'Event',
4590     ]);
4591     $mut->stop();
4592   }
4593
4594   /**
4595    * Create a Contribution Page with is_email_receipt = TRUE.
4596    *
4597    * @param array $params
4598    *   Params to overwrite with.
4599    *
4600    * @return array|int
4601    */
4602   protected function createReceiptableContributionPage($params = []) {
4603     $contributionPage = $this->callAPISuccess('ContributionPage', 'create', array_merge([
4604       'receipt_from_name' => 'Mickey Mouse',
4605       'receipt_from_email' => 'mickey@mouse.com',
4606       'title' => "Test Contribution Page",
4607       'financial_type_id' => 1,
4608       'currency' => 'CAD',
4609       'is_monetary' => TRUE,
4610       'is_email_receipt' => TRUE,
4611     ], $params));
4612     return $contributionPage;
4613   }
4614
4615   /**
4616    * function to test card_type and pan truncation.
4617    *
4618    * @throws \CRM_Core_Exception
4619    */
4620   public function testCardTypeAndPanTruncation() {
4621     $creditCardTypeIDs = array_flip(CRM_Financial_DAO_FinancialTrxn::buildOptions('card_type_id'));
4622     $contactId = $this->individualCreate();
4623     $params = [
4624       'contact_id' => $contactId,
4625       'receive_date' => '2016-01-20',
4626       'total_amount' => 100,
4627       'financial_type_id' => 1,
4628       'payment_instrument' => 'Credit Card',
4629       'card_type_id' => $creditCardTypeIDs['Visa'],
4630       'pan_truncation' => 4567,
4631     ];
4632     $contribution = $this->callAPISuccess('contribution', 'create', $params);
4633     $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contribution['id'], 'DESC');
4634     $financialTrxn = $this->callAPISuccessGetSingle(
4635       'FinancialTrxn',
4636       [
4637         'id' => $lastFinancialTrxnId['financialTrxnId'],
4638         'return' => ['card_type_id', 'pan_truncation'],
4639       ]
4640     );
4641     $this->assertEquals(CRM_Utils_Array::value('card_type_id', $financialTrxn), $creditCardTypeIDs['Visa']);
4642     $this->assertEquals(CRM_Utils_Array::value('pan_truncation', $financialTrxn), 4567);
4643     $params = [
4644       'id' => $contribution['id'],
4645       'pan_truncation' => 2345,
4646       'card_type_id' => $creditCardTypeIDs['Amex'],
4647     ];
4648     $this->callAPISuccess('contribution', 'create', $params);
4649     $financialTrxn = $this->callAPISuccessGetSingle(
4650       'FinancialTrxn',
4651       [
4652         'id' => $lastFinancialTrxnId['financialTrxnId'],
4653         'return' => ['card_type_id', 'pan_truncation'],
4654       ]
4655     );
4656     $this->assertEquals(CRM_Utils_Array::value('card_type_id', $financialTrxn), $creditCardTypeIDs['Amex']);
4657     $this->assertEquals(CRM_Utils_Array::value('pan_truncation', $financialTrxn), 2345);
4658   }
4659
4660   /**
4661    * Test repeat contribution uses non default currency
4662    *
4663    * @see https://issues.civicrm.org/jira/projects/CRM/issues/CRM-20678
4664    * @throws \CRM_Core_Exception
4665    */
4666   public function testRepeatTransactionWithDifferenceCurrency() {
4667     $originalContribution = $this->setUpRepeatTransaction(['currency' => 'AUD'], 'single', ['currency' => 'AUD']);
4668     $contribution = $this->callAPISuccess('Contribution', 'repeattransaction', [
4669       'original_contribution_id' => $originalContribution['id'],
4670       'contribution_status_id' => 'Completed',
4671       'trxn_id' => 3456,
4672     ]);
4673     $this->assertEquals('AUD', $contribution['values'][$contribution['id']]['currency']);
4674   }
4675
4676   /**
4677    * Get the financial items for the contribution.
4678    *
4679    * @param int $contributionID
4680    *
4681    * @return array
4682    *   Array of associated financial items.
4683    */
4684   protected function getFinancialTransactionsForContribution($contributionID) {
4685     $trxnParams = [
4686       'entity_id' => $contributionID,
4687       'entity_table' => 'civicrm_contribution',
4688     ];
4689     // @todo the following function has naming errors & has a weird signature & appears to
4690     // only be called from test classes. Move into test suite & maybe just use api
4691     // from this function.
4692     return array_merge(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($trxnParams));
4693   }
4694
4695   /**
4696    * Test getunique api call for Contribution entity
4697    */
4698   public function testContributionGetUnique() {
4699     $result = $this->callAPIAndDocument($this->entity, 'getunique', [], __FUNCTION__, __FILE__);
4700     $this->assertEquals(2, $result['count']);
4701     $this->assertEquals(['trxn_id'], $result['values']['UI_contrib_trxn_id']);
4702     $this->assertEquals(['invoice_id'], $result['values']['UI_contrib_invoice_id']);
4703   }
4704
4705   /**
4706    * Test Repeat Transaction Contribution with Tax amount.
4707    *
4708    * https://lab.civicrm.org/dev/core/issues/806
4709    *
4710    * @throws \CRM_Core_Exception
4711    */
4712   public function testRepeatContributionWithTaxAmount(): void {
4713     $this->enableTaxAndInvoicing();
4714     $financialType = $this->callAPISuccess('financial_type', 'create', [
4715       'name' => 'Test taxable financial Type',
4716       'is_reserved' => 0,
4717       'is_active' => 1,
4718     ]);
4719     $this->addTaxAccountToFinancialType($financialType['id']);
4720     $contribution = $this->setUpRepeatTransaction(
4721       [],
4722       'single',
4723       [
4724         'financial_type_id' => $financialType['id'],
4725       ]
4726     );
4727     $this->callAPISuccess('contribution', 'repeattransaction', [
4728       'original_contribution_id' => $contribution['id'],
4729       'contribution_status_id' => 'Completed',
4730       'trxn_id' => 'test',
4731     ]);
4732     $payments = $this->callAPISuccess('Contribution', 'get', ['sequential' => 1, 'return' => ['total_amount', 'tax_amount']])['values'];
4733     //Assert if first payment and repeated payment has the same contribution amount.
4734     $this->assertEquals($payments[0]['total_amount'], $payments[1]['total_amount']);
4735     $this->callAPISuccessGetCount('Contribution', [], 2);
4736
4737     //Assert line item records.
4738     $lineItems = $this->callAPISuccess('LineItem', 'get', ['sequential' => 1])['values'];
4739     foreach ($lineItems as $lineItem) {
4740       $taxExclusiveAmount = $payments[0]['total_amount'] - $payments[0]['tax_amount'];
4741       $this->assertEquals($lineItem['unit_price'], $taxExclusiveAmount);
4742       $this->assertEquals($lineItem['line_total'], $taxExclusiveAmount);
4743     }
4744     $this->callAPISuccessGetCount('Contribution', [], 2);
4745   }
4746
4747   public function testGetCurrencyOptions() {
4748     $result = $this->callAPISuccess('Contribution', 'getoptions', [
4749       'field' => 'currency',
4750     ]);
4751     $this->assertEquals('US Dollar', $result['values']['USD']);
4752     $this->assertNotContains('$', $result['values']);
4753     $result = $this->callAPISuccess('Contribution', 'getoptions', [
4754       'field' => 'currency',
4755       'context' => "abbreviate",
4756     ]);
4757     $this->assertEquals('$', $result['values']['USD']);
4758     $this->assertNotContains('US Dollar', $result['values']);
4759   }
4760
4761   /**
4762    * @throws \API_Exception
4763    * @throws \CRM_Core_Exception
4764    * @throws \Civi\API\Exception\UnauthorizedException
4765    */
4766   public function testSetCustomDataInCreateAndHook() {
4767     $this->createCustomGroupWithFieldOfType([], 'int');
4768     $this->ids['CustomField']['text'] = (int) $this->createTextCustomField(['custom_group_id' => $this->ids['CustomGroup']['Custom Group']])['id'];
4769     $this->hookClass->setHook('civicrm_post', [
4770       $this,
4771       'civicrmPostContributionCustom',
4772     ]);
4773     $params = $this->_params;
4774     $params['custom_' . $this->ids['CustomField']['text']] = 'Some Text';
4775     $contribution = $this->callAPISuccess('Contribution', 'create', $params);
4776     $getContribution = $this->callAPISuccess('Contribution', 'get', [
4777       'id' => $contribution['id'],
4778       'return' => ['id', 'custom_' . $this->ids['CustomField']['text'], 'custom_' . $this->ids['CustomField']['int']],
4779     ]);
4780     $this->assertEquals(5, $getContribution['values'][$contribution['id']][$this->getCustomFieldName('int')]);
4781     $this->assertEquals('Some Text', $getContribution['values'][$contribution['id']]['custom_' . $this->ids['CustomField']['text']]);
4782     $this->callAPISuccess('CustomField', 'delete', ['id' => $this->ids['CustomField']['text']]);
4783     $this->callAPISuccess('CustomField', 'delete', ['id' => $this->ids['CustomField']['int']]);
4784     $this->callAPISuccess('CustomGroup', 'delete', ['id' => $this->ids['CustomGroup']['Custom Group']]);
4785   }
4786
4787   /**
4788    * Implement post hook.
4789    *
4790    * @param string $op
4791    * @param string $objectName
4792    * @param int|null $objectId
4793    *
4794    * @throws \CRM_Core_Exception
4795    */
4796   public function civicrmPostContributionCustom(string $op, string $objectName, ?int $objectId): void {
4797     if ($objectName === 'Contribution' && $op === 'create') {
4798       $this->callAPISuccess('Contribution', 'create', [
4799         'id' => $objectId,
4800         'custom_' . $this->ids['CustomField']['int'] => 5,
4801       ]);
4802     }
4803   }
4804
4805   /**
4806    * Test that passing in label for an option value linked to a custom field
4807    * works
4808    *
4809    * @see dev/core#1816
4810    *
4811    * @throws \API_Exception
4812    * @throws \CRM_Core_Exception
4813    */
4814   public function testCustomValueOptionLabelTest(): void {
4815     $this->createCustomGroupWithFieldOfType([], 'radio');
4816     $params = $this->_params;
4817     $params['custom_' . $this->ids['CustomField']['radio']] = 'Red Testing';
4818     $this->callAPISuccess('Contribution', 'Create', $params);
4819   }
4820
4821   /**
4822    * Test repeatTransaction with installments and next_sched_contribution_date
4823    *
4824    * @dataProvider getRepeatTransactionNextSchedData
4825    *
4826    * @param array $dataSet
4827    *
4828    * @throws \CRM_Core_Exception
4829    */
4830   public function testRepeatTransactionUpdateNextSchedContributionDate(array $dataSet): void {
4831     $paymentProcessorID = $this->paymentProcessorCreate();
4832     // Create the contribution before the recur so it doesn't trigger the update of next_sched_contribution_date
4833     $contribution = $this->callAPISuccess('contribution', 'create', array_merge(
4834         $this->_params,
4835         [
4836           'contribution_status_id' => 'Completed',
4837           'receive_date' => $dataSet['repeat'][0]['receive_date'],
4838         ])
4839     );
4840     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
4841       'contact_id' => $this->_individualId,
4842       'frequency_interval' => '1',
4843       'amount' => '500',
4844       'contribution_status_id' => 'Pending',
4845       'start_date' => '2012-01-01 00:00:00',
4846       'currency' => 'USD',
4847       'frequency_unit' => 'month',
4848       'payment_processor_id' => $paymentProcessorID,
4849     ], $dataSet['recur']));
4850     // Link the existing contribution to the recur *after* creating the recur.
4851     // If we just created the contribution now the next_sched_contribution_date would be automatically set
4852     //   and we want to test the case when it is empty.
4853     $this->callAPISuccess('contribution', 'create', [
4854       'id' => $contribution['id'],
4855       'contribution_recur_id' => $contributionRecur['id'],
4856     ]);
4857
4858     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
4859       'id' => $contributionRecur['id'],
4860       'return' => ['next_sched_contribution_date', 'contribution_status_id'],
4861     ]);
4862     // Check that next_sched_contribution_date is empty
4863     $this->assertEquals('', $contributionRecur['next_sched_contribution_date'] ?? '');
4864
4865     $this->callAPISuccess('Contribution', 'repeattransaction', [
4866       'contribution_status_id' => 'Completed',
4867       'contribution_recur_id' => $contributionRecur['id'],
4868       'receive_date' => $dataSet['repeat'][0]['receive_date'],
4869     ]);
4870     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
4871       'id' => $contributionRecur['id'],
4872       'return' => ['next_sched_contribution_date', 'contribution_status_id'],
4873     ]);
4874     // Check that recur has status "In Progress"
4875     $this->assertEquals(
4876       (string) CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', $dataSet['repeat'][0]['expectedRecurStatus']),
4877       $contributionRecur['contribution_status_id']
4878     );
4879     // Check that next_sched_contribution_date has been set to 1 period after the contribution receive date (ie. 1 month)
4880     $this->assertEquals($dataSet['repeat'][0]['expectedNextSched'], $contributionRecur['next_sched_contribution_date']);
4881
4882     // Now call Contribution.repeattransaction again and check that the next_sched_contribution_date has moved forward by 1 period again
4883     $this->callAPISuccess('Contribution', 'repeattransaction', [
4884       'contribution_status_id' => 'Completed',
4885       'contribution_recur_id' => $contributionRecur['id'],
4886       'receive_date' => $dataSet['repeat'][1]['receive_date'],
4887     ]);
4888     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
4889       'id' => $contributionRecur['id'],
4890       'return' => ['next_sched_contribution_date', 'contribution_status_id'],
4891     ]);
4892     // Check that recur has status "In Progress" or "Completed" depending on whether number of installments has been reached
4893     $this->assertEquals(
4894       (string) CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', $dataSet['repeat'][1]['expectedRecurStatus']),
4895       $contributionRecur['contribution_status_id']
4896     );
4897     // Check that next_sched_contribution_date has been set to 1 period after the contribution receive date (ie. 1 month)
4898     $this->assertEquals($dataSet['repeat'][1]['expectedNextSched'], $contributionRecur['next_sched_contribution_date'] ?? '');
4899   }
4900
4901   /**
4902    * Get dates for testing.
4903    *
4904    * @return array
4905    */
4906   public function getRepeatTransactionNextSchedData(): array {
4907     // Both these tests handle/test the case that next_sched_contribution_date is empty when Contribution.repeattransaction
4908     //   is called for the first time. Historically setting it was inconsistent but on new updates it should always be set.
4909     /*
4910      * This tests that calling Contribution.repeattransaction with installments does the following:
4911      * - For the first call to repeattransaction the recur status is In Progress and next_sched_contribution_date is updated
4912      *   to match next expected receive_date.
4913      * - Once the 3rd contribution is created contributionRecur status = completed and next_sched_contribution_date = ''.
4914      */
4915     $result['receive_date_includes_time_with_installments']['2012-01-01-1-month'] = [
4916       'recur' => [
4917         'start_date' => '2012-01-01',
4918         'frequency_interval' => 1,
4919         'installments' => '3',
4920         'frequency_unit' => 'month',
4921       ],
4922       'repeat' => [
4923         [
4924           'receive_date' => '2012-02-29 16:00:00',
4925           'expectedNextSched' => '2012-03-29 00:00:00',
4926           'expectedRecurStatus' => 'In Progress',
4927         ],
4928         [
4929           'receive_date' => '2012-03-29 16:00:00',
4930           'expectedNextSched' => '',
4931           'expectedRecurStatus' => 'Completed',
4932         ],
4933       ],
4934     ];
4935     /*
4936      * This tests that calling Contribution.repeattransaction with no installments does the following:
4937      * - For the each call to repeattransaction the recur status is In Progress and next_sched_contribution_date is updated
4938      *   to match next expected receive_date.
4939      */
4940     $result['receive_date_includes_time_no_installments']['2012-01-01-1-month'] = [
4941       'recur' => [
4942         'start_date' => '2012-01-01',
4943         'frequency_interval' => 1,
4944         'frequency_unit' => 'month',
4945       ],
4946       'repeat' => [
4947         [
4948           'receive_date' => '2012-02-29 16:00:00',
4949           'expectedNextSched' => '2012-03-29 00:00:00',
4950           'expectedRecurStatus' => 'In Progress',
4951         ],
4952         [
4953           'receive_date' => '2012-03-29 16:00:00',
4954           'expectedNextSched' => '2012-04-29 00:00:00',
4955           'expectedRecurStatus' => 'In Progress',
4956         ],
4957       ],
4958     ];
4959     return $result;
4960   }
4961
4962   /**
4963    * Make sure that recording a payment doesn't alter the receive_date of a
4964    * pending contribution.
4965    */
4966   public function testPaymentDontChangeReceiveDate(): void {
4967     $params = [
4968       'contact_id' => $this->_individualId,
4969       'total_amount' => 100,
4970       'receive_date' => '2020-02-02',
4971       'contribution_status_id' => 'Pending',
4972     ];
4973     $contributionID = $this->contributionCreate($params);
4974     $paymentParams = [
4975       'contribution_id' => $contributionID,
4976       'total_amount' => 100,
4977       'trxn_date' => '2020-03-04',
4978     ];
4979     $this->callAPISuccess('payment', 'create', $paymentParams);
4980
4981     //check if contribution status is set to "Completed".
4982     $contribution = $this->callAPISuccess('Contribution', 'getSingle', [
4983       'id' => $contributionID,
4984     ]);
4985     $this->assertEquals('2020-02-02 00:00:00', $contribution['receive_date']);
4986   }
4987
4988   /**
4989    * Make sure that recording a payment with Different Payment Instrument update main contribution record payment
4990    * instrument too. If multiple Payment Recorded, last payment record payment (when No more due) instrument set to main
4991    * payment
4992    */
4993   public function testPaymentVerifyPaymentInstrumentChange() {
4994     // Create Pending contribution with pay later mode, with payment instrument Check
4995     $params = [
4996       'contact_id' => $this->_individualId,
4997       'total_amount' => 100,
4998       'receive_date' => '2020-02-02',
4999       'contribution_status_id' => 'Pending',
5000       'is_pay_later' => 1,
5001       'payment_instrument_id' => 'Check',
5002     ];
5003     $contributionID = $this->contributionCreate($params);
5004
5005     // Record the the Payment with instrument other than Check, e.g EFT
5006     $paymentParams = [
5007       'contribution_id' => $contributionID,
5008       'total_amount' => 50,
5009       'trxn_date' => '2020-03-04',
5010       'payment_instrument_id' => 'EFT',
5011     ];
5012     $this->callAPISuccess('payment', 'create', $paymentParams);
5013
5014     $contribution = $this->callAPISuccess('Contribution', 'getSingle', [
5015       'id' => $contributionID,
5016     ]);
5017     // payment status should be 'Partially paid'
5018     $this->assertEquals('Partially paid', $contribution['contribution_status']);
5019
5020     // Record the the Payment with instrument other than Check, e.g Cash (pay all remaining amount)
5021     $paymentParams = [
5022       'contribution_id' => $contributionID,
5023       'total_amount' => 50,
5024       'trxn_date' => '2020-03-04',
5025       'payment_instrument_id' => 'Cash',
5026     ];
5027     $this->callAPISuccess('payment', 'create', $paymentParams);
5028
5029     //check if contribution Payment Instrument (Payment Method) is is set to "Cash".
5030     $contribution = $this->callAPISuccess('Contribution', 'getSingle', [
5031       'id' => $contributionID,
5032     ]);
5033     $this->assertEquals('Cash', $contribution['payment_instrument']);
5034     $this->assertEquals('Completed', $contribution['contribution_status']);
5035   }
5036
5037   /**
5038    * Test the "clean money" functionality.
5039    */
5040   public function testCleanMoney() {
5041     $params = [
5042       'contact_id' => $this->_individualId,
5043       'financial_type_id' => 1,
5044       'total_amount' => '$100',
5045       'fee_amount' => '$20',
5046       'net_amount' => '$80',
5047       'non_deductible_amount' => '$80',
5048       'sequential' => 1,
5049     ];
5050     $id = $this->callAPISuccess('Contribution', 'create', $params)['id'];
5051     // Reading the return values of the API isn't reliable here; get the data from the db.
5052     $contribution = $this->callAPISuccess('Contribution', 'getsingle', ['id' => $id]);
5053     $this->assertEquals('100.00', $contribution['total_amount']);
5054     $this->assertEquals('20.00', $contribution['fee_amount']);
5055     $this->assertEquals('80.00', $contribution['net_amount']);
5056     $this->assertEquals('80.00', $contribution['non_deductible_amount']);
5057   }
5058
5059   /**
5060    * Create a price set with a quick config price set.
5061    *
5062    * The params to use this look like
5063    *
5064    * ['price_' . $this->ids['PriceField']['basic'] => $this->ids['PriceFieldValue']['basic']]
5065    *
5066    * @param array $contributionPageParams
5067    *
5068    * @return int
5069    *
5070    * @throws \API_Exception
5071    * @throws \CRM_Core_Exception
5072    * @throws \Civi\API\Exception\UnauthorizedException
5073    */
5074   private function createQuickConfigContributionPage(array $contributionPageParams = []): int {
5075     $contributionPageID = $this->callAPISuccess('ContributionPage', 'create', array_merge([
5076       'receipt_from_name' => 'Mickey Mouse',
5077       'receipt_from_email' => 'mickey@mouse.com',
5078       'title' => 'Test Contribution Page',
5079       'financial_type_id' => 'Member Dues',
5080       'currency' => 'CAD',
5081       'is_pay_later' => 1,
5082       'is_quick_config' => TRUE,
5083       'pay_later_text' => 'I will send payment by check',
5084       'pay_later_receipt' => 'This is a pay later receipt',
5085       'is_allow_other_amount' => 1,
5086       'min_amount' => 10.00,
5087       'max_amount' => 10000.00,
5088       'goal_amount' => 100000.00,
5089       'is_email_receipt' => 1,
5090       'is_active' => 1,
5091       'amount_block_is_active' => 1,
5092       'is_billing_required' => 0,
5093     ], $contributionPageParams))['id'];
5094
5095     $priceSetID = PriceSet::create()->setValues([
5096       'name' => 'quick config set',
5097       'title' => 'basic price set',
5098       'is_quick_config' => TRUE,
5099       'extends' => 2,
5100     ])->execute()->first()['id'];
5101
5102     $priceFieldID = PriceField::create()->setValues([
5103       'price_set_id' => $priceSetID,
5104       'name' => 'quick config field name',
5105       'label' => 'quick config field name',
5106       'html_type' => 'Radio',
5107     ])->execute()->first()['id'];
5108     $this->ids['PriceSet']['basic'] = $priceSetID;
5109     $this->ids['PriceField']['basic'] = $priceFieldID;
5110     $this->ids['PriceFieldValue']['basic'] = PriceFieldValue::create()->setValues([
5111       'price_field_id' => $priceFieldID,
5112       'name' => 'quick config price field',
5113       'label' => 'quick config price field',
5114       'amount' => 100,
5115       'financial_type_id:name' => 'Member Dues',
5116     ])->execute()->first()['id'];
5117     CRM_Price_BAO_PriceSet::addTo('civicrm_contribution_page', $contributionPageID, $priceSetID);
5118     return $contributionPageID;
5119   }
5120
5121   /**
5122    * Get the created contribution ID.
5123    *
5124    * @param string $key
5125    *
5126    * @return int
5127    */
5128   protected function getContributionID(string $key = 'first'): int {
5129     return (int) $this->ids['contribution'][$key];
5130   }
5131
5132   /**
5133    * Get the created contribution ID.
5134    *
5135    * @return int
5136    */
5137   protected function getMembershipID(): int {
5138     return (int) $this->_ids['membership'];
5139   }
5140
5141   /**
5142    * Create a paid membership for renewal tests.
5143    */
5144   protected function createSubsequentPendingMembership(): void {
5145     $this->setUpPendingContribution($this->_ids['price_field_value'][1], 'second', [], [], [
5146       'id' => $this->getMembershipID(),
5147     ]);
5148   }
5149
5150   /**
5151    * Create a paid membership for renewal tests.
5152    */
5153   protected function createInitialPaidMembership(): void {
5154     $this->setUpPendingContribution($this->_ids['price_field_value'][1]);
5155     $this->callAPISuccess('Payment', 'create', [
5156       'contribution_id' => $this->getContributionID(),
5157       'total_amount' => 20,
5158     ]);
5159   }
5160
5161 }