tests/phpunit/api/v3/ContributionTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *  Test APIv3 civicrm_contribute_* functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Contribution
  33  * @group headless
  34  */
  35 class api_v3_ContributionTest extends CiviUnitTestCase {
  36
  37   use CRMTraits_Profile_ProfileTrait;
  38
  39   protected $_individualId;
  40   protected $_contribution;
  41   protected $_financialTypeId = 1;
  42   protected $_apiversion;
  43   protected $_entity = 'Contribution';
  44   public $debug = 0;
  45   protected $_params;
  46   protected $_ids = [];
  47   protected $_pageParams = [];
  48   /**
  49    * Payment processor ID (dummy processor).
  50    *
  51    * @var int
  52    */
  53   protected $paymentProcessorID;
  54
  55   /**
  56    * Parameters to create payment processor.
  57    *
  58    * @var array
  59    */
  60   protected $_processorParams = [];
  61
  62   /**
  63    * ID of created event.
  64    *
  65    * @var int
  66    */
  67   protected $_eventID;
  68
  69   /**
  70    * @var CiviMailUtils
  71    */
  72   protected $mut;
  73
  74   /**
  75    * Setup function.
  76    */
  77   public function setUp() {
  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 \CRM_Core_Exception
 122    */
 123   public function tearDown() {
 124     $this->quickCleanUpFinancialEntities();
 125     $this->quickCleanup(['civicrm_uf_match']);
 126     $financialAccounts = $this->callAPISuccess('FinancialAccount', 'get', []);
 127     foreach ($financialAccounts['values'] as $financialAccount) {
 128       if ($financialAccount['name'] === 'Test Tax financial account ' || $financialAccount['name'] === 'Test taxable financial Type') {
 129         $entityFinancialTypes = $this->callAPISuccess('EntityFinancialAccount', 'get', [
 130           'financial_account_id' => $financialAccount['id'],
 131         ]);
 132         foreach ($entityFinancialTypes['values'] as $entityFinancialType) {
 133           $this->callAPISuccess('EntityFinancialAccount', 'delete', ['id' => $entityFinancialType['id']]);
 134         }
 135         $this->callAPISuccess('FinancialAccount', 'delete', ['id' => $financialAccount['id']]);
 136       }
 137     }
 138     $this->restoreUFGroupOne();
 139   }
 140
 141   /**
 142    * Test Get.
 143    */
 144   public function testGetContribution() {
 145     $contributionSettings = $this->enableTaxAndInvoicing();
 146     $invoice_prefix = CRM_Contribute_BAO_Contribution::checkContributeSettings('invoice_prefix', TRUE);
 147     $p = [
 148       'contact_id' => $this->_individualId,
 149       'receive_date' => '2010-01-20',
 150       'total_amount' => 100.00,
 151       'financial_type_id' => $this->_financialTypeId,
 152       'non_deductible_amount' => 10.00,
 153       'fee_amount' => 5.00,
 154       'net_amount' => 95.00,
 155       'trxn_id' => 23456,
 156       'invoice_id' => 78910,
 157       'source' => 'SSF',
 158       'contribution_status_id' => 1,
 159     ];
 160     $this->_contribution = $this->callAPISuccess('contribution', 'create', $p);
 161
 162     $params = [
 163       'contribution_id' => $this->_contribution['id'],
 164     ];
 165
 166     $contributions = $this->callAPIAndDocument('contribution', 'get', $params, __FUNCTION__, __FILE__);
 167     $financialParams['id'] = $this->_financialTypeId;
 168     $default = NULL;
 169     CRM_Financial_BAO_FinancialType::retrieve($financialParams, $default);
 170
 171     $this->assertEquals(1, $contributions['count']);
 172     $contribution = $contributions['values'][$contributions['id']];
 173     $this->assertEquals($contribution['contact_id'], $this->_individualId);
 174     // Note there was an assertion converting financial_type_id to 'Donation' which wasn't working.
 175     // Passing back a string rather than an id seems like an error/cruft.
 176     // If it is to be introduced we should discuss.
 177     $this->assertEquals($contribution['financial_type_id'], 1);
 178     $this->assertEquals($contribution['total_amount'], 100.00);
 179     $this->assertEquals($contribution['non_deductible_amount'], 10.00);
 180     $this->assertEquals($contribution['fee_amount'], 5.00);
 181     $this->assertEquals($contribution['net_amount'], 95.00);
 182     $this->assertEquals($contribution['trxn_id'], 23456);
 183     $this->assertEquals($contribution['invoice_id'], 78910);
 184     $this->assertEquals($contribution['invoice_number'], $invoice_prefix . $contributions['id']);
 185     $this->assertEquals($contribution['contribution_source'], 'SSF');
 186     $this->assertEquals($contribution['contribution_status'], 'Completed');
 187     // Create a second contribution - we are testing that 'id' gets the right contribution id (not the contact id).
 188     $p['trxn_id'] = '3847';
 189     $p['invoice_id'] = '3847';
 190
 191     $contribution2 = $this->callAPISuccess('contribution', 'create', $p);
 192
 193     // Now we have 2 - test getcount.
 194     $contribution = $this->callAPISuccess('contribution', 'getcount', []);
 195     $this->assertEquals(2, $contribution);
 196     // Test id only format.
 197     $contribution = $this->callAPISuccess('contribution', 'get', [
 198       'id' => $this->_contribution['id'],
 199       'format.only_id' => 1,
 200     ]);
 201     $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution, TRUE));
 202     // Test id only format.
 203     $contribution = $this->callAPISuccess('contribution', 'get', [
 204       'id' => $contribution2['id'],
 205       'format.only_id' => 1,
 206     ]);
 207     $this->assertEquals($contribution2['id'], $contribution);
 208     // Test id as field.
 209     $contribution = $this->callAPISuccess('contribution', 'get', [
 210       'id' => $this->_contribution['id'],
 211     ]);
 212     $this->assertEquals(1, $contribution['count']);
 213
 214     // Test get by contact id works.
 215     $contribution = $this->callAPISuccess('contribution', 'get', ['contact_id' => $this->_individualId]);
 216
 217     $this->assertEquals(2, $contribution['count']);
 218     $this->callAPISuccess('Contribution', 'Delete', [
 219       'id' => $this->_contribution['id'],
 220     ]);
 221     $this->callAPISuccess('Contribution', 'Delete', [
 222       'id' => $contribution2['id'],
 223     ]);
 224   }
 225
 226   /**
 227    * Test that test contributions can be retrieved.
 228    */
 229   public function testGetTestContribution() {
 230     $this->callAPISuccess('Contribution', 'create', array_merge($this->_params, ['is_test' => 1]));
 231     $this->callAPISuccessGetSingle('Contribution', ['is_test' => 1]);
 232   }
 233
 234   /**
 235    * Test Creating a check contribution with original check_number field
 236    */
 237   public function testCreateCheckContribution() {
 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     $params['tax_amount'] = '1';
 249     $address = $this->callAPISuccess('Address', 'create', [
 250       'street_address' => 'Knockturn Alley',
 251       'contact_id' => $this->_individualId,
 252       'location_type_id' => 'Home',
 253     ]);
 254     $params['address_id'] = $address['id'];
 255     $contributionPage = $this->contributionPageCreate();
 256     $params['contribution_page_id'] = $contributionPage['id'];
 257     $params['campaign_id'] = $this->campaignCreate();
 258     $contributionID = $this->contributionCreate($params);
 259     $getResult = $this->callAPISuccess('Contribution', 'get', ['id' => $contributionID]);
 260     $this->assertEquals('bouncer', $getResult['values'][$contributionID]['check_number']);
 261     $entityFinancialTrxn = $this->callAPISuccess('EntityFinancialTrxn', 'get', ['entity_id' => $contributionID, 'entity_table' => 'civicrm_contribution']);
 262     foreach ($entityFinancialTrxn['values'] as $eft) {
 263       $financialTrxn = $this->callAPISuccess('FinancialTrxn', 'get', ['id' => $eft['financial_trxn_id']]);
 264       $this->assertEquals('bouncer', $financialTrxn['values'][$financialTrxn['id']]['check_number']);
 265     }
 266   }
 267
 268   /**
 269    * Test the 'return' param works for all fields.
 270    */
 271   public function testGetContributionReturnFunctionality() {
 272     $params = $this->_params;
 273     $params['contribution_check_number'] = 'bouncer';
 274     $params['payment_instrument_id'] = 'Check';
 275     $params['cancel_date'] = 'yesterday';
 276     $params['receipt_date'] = 'yesterday';
 277     $params['thankyou_date'] = 'yesterday';
 278     $params['revenue_recognition_date'] = 'yesterday';
 279     $params['amount_level'] = 'Unreasonable';
 280     $params['cancel_reason'] = 'You lose sucker';
 281     $params['creditnote_id'] = 'sudo rm -rf';
 282     $params['tax_amount'] = '1';
 283     $address = $this->callAPISuccess('Address', 'create', [
 284       'street_address' => 'Knockturn Alley',
 285       'contact_id' => $this->_individualId,
 286       'location_type_id' => 'Home',
 287     ]);
 288     $params['address_id'] = $address['id'];
 289     $contributionPage = $this->contributionPageCreate();
 290     $params['contribution_page_id'] = $contributionPage['id'];
 291     $contributionRecur = $this->callAPISuccess('ContributionRecur', 'create', [
 292       'contact_id' => $this->_individualId,
 293       'frequency_interval' => 1,
 294       'amount' => 5,
 295     ]);
 296     $params['contribution_recur_id'] = $contributionRecur['id'];
 297
 298     $params['campaign_id'] = $this->campaignCreate();
 299
 300     $contributionID = $this->contributionCreate($params);
 301
 302     // update contribution with invoice number
 303     $params = array_merge($params, [
 304       'id' => $contributionID,
 305       'invoice_number' => CRM_Utils_Array::value('invoice_prefix', Civi::settings()->get('contribution_invoice_settings')) . "" . $contributionID,
 306       'trxn_id' => 12345,
 307       'invoice_id' => 6789,
 308     ]);
 309     $contributionID = $this->contributionCreate($params);
 310
 311     $contribution = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID]);
 312     $this->assertEquals('bouncer', $contribution['check_number']);
 313     $this->assertEquals('bouncer', $contribution['contribution_check_number']);
 314
 315     $fields = CRM_Contribute_BAO_Contribution::fields();
 316     // Re-add these 2 to the fields to check. They were locked in but the metadata changed so we
 317     // need to specify them.
 318     $fields['address_id'] = $fields['contribution_address_id'];
 319     $fields['check_number'] = $fields['contribution_check_number'];
 320
 321     $fieldsLockedIn = [
 322       'contribution_id', 'contribution_contact_id', 'financial_type_id', 'contribution_page_id',
 323       'payment_instrument_id', 'receive_date', 'non_deductible_amount', 'total_amount',
 324       'fee_amount', 'net_amount', 'trxn_id', 'invoice_id', 'currency', 'contribution_cancel_date', 'cancel_reason',
 325       'receipt_date', 'thankyou_date', 'contribution_source', 'amount_level', 'contribution_recur_id',
 326       'is_test', 'is_pay_later', 'contribution_status_id', 'address_id', 'check_number', 'contribution_campaign_id',
 327       'creditnote_id', 'tax_amount', 'revenue_recognition_date', 'decoy',
 328     ];
 329     $missingFields = array_diff($fieldsLockedIn, array_keys($fields));
 330     // If any of the locked in fields disappear from the $fields array we need to make sure it is still
 331     // covered as the test contract now guarantees them in the return array.
 332     $this->assertEquals($missingFields, [29 => 'decoy'], 'A field which was covered by the test contract has changed.');
 333     foreach ($fields as $fieldName => $fieldSpec) {
 334       $contribution = $this->callAPISuccessGetSingle('Contribution', ['id' => $contributionID, 'return' => $fieldName]);
 335       $returnField = $fieldName;
 336       if ($returnField == 'contribution_contact_id') {
 337         $returnField = 'contact_id';
 338       }
 339       $this->assertTrue((!empty($contribution[$returnField]) || $contribution[$returnField] === "0"), $returnField);
 340     }
 341     $entityFinancialTrxn = $this->callAPISuccess('EntityFinancialTrxn', 'get', ['entity_id' => $contributionID, 'entity_table' => 'civicrm_contribution']);
 342     foreach ($entityFinancialTrxn['values'] as $eft) {
 343       $financialTrxn = $this->callAPISuccess('FinancialTrxn', 'get', ['id' => $eft['financial_trxn_id']]);
 344       $this->assertEquals('bouncer', $financialTrxn['values'][$financialTrxn['id']]['check_number']);
 345     }
 346   }
 347
 348   /**
 349    * Test cancel reason works as a filter.
 350    */
 351   public function testFilterCancelReason() {
 352     $params = $this->_params;
 353     $params['cancel_date'] = 'yesterday';
 354     $params['cancel_reason'] = 'You lose sucker';
 355     $this->callAPISuccess('Contribution', 'create', $params);
 356     $params = $this->_params;
 357     $params['cancel_date'] = 'yesterday';
 358     $params['cancel_reason'] = 'You are a winner';
 359     $this->callAPISuccess('Contribution', 'create', $params);
 360     $this->callAPISuccessGetCount('Contribution', ['cancel_reason' => 'You are a winner'], 1);
 361   }
 362
 363   /**
 364    * We need to ensure previous tested behaviour still works as part of the api contract.
 365    */
 366   public function testGetContributionLegacyBehaviour() {
 367     $p = [
 368       'contact_id' => $this->_individualId,
 369       'receive_date' => '2010-01-20',
 370       'total_amount' => 100.00,
 371       'contribution_type_id' => $this->_financialTypeId,
 372       'non_deductible_amount' => 10.00,
 373       'fee_amount' => 5.00,
 374       'net_amount' => 95.00,
 375       'trxn_id' => 23456,
 376       'invoice_id' => 78910,
 377       'source' => 'SSF',
 378       'contribution_status_id' => 1,
 379     ];
 380     $this->_contribution = $this->callAPISuccess('Contribution', 'create', $p);
 381
 382     $params = [
 383       'contribution_id' => $this->_contribution['id'],
 384     ];
 385     $contribution = $this->callAPISuccess('contribution', 'get', $params);
 386     $financialParams['id'] = $this->_financialTypeId;
 387     $default = NULL;
 388     CRM_Financial_BAO_FinancialType::retrieve($financialParams, $default);
 389
 390     $this->assertEquals(1, $contribution['count']);
 391     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 392     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], $this->_financialTypeId);
 393     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_type_id'], $this->_financialTypeId);
 394     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 395     $this->assertEquals($contribution['values'][$contribution['id']]['non_deductible_amount'], 10.00);
 396     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 5.00);
 397     $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 95.00);
 398     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 23456);
 399     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 78910);
 400     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_source'], 'SSF');
 401     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed');
 402
 403     // Create a second contribution - we are testing that 'id' gets the right contribution id (not the contact id).
 404     $p['trxn_id'] = '3847';
 405     $p['invoice_id'] = '3847';
 406
 407     $contribution2 = $this->callAPISuccess('contribution', 'create', $p);
 408
 409     // now we have 2 - test getcount
 410     $contribution = $this->callAPISuccess('contribution', 'getcount', []);
 411     $this->assertEquals(2, $contribution);
 412     //test id only format
 413     $contribution = $this->callAPISuccess('contribution', 'get', [
 414       'id' => $this->_contribution['id'],
 415       'format.only_id' => 1,
 416     ]);
 417     $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution, TRUE));
 418     //test id only format
 419     $contribution = $this->callAPISuccess('contribution', 'get', [
 420       'id' => $contribution2['id'],
 421       'format.only_id' => 1,
 422     ]);
 423     $this->assertEquals($contribution2['id'], $contribution);
 424     $contribution = $this->callAPISuccess('contribution', 'get', [
 425       'id' => $this->_contribution['id'],
 426     ]);
 427     //test id as field
 428     $this->assertEquals(1, $contribution['count']);
 429     // $this->assertEquals($this->_contribution['id'], $contribution['id'] )  ;
 430     //test get by contact id works
 431     $contribution = $this->callAPISuccess('contribution', 'get', ['contact_id' => $this->_individualId]);
 432
 433     $this->assertEquals(2, $contribution['count']);
 434     $this->callAPISuccess('Contribution', 'Delete', [
 435       'id' => $this->_contribution['id'],
 436     ]);
 437     $this->callAPISuccess('Contribution', 'Delete', [
 438       'id' => $contribution2['id'],
 439     ]);
 440   }
 441
 442   /**
 443    * Create an contribution_id=FALSE and financial_type_id=Donation.
 444    */
 445   public function testCreateEmptyContributionIDUseDonation() {
 446     $params = [
 447       'contribution_id' => FALSE,
 448       'contact_id' => 1,
 449       'total_amount' => 1,
 450       'check_permissions' => FALSE,
 451       'financial_type_id' => 'Donation',
 452     ];
 453     $this->callAPISuccess('contribution', 'create', $params);
 454   }
 455
 456   /**
 457    * Check with complete array + custom field.
 458    *
 459    * Note that the test is written on purpose without any
 460    * variables specific to participant so it can be replicated into other entities
 461    * and / or moved to the automated test suite
 462    */
 463   public function testCreateWithCustom() {
 464     $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 465
 466     $params = $this->_params;
 467     $params['custom_' . $ids['custom_field_id']] = "custom string";
 468
 469     $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);
 470     $this->assertEquals($result['id'], $result['values'][$result['id']]['id']);
 471     $check = $this->callAPISuccess($this->_entity, 'get', [
 472       'return.custom_' . $ids['custom_field_id'] => 1,
 473       'id' => $result['id'],
 474     ]);
 475     $this->customFieldDelete($ids['custom_field_id']);
 476     $this->customGroupDelete($ids['custom_group_id']);
 477     $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']]);
 478   }
 479
 480   /**
 481    * Check with complete array + custom field.
 482    *
 483    * Note that the test is written on purpose without any
 484    * variables specific to participant so it can be replicated into other entities
 485    * and / or moved to the automated test suite
 486    */
 487   public function testCreateGetFieldsWithCustom() {
 488     $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 489     $idsContact = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, 'ContactTest.php');
 490     $result = $this->callAPISuccess('Contribution', 'getfields', []);
 491     $this->assertArrayHasKey('custom_' . $ids['custom_field_id'], $result['values']);
 492     $this->assertArrayNotHasKey('custom_' . $idsContact['custom_field_id'], $result['values']);
 493     $this->customFieldDelete($ids['custom_field_id']);
 494     $this->customGroupDelete($ids['custom_group_id']);
 495     $this->customFieldDelete($idsContact['custom_field_id']);
 496     $this->customGroupDelete($idsContact['custom_group_id']);
 497   }
 498
 499   public function testCreateContributionNoLineItems() {
 500
 501     $params = [
 502       'contact_id' => $this->_individualId,
 503       'receive_date' => '20120511',
 504       'total_amount' => 100.00,
 505       'financial_type_id' => $this->_financialTypeId,
 506       'payment_instrument_id' => 1,
 507       'non_deductible_amount' => 10.00,
 508       'fee_amount' => 50.00,
 509       'net_amount' => 90.00,
 510       'trxn_id' => 12345,
 511       'invoice_id' => 67890,
 512       'source' => 'SSF',
 513       'contribution_status_id' => 1,
 514       'skipLineItem' => 1,
 515     ];
 516
 517     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 518     $lineItems = $this->callAPISuccess('line_item', 'get', [
 519       'entity_id' => $contribution['id'],
 520       'entity_table' => 'civicrm_contribution',
 521       'sequential' => 1,
 522     ]);
 523     $this->assertEquals(0, $lineItems['count']);
 524   }
 525
 526   /**
 527    * Test checks that passing in line items suppresses the create mechanism.
 528    */
 529   public function testCreateContributionChainedLineItems() {
 530     $params = [
 531       'contact_id' => $this->_individualId,
 532       'receive_date' => '20120511',
 533       'total_amount' => 100.00,
 534       'financial_type_id' => $this->_financialTypeId,
 535       'payment_instrument_id' => 1,
 536       'non_deductible_amount' => 10.00,
 537       'fee_amount' => 50.00,
 538       'net_amount' => 90.00,
 539       'trxn_id' => 12345,
 540       'invoice_id' => 67890,
 541       'source' => 'SSF',
 542       'contribution_status_id' => 1,
 543       'skipLineItem' => 1,
 544       'api.line_item.create' => [
 545         [
 546           'price_field_id' => 1,
 547           'qty' => 2,
 548           'line_total' => '20',
 549           'unit_price' => '10',
 550         ],
 551         [
 552           'price_field_id' => 1,
 553           'qty' => 1,
 554           'line_total' => '80',
 555           'unit_price' => '80',
 556         ],
 557       ],
 558     ];
 559
 560     $description = "Create Contribution with Nested Line Items.";
 561     $subfile = "CreateWithNestedLineItems";
 562     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 563
 564     $lineItems = $this->callAPISuccess('line_item', 'get', [
 565       'entity_id' => $contribution['id'],
 566       'contribution_id' => $contribution['id'],
 567       'entity_table' => 'civicrm_contribution',
 568       'sequential' => 1,
 569     ]);
 570     $this->assertEquals(2, $lineItems['count']);
 571   }
 572
 573   public function testCreateContributionOffline() {
 574     $params = [
 575       'contact_id' => $this->_individualId,
 576       'receive_date' => '20120511',
 577       'total_amount' => 100.00,
 578       'financial_type_id' => 1,
 579       'trxn_id' => 12345,
 580       'invoice_id' => 67890,
 581       'source' => 'SSF',
 582       'contribution_status_id' => 1,
 583     ];
 584
 585     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 586     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 587     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 588     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 589     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
 590     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
 591     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 592     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
 593     $lineItems = $this->callAPISuccess('line_item', 'get', [
 594       'entity_id' => $contribution['id'],
 595       'contribution_id' => $contribution['id'],
 596       'entity_table' => 'civicrm_contribution',
 597       'sequential' => 1,
 598     ]);
 599     $this->assertEquals(1, $lineItems['count']);
 600     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 601     $this->assertEquals($contribution['id'], $lineItems['values'][0]['contribution_id']);
 602     $this->_checkFinancialRecords($contribution, 'offline');
 603     $this->contributionGetnCheck($params, $contribution['id']);
 604   }
 605
 606   /**
 607    * Test create with valid payment instrument.
 608    */
 609   public function testCreateContributionWithPaymentInstrument() {
 610     $params = $this->_params + ['payment_instrument' => 'EFT'];
 611     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 612     $contribution = $this->callAPISuccess('contribution', 'get', [
 613       'sequential' => 1,
 614       'id' => $contribution['id'],
 615     ]);
 616     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 617     $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
 618
 619     $this->callAPISuccess('contribution', 'create', [
 620       'id' => $contribution['id'],
 621       'payment_instrument' => 'Credit Card',
 622     ]);
 623     $contribution = $this->callAPISuccess('contribution', 'get', [
 624       'sequential' => 1,
 625       'id' => $contribution['id'],
 626     ]);
 627     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 628     $this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
 629   }
 630
 631   public function testGetContributionByPaymentInstrument() {
 632     $params = $this->_params + ['payment_instrument' => 'EFT'];
 633     $params2 = $this->_params + ['payment_instrument' => 'Cash'];
 634     $this->callAPISuccess('contribution', 'create', $params);
 635     $this->callAPISuccess('contribution', 'create', $params2);
 636     $contribution = $this->callAPISuccess('contribution', 'get', [
 637       'sequential' => 1,
 638       'contribution_payment_instrument' => 'Cash',
 639     ]);
 640     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 641     $this->assertEquals('Cash', $contribution['values'][0]['payment_instrument']);
 642     $this->assertEquals(1, $contribution['count']);
 643     $contribution = $this->callAPISuccess('contribution', 'get', ['sequential' => 1, 'payment_instrument' => 'Cash']);
 644     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 645     $this->assertEquals('Cash', $contribution['values'][0]['payment_instrument']);
 646     $this->assertEquals(1, $contribution['count']);
 647     $contribution = $this->callAPISuccess('contribution', 'get', [
 648       'sequential' => 1,
 649       'payment_instrument_id' => 5,
 650     ]);
 651     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 652     $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
 653     $this->assertEquals(1, $contribution['count']);
 654     $contribution = $this->callAPISuccess('contribution', 'get', [
 655       'sequential' => 1,
 656       'payment_instrument' => 'EFT',
 657     ]);
 658     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 659     $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
 660     $this->assertEquals(1, $contribution['count']);
 661     $contribution = $this->callAPISuccess('contribution', 'create', [
 662       'id' => $contribution['id'],
 663       'payment_instrument' => 'Credit Card',
 664     ]);
 665     $contribution = $this->callAPISuccess('contribution', 'get', ['sequential' => 1, 'id' => $contribution['id']]);
 666     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 667     $this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
 668     $this->assertEquals(1, $contribution['count']);
 669   }
 670
 671   /**
 672    * CRM-16227 introduces invoice_id as a parameter.
 673    */
 674   public function testGetContributionByInvoice() {
 675     $this->callAPISuccess('Contribution', 'create', array_merge($this->_params, ['invoice_id' => 'curly']));
 676     $this->callAPISuccess('Contribution', 'create', array_merge($this->_params), ['invoice_id' => 'churlish']);
 677     $this->callAPISuccessGetCount('Contribution', [], 2);
 678     $this->callAPISuccessGetSingle('Contribution', ['invoice_id' => 'curly']);
 679     // The following don't work. They are the format we are trying to introduce but although the form uses this format
 680     // CRM_Contact_BAO_Query::convertFormValues puts them into the other format & the where only supports that.
 681     // ideally the where clause would support this format (as it does on contact_BAO_Query) and those lines would
 682     // come out of convertFormValues
 683     // $this->callAPISuccessGetSingle('Contribution', array('invoice_id' => array('LIKE' => '%ish%')));
 684     // $this->callAPISuccessGetSingle('Contribution', array('invoice_id' => array('NOT IN' => array('curly'))));
 685     // $this->callAPISuccessGetCount('Contribution', array('invoice_id' => array('LIKE' => '%ly%')), 2);
 686     // $this->callAPISuccessGetCount('Contribution', array('invoice_id' => array('IN' => array('curly', 'churlish'))),
 687     // 2);
 688   }
 689
 690   /**
 691    * Check the credit note retrieval is case insensitive.
 692    */
 693   public function testGetCreditNoteCaseInsensitive() {
 694     $this->contributionCreate(['contact_id' => $this->_individualId]);
 695     $this->contributionCreate(['creditnote_id' => 'cN1234', 'contact_id' => $this->_individualId, 'invoice_id' => rand(), 'trxn_id' => rand()]);
 696     $contribution = $this->callAPISuccess('Contribution', 'getsingle', ['creditnote_id' => 'CN1234']);
 697     $this->assertEquals($contribution['creditnote_id'], 'cN1234');
 698   }
 699
 700   /**
 701    * Test retrieval by total_amount works.
 702    *
 703    * @throws Exception
 704    */
 705   public function testGetContributionByTotalAmount() {
 706     $this->callAPISuccess('Contribution', 'create', array_merge($this->_params, ['total_amount' => '5']));
 707     $this->callAPISuccess('Contribution', 'create', array_merge($this->_params, ['total_amount' => '10']));
 708     $this->callAPISuccessGetCount('Contribution', ['total_amount' => 10], 1);
 709     $this->callAPISuccessGetCount('Contribution', ['total_amount' => ['>' => 6]], 1);
 710     $this->callAPISuccessGetCount('Contribution', ['total_amount' => ['>' => 0]], 2);
 711     $this->callAPISuccessGetCount('Contribution', ['total_amount' => ['>' => -5]], 2);
 712     $this->callAPISuccessGetCount('Contribution', ['total_amount' => ['<' => 0]], 0);
 713     $this->callAPISuccessGetCount('Contribution', [], 2);
 714   }
 715
 716   /**
 717    * Create test with unique field name on source.
 718    */
 719   public function testCreateContributionSource() {
 720
 721     $params = [
 722       'contact_id' => $this->_individualId,
 723       'receive_date' => date('Ymd'),
 724       'total_amount' => 100.00,
 725       'financial_type_id' => $this->_financialTypeId,
 726       'payment_instrument_id' => 1,
 727       'non_deductible_amount' => 10.00,
 728       'fee_amount' => 50.00,
 729       'net_amount' => 90.00,
 730       'trxn_id' => 12345,
 731       'invoice_id' => 67890,
 732       'contribution_source' => 'SSF',
 733       'contribution_status_id' => 1,
 734     ];
 735
 736     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 737     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 738     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 739   }
 740
 741   /**
 742    * Create test with unique field name on source.
 743    *
 744    * @param string $thousandSeparator
 745    *   punctuation used to refer to thousands.
 746    *
 747    * @dataProvider getThousandSeparators
 748    */
 749   public function testCreateDefaultNow($thousandSeparator) {
 750     $this->setCurrencySeparators($thousandSeparator);
 751     $params = $this->_params;
 752     unset($params['receive_date'], $params['net_amount']);
 753
 754     $params['total_amount'] = $this->formatMoneyInput(5000.77);
 755     $params['fee_amount'] = $this->formatMoneyInput(.77);
 756     $params['skipCleanMoney'] = FALSE;
 757
 758     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 759     $contribution = $this->callAPISuccessGetSingle('contribution', ['id' => $contribution['id']]);
 760     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receive_date'])));
 761     $this->assertEquals(5000.77, $contribution['total_amount'], 'failed to handle ' . $this->formatMoneyInput(5000.77));
 762     $this->assertEquals(.77, $contribution['fee_amount']);
 763     $this->assertEquals(5000, $contribution['net_amount']);
 764   }
 765
 766   /**
 767    * Create test with unique field name on source.
 768    */
 769   public function testCreateContributionNullOutThankyouDate() {
 770
 771     $params = $this->_params;
 772     $params['thankyou_date'] = 'yesterday';
 773
 774     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 775     $contribution = $this->callAPISuccessGetSingle('contribution', ['id' => $contribution['id']]);
 776     $this->assertEquals(date('Y-m-d', strtotime('yesterday')), date('Y-m-d', strtotime($contribution['thankyou_date'])));
 777
 778     $params['thankyou_date'] = 'null';
 779     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 780     $contribution = $this->assertTrue(empty($contribution['thankyou_date']));
 781   }
 782
 783   /**
 784    * Create test with unique field name on source.
 785    */
 786   public function testCreateContributionSourceInvalidContact() {
 787
 788     $params = [
 789       'contact_id' => 999,
 790       'receive_date' => date('Ymd'),
 791       'total_amount' => 100.00,
 792       'financial_type_id' => $this->_financialTypeId,
 793       'payment_instrument_id' => 1,
 794       'non_deductible_amount' => 10.00,
 795       'fee_amount' => 50.00,
 796       'net_amount' => 90.00,
 797       'trxn_id' => 12345,
 798       'invoice_id' => 67890,
 799       'contribution_source' => 'SSF',
 800       'contribution_status_id' => 1,
 801     ];
 802
 803     $this->callAPIFailure('contribution', 'create', $params, 'contact_id is not valid : 999');
 804   }
 805
 806   public function testCreateContributionSourceInvalidContContact() {
 807
 808     $params = [
 809       'contribution_contact_id' => 999,
 810       'receive_date' => date('Ymd'),
 811       'total_amount' => 100.00,
 812       'financial_type_id' => $this->_financialTypeId,
 813       'payment_instrument_id' => 1,
 814       'non_deductible_amount' => 10.00,
 815       'fee_amount' => 50.00,
 816       'net_amount' => 90.00,
 817       'trxn_id' => 12345,
 818       'invoice_id' => 67890,
 819       'contribution_source' => 'SSF',
 820       'contribution_status_id' => 1,
 821     ];
 822
 823     $this->callAPIFailure('contribution', 'create', $params);
 824   }
 825
 826   /**
 827    * Test note created correctly.
 828    */
 829   public function testCreateContributionWithNote() {
 830     $description = "Demonstrates creating contribution with Note Entity.";
 831     $subfile = "ContributionCreateWithNote";
 832     $params = [
 833       'contact_id' => $this->_individualId,
 834       'receive_date' => '2012-01-01',
 835       'total_amount' => 100.00,
 836       'financial_type_id' => $this->_financialTypeId,
 837       'payment_instrument_id' => 1,
 838       'non_deductible_amount' => 10.00,
 839       'fee_amount' => 50.00,
 840       'net_amount' => 90.00,
 841       'trxn_id' => 12345,
 842       'invoice_id' => 67890,
 843       'source' => 'SSF',
 844       'contribution_status_id' => 1,
 845       'note' => 'my contribution note',
 846     ];
 847
 848     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 849     $result = $this->callAPISuccess('note', 'get', [
 850       'entity_table' => 'civicrm_contribution',
 851       'entity_id' => $contribution['id'],
 852       'sequential' => 1,
 853     ]);
 854     $this->assertEquals('my contribution note', $result['values'][0]['note']);
 855     $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
 856   }
 857
 858   public function testCreateContributionWithNoteUniqueNameAliases() {
 859     $params = [
 860       'contact_id' => $this->_individualId,
 861       'receive_date' => '2012-01-01',
 862       'total_amount' => 100.00,
 863       'financial_type_id' => $this->_financialTypeId,
 864       'payment_instrument_id' => 1,
 865       'non_deductible_amount' => 10.00,
 866       'fee_amount' => 50.00,
 867       'net_amount' => 90.00,
 868       'trxn_id' => 12345,
 869       'invoice_id' => 67890,
 870       'source' => 'SSF',
 871       'contribution_status_id' => 1,
 872       'contribution_note' => 'my contribution note',
 873     ];
 874
 875     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 876     $result = $this->callAPISuccess('note', 'get', [
 877       'entity_table' => 'civicrm_contribution',
 878       'entity_id' => $contribution['id'],
 879       'sequential' => 1,
 880     ]);
 881     $this->assertEquals('my contribution note', $result['values'][0]['note']);
 882     $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
 883   }
 884
 885   /**
 886    * This is the test for creating soft credits.
 887    */
 888   public function testCreateContributionWithSoftCredit() {
 889     $description = "Demonstrates creating contribution with SoftCredit.";
 890     $subfile = "ContributionCreateWithSoftCredit";
 891     $contact2 = $this->callAPISuccess('Contact', 'create', [
 892       'display_name' => 'superman',
 893       'contact_type' => 'Individual',
 894     ]);
 895     $softParams = [
 896       'contact_id' => $contact2['id'],
 897       'amount' => 50,
 898       'soft_credit_type_id' => 3,
 899     ];
 900
 901     $params = $this->_params + ['soft_credit' => [1 => $softParams]];
 902     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 903     $result = $this->callAPISuccess('contribution', 'get', ['return' => 'soft_credit', 'sequential' => 1]);
 904
 905     $this->assertEquals($softParams['contact_id'], $result['values'][0]['soft_credit'][1]['contact_id']);
 906     $this->assertEquals($softParams['amount'], $result['values'][0]['soft_credit'][1]['amount']);
 907     $this->assertEquals($softParams['soft_credit_type_id'], $result['values'][0]['soft_credit'][1]['soft_credit_type']);
 908
 909     $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
 910     $this->callAPISuccess('contact', 'delete', ['id' => $contact2['id']]);
 911   }
 912
 913   public function testCreateContributionWithSoftCreditDefaults() {
 914     $description = "Demonstrates creating contribution with Soft Credit defaults for amount and type.";
 915     $subfile = "ContributionCreateWithSoftCreditDefaults";
 916     $contact2 = $this->callAPISuccess('Contact', 'create', [
 917       'display_name' => 'superman',
 918       'contact_type' => 'Individual',
 919     ]);
 920     $params = $this->_params + [
 921       'soft_credit_to' => $contact2['id'],
 922     ];
 923     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 924     $result = $this->callAPISuccess('contribution', 'get', ['return' => 'soft_credit', 'sequential' => 1]);
 925
 926     $this->assertEquals($contact2['id'], $result['values'][0]['soft_credit'][1]['contact_id']);
 927     // Default soft credit amount = contribution.total_amount
 928     $this->assertEquals($this->_params['total_amount'], $result['values'][0]['soft_credit'][1]['amount']);
 929     $this->assertEquals(CRM_Core_OptionGroup::getDefaultValue("soft_credit_type"), $result['values'][0]['soft_credit'][1]['soft_credit_type']);
 930
 931     $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
 932     $this->callAPISuccess('contact', 'delete', ['id' => $contact2['id']]);
 933   }
 934
 935   /**
 936    * Test creating contribution with Soft Credit by passing in honor_contact_id.
 937    */
 938   public function testCreateContributionWithHonoreeContact() {
 939     $description = "Demonstrates creating contribution with Soft Credit by passing in honor_contact_id.";
 940     $subfile = "ContributionCreateWithHonoreeContact";
 941     $contact2 = $this->callAPISuccess('Contact', 'create', [
 942       'display_name' => 'superman',
 943       'contact_type' => 'Individual',
 944     ]);
 945     $params = $this->_params + [
 946       'honor_contact_id' => $contact2['id'],
 947     ];
 948     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 949     $result = $this->callAPISuccess('contribution', 'get', ['return' => 'soft_credit', 'sequential' => 1]);
 950
 951     $this->assertEquals($contact2['id'], $result['values'][0]['soft_credit'][1]['contact_id']);
 952     // Default soft credit amount = contribution.total_amount
 953     // Legacy mode in create api (honor_contact_id param) uses the standard "In Honor of" soft credit type
 954     $this->assertEquals($this->_params['total_amount'], $result['values'][0]['soft_credit'][1]['amount']);
 955     $softCreditValueTypeID = $result['values'][0]['soft_credit'][1]['soft_credit_type'];
 956     $this->assertEquals('in_honor_of', CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $softCreditValueTypeID));
 957
 958     $this->callAPISuccess('contribution', 'delete', ['id' => $contribution['id']]);
 959     $this->callAPISuccess('contact', 'delete', ['id' => $contact2['id']]);
 960   }
 961
 962   /**
 963    * Test using example code.
 964    */
 965   public function testContributionCreateExample() {
 966     //make sure at least on page exists since there is a truncate in tear down
 967     $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
 968     require_once 'api/v3/examples/Contribution/Create.ex.php';
 969     $result = contribution_create_example();
 970     $id = $result['id'];
 971     $expectedResult = contribution_create_expectedresult();
 972     $this->checkArrayEquals($expectedResult, $result);
 973     $this->contributionDelete($id);
 974   }
 975
 976   /**
 977    * Function tests that additional financial records are created when fee amount is recorded.
 978    */
 979   public function testCreateContributionWithFee() {
 980     $params = [
 981       'contact_id' => $this->_individualId,
 982       'receive_date' => '20120511',
 983       'total_amount' => 100.00,
 984       'fee_amount' => 50,
 985       'financial_type_id' => 1,
 986       'trxn_id' => 12345,
 987       'invoice_id' => 67890,
 988       'source' => 'SSF',
 989       'contribution_status_id' => 1,
 990     ];
 991
 992     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 993     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 994     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 995     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 50.00);
 996     $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 50.00);
 997     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 998     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
 999     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
1000     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
1001     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
1002
1003     $lineItems = $this->callAPISuccess('line_item', 'get', [
1004
1005       'entity_id' => $contribution['id'],
1006       'entity_table' => 'civicrm_contribution',
1007       'sequential' => 1,
1008     ]);
1009     $this->assertEquals(1, $lineItems['count']);
1010     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
1011     $this->assertEquals($contribution['id'], $lineItems['values'][0]['contribution_id']);
1012     $lineItems = $this->callAPISuccess('line_item', 'get', [
1013
1014       'entity_id' => $contribution['id'],
1015       'contribution_id' => $contribution['id'],
1016       'entity_table' => 'civicrm_contribution',
1017       'sequential' => 1,
1018     ]);
1019     $this->assertEquals(1, $lineItems['count']);
1020     $this->_checkFinancialRecords($contribution, 'feeAmount');
1021   }
1022
1023   /**
1024    * Function tests that additional financial records are created when online contribution is created.
1025    */
1026   public function testCreateContributionOnline() {
1027     CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
1028     $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
1029     $this->assertAPISuccess($contributionPage);
1030     $params = [
1031       'contact_id' => $this->_individualId,
1032       'receive_date' => '20120511',
1033       'total_amount' => 100.00,
1034       'financial_type_id' => 1,
1035       'contribution_page_id' => $contributionPage['id'],
1036       'payment_processor' => $this->paymentProcessorID,
1037       'trxn_id' => 12345,
1038       'invoice_id' => 67890,
1039       'source' => 'SSF',
1040       'contribution_status_id' => 1,
1041
1042     ];
1043
1044     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1045     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
1046     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
1047     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
1048     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
1049     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
1050     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
1051     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
1052     $contribution['payment_instrument_id'] = $this->callAPISuccessGetValue('PaymentProcessor', [
1053       'id' => $this->paymentProcessorID,
1054       'return' => 'payment_instrument_id',
1055     ]);
1056     $this->_checkFinancialRecords($contribution, 'online');
1057   }
1058
1059   /**
1060    * Check handling of financial type.
1061    *
1062    * In the interests of removing financial type / contribution type checks from
1063    * legacy format function lets test that the api is doing this for us
1064    */
1065   public function testCreateInvalidFinancialType() {
1066     $params = $this->_params;
1067     $params['financial_type_id'] = 99999;
1068     $this->callAPIFailure($this->_entity, 'create', $params, "'99999' is not a valid option for field financial_type_id");
1069   }
1070
1071   /**
1072    * Check handling of financial type.
1073    *
1074    * In the interests of removing financial type / contribution type checks from
1075    * legacy format function lets test that the api is doing this for us
1076    */
1077   public function testValidNamedFinancialType() {
1078     $params = $this->_params;
1079     $params['financial_type_id'] = 'Donation';
1080     $this->callAPISuccess($this->_entity, 'create', $params);
1081   }
1082
1083   /**
1084    * Tests that additional financial records are created.
1085    *
1086    * Checks when online contribution with pay later option is created
1087    */
1088   public function testCreateContributionPayLaterOnline() {
1089     CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
1090     $this->_pageParams['is_pay_later'] = 1;
1091     $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
1092     $this->assertAPISuccess($contributionPage);
1093     $params = [
1094       'contact_id' => $this->_individualId,
1095       'receive_date' => '20120511',
1096       'total_amount' => 100.00,
1097       'financial_type_id' => 1,
1098       'contribution_page_id' => $contributionPage['id'],
1099       'trxn_id' => 12345,
1100       'is_pay_later' => 1,
1101       'invoice_id' => 67890,
1102       'source' => 'SSF',
1103       'contribution_status_id' => 2,
1104
1105     ];
1106
1107     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
1108     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
1109     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
1110     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
1111     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
1112     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
1113     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
1114     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 2);
1115     $this->_checkFinancialRecords($contribution, 'payLater');
1116   }
1117
1118   /**
1119    * Function tests that additional financial records are created for online contribution with pending option.
1120    */
1121   public function testCreateContributionPendingOnline() {
1122     CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
1123     $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
1124     $this->assertAPISuccess($contributionPage);
1125     $params = [
1126       'contact_id' => $this->_individualId,
1127       'receive_date' => '20120511',
1128       'total_amount' => 100.00,
1129       'financial_type_id' => 1,
1130       'contribution_page_id' => $contributionPage['id'],
1131       'trxn_id' => 12345,
1132       'invoice_id' => 67890,
1133       'source' => 'SSF',
1134       'contribution_status_id' => 2,
1135     ];
1136
1137     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1138     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
1139     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
1140     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
1141     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
1142     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
1143     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
1144     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 2);
1145     $this->_checkFinancialRecords($contribution, 'pending');
1146   }
1147
1148   /**
1149    * Test that BAO defaults work.
1150    */
1151   public function testCreateBAODefaults() {
1152     unset($this->_params['contribution_source_id'], $this->_params['payment_instrument_id']);
1153     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
1154     $contribution = $this->callAPISuccess('contribution', 'getsingle', [
1155       'id' => $contribution['id'],
1156       'api.contribution.delete' => 1,
1157     ]);
1158     $this->assertEquals(1, $contribution['contribution_status_id']);
1159     $this->assertEquals('Check', $contribution['payment_instrument']);
1160     $this->callAPISuccessGetCount('Contribution', ['id' => $contribution['id']], 0);
1161   }
1162
1163   /**
1164    * Test that getsingle can be chained with delete.
1165    */
1166   public function testDeleteChainedGetSingle() {
1167     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
1168     $contribution = $this->callAPISuccess('contribution', 'getsingle', [
1169       'id' => $contribution['id'],
1170       'api.contribution.delete' => 1,
1171     ]);
1172     $this->callAPISuccessGetCount('Contribution', ['id' => $contribution['id']], 0);
1173   }
1174
1175   /**
1176    * Function tests that line items, financial records are updated when contribution amount is changed.
1177    */
1178   public function testCreateUpdateContributionChangeTotal() {
1179     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
1180     $lineItems = $this->callAPISuccess('line_item', 'getvalue', [
1181
1182       'entity_id' => $contribution['id'],
1183       'entity_table' => 'civicrm_contribution',
1184       'sequential' => 1,
1185       'return' => 'line_total',
1186     ]);
1187     $this->assertEquals('100.00', $lineItems);
1188     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
1189     // Financial trxn SUM = 100 + 5 (fee)
1190     $this->assertEquals('105.00', $trxnAmount);
1191     $newParams = [
1192
1193       'id' => $contribution['id'],
1194       'total_amount' => '125',
1195     ];
1196     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1197
1198     $lineItems = $this->callAPISuccess('line_item', 'getvalue', [
1199
1200       'entity_id' => $contribution['id'],
1201       'entity_table' => 'civicrm_contribution',
1202       'sequential' => 1,
1203       'return' => 'line_total',
1204     ]);
1205
1206     $this->assertEquals('125.00', $lineItems);
1207     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
1208
1209     // Financial trxn SUM = 125 + 5 (fee).
1210     $this->assertEquals('130.00', $trxnAmount);
1211     $this->assertEquals('125.00', $this->_getFinancialItemAmount($contribution['id']));
1212   }
1213
1214   /**
1215    * Function tests that line items, financial records are updated when pay later contribution is received.
1216    */
1217   public function testCreateUpdateContributionPayLater() {
1218     $contribParams = [
1219       'contact_id' => $this->_individualId,
1220       'receive_date' => '2012-01-01',
1221       'total_amount' => 100.00,
1222       'financial_type_id' => $this->_financialTypeId,
1223       'payment_instrument_id' => 1,
1224       'contribution_status_id' => 2,
1225       'is_pay_later' => 1,
1226
1227     ];
1228     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1229
1230     $newParams = array_merge($contribParams, [
1231       'id' => $contribution['id'],
1232       'contribution_status_id' => 1,
1233     ]);
1234     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1235     $contribution = $contribution['values'][$contribution['id']];
1236     $this->assertEquals($contribution['contribution_status_id'], '1');
1237     $this->_checkFinancialItem($contribution['id'], 'paylater');
1238     $this->_checkFinancialTrxn($contribution, 'payLater');
1239   }
1240
1241   /**
1242    * Function tests that financial records are updated when Payment Instrument is changed.
1243    */
1244   public function testCreateUpdateContributionPaymentInstrument() {
1245     $instrumentId = $this->_addPaymentInstrument();
1246     $contribParams = [
1247       'contact_id' => $this->_individualId,
1248       'total_amount' => 100.00,
1249       'financial_type_id' => $this->_financialTypeId,
1250       'payment_instrument_id' => 4,
1251       'contribution_status_id' => 1,
1252
1253     ];
1254     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1255
1256     $newParams = array_merge($contribParams, [
1257       'id' => $contribution['id'],
1258       'payment_instrument_id' => $instrumentId,
1259     ]);
1260     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1261     $this->assertAPISuccess($contribution);
1262     $this->checkFinancialTrxnPaymentInstrumentChange($contribution['id'], 4, $instrumentId);
1263
1264     // cleanup - delete created payment instrument
1265     $this->_deletedAddedPaymentInstrument();
1266   }
1267
1268   /**
1269    * Function tests that financial records are updated when Payment Instrument is changed when amount is negative.
1270    */
1271   public function testCreateUpdateNegativeContributionPaymentInstrument() {
1272     $instrumentId = $this->_addPaymentInstrument();
1273     $contribParams = [
1274       'contact_id' => $this->_individualId,
1275       'total_amount' => -100.00,
1276       'financial_type_id' => $this->_financialTypeId,
1277       'payment_instrument_id' => 4,
1278       'contribution_status_id' => 1,
1279
1280     ];
1281     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1282
1283     $newParams = array_merge($contribParams, [
1284       'id' => $contribution['id'],
1285       'payment_instrument_id' => $instrumentId,
1286     ]);
1287     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1288     $this->assertAPISuccess($contribution);
1289     $this->checkFinancialTrxnPaymentInstrumentChange($contribution['id'], 4, $instrumentId, -100);
1290
1291     // cleanup - delete created payment instrument
1292     $this->_deletedAddedPaymentInstrument();
1293   }
1294
1295   /**
1296    * Function tests that financial records are added when Contribution is Refunded.
1297    *
1298    * @throws \CRM_Core_Exception
1299    */
1300   public function testCreateUpdateContributionRefund() {
1301     $contributionParams = [
1302       'contact_id' => $this->_individualId,
1303       'receive_date' => '2012-01-01',
1304       'total_amount' => 100.00,
1305       'financial_type_id' => $this->_financialTypeId,
1306       'payment_instrument_id' => 4,
1307       'contribution_status_id' => 1,
1308       'trxn_id' => 'original_payment',
1309     ];
1310     $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
1311     $newParams = array_merge($contributionParams, [
1312       'id' => $contribution['id'],
1313       'contribution_status_id' => 'Refunded',
1314       'cancel_date' => '2015-01-01 09:00',
1315       'refund_trxn_id' => 'the refund',
1316     ]);
1317
1318     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1319     $this->_checkFinancialTrxn($contribution, 'refund');
1320     $this->_checkFinancialItem($contribution['id'], 'refund');
1321     $this->assertEquals('original_payment', $this->callAPISuccessGetValue('Contribution', [
1322       'id' => $contribution['id'],
1323       'return' => 'trxn_id',
1324     ]));
1325   }
1326
1327   /**
1328    * Refund a contribution for a financial type with a contra account.
1329    *
1330    * CRM-17951 the contra account is a financial account with a relationship to a
1331    * financial type. It is not always configured but should be reflected
1332    * in the financial_trxn & financial_item table if it is.
1333    *
1334    * @throws \CRM_Core_Exception
1335    */
1336   public function testCreateUpdateChargebackContributionDefaultAccount() {
1337     $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params);
1338     $this->callAPISuccess('Contribution', 'create', [
1339       'id' => $contribution['id'],
1340       'contribution_status_id' => 'Chargeback',
1341     ]);
1342     $this->callAPISuccessGetSingle('Contribution', ['contribution_status_id' => 'Chargeback']);
1343
1344     $lineItems = $this->callAPISuccessGetSingle('LineItem', [
1345       'contribution_id' => $contribution['id'],
1346       'api.FinancialItem.getsingle' => ['amount' => ['<' => 0]],
1347     ]);
1348     $this->assertEquals(1, $lineItems['api.FinancialItem.getsingle']['financial_account_id']);
1349     $this->callAPISuccessGetSingle('FinancialTrxn', [
1350       'total_amount' => -100,
1351       'status_id' => 'Chargeback',
1352       'to_financial_account_id' => 6,
1353     ]);
1354   }
1355
1356   /**
1357    * Refund a contribution for a financial type with a contra account.
1358    *
1359    * CRM-17951 the contra account is a financial account with a relationship to a
1360    * financial type. It is not always configured but should be reflected
1361    * in the financial_trxn & financial_item table if it is.
1362    *
1363    * @throws \CRM_Core_Exception
1364    */
1365   public function testCreateUpdateChargebackContributionCustomAccount() {
1366     $financialAccount = $this->callAPISuccess('FinancialAccount', 'create', [
1367       'name' => 'Chargeback Account',
1368       'is_active' => TRUE,
1369     ]);
1370
1371     $entityFinancialAccount = $this->callAPISuccess('EntityFinancialAccount', 'create', [
1372       'entity_id' => $this->_financialTypeId,
1373       'entity_table' => 'civicrm_financial_type',
1374       'account_relationship' => 'Chargeback Account is',
1375       'financial_account_id' => 'Chargeback Account',
1376     ]);
1377
1378     $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params);
1379     $this->callAPISuccess('Contribution', 'create', [
1380       'id' => $contribution['id'],
1381       'contribution_status_id' => 'Chargeback',
1382     ]);
1383     $this->callAPISuccessGetSingle('Contribution', ['contribution_status_id' => 'Chargeback']);
1384
1385     $lineItems = $this->callAPISuccessGetSingle('LineItem', [
1386       'contribution_id' => $contribution['id'],
1387       'api.FinancialItem.getsingle' => ['amount' => ['<' => 0]],
1388     ]);
1389     $this->assertEquals($financialAccount['id'], $lineItems['api.FinancialItem.getsingle']['financial_account_id']);
1390
1391     $this->callAPISuccess('Contribution', 'delete', ['id' => $contribution['id']]);
1392     $this->callAPISuccess('EntityFinancialAccount', 'delete', ['id' => $entityFinancialAccount['id']]);
1393     $this->callAPISuccess('FinancialAccount', 'delete', ['id' => $financialAccount['id']]);
1394   }
1395
1396   /**
1397    * Refund a contribution for a financial type with a contra account.
1398    *
1399    * CRM-17951 the contra account is a financial account with a relationship to a
1400    * financial type. It is not always configured but should be reflected
1401    * in the financial_trxn & financial_item table if it is.
1402    */
1403   public function testCreateUpdateRefundContributionConfiguredContraAccount() {
1404     $financialAccount = $this->callAPISuccess('FinancialAccount', 'create', [
1405       'name' => 'Refund Account',
1406       'is_active' => TRUE,
1407     ]);
1408
1409     $entityFinancialAccount = $this->callAPISuccess('EntityFinancialAccount', 'create', [
1410       'entity_id' => $this->_financialTypeId,
1411       'entity_table' => 'civicrm_financial_type',
1412       'account_relationship' => 'Credit/Contra Revenue Account is',
1413       'financial_account_id' => 'Refund Account',
1414     ]);
1415
1416     $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params);
1417     $this->callAPISuccess('Contribution', 'create', [
1418       'id' => $contribution['id'],
1419       'contribution_status_id' => 'Refunded',
1420     ]);
1421
1422     $lineItems = $this->callAPISuccessGetSingle('LineItem', [
1423       'contribution_id' => $contribution['id'],
1424       'api.FinancialItem.getsingle' => ['amount' => ['<' => 0]],
1425     ]);
1426     $this->assertEquals($financialAccount['id'], $lineItems['api.FinancialItem.getsingle']['financial_account_id']);
1427
1428     $this->callAPISuccess('Contribution', 'delete', ['id' => $contribution['id']]);
1429     $this->callAPISuccess('EntityFinancialAccount', 'delete', ['id' => $entityFinancialAccount['id']]);
1430     $this->callAPISuccess('FinancialAccount', 'delete', ['id' => $financialAccount['id']]);
1431   }
1432
1433   /**
1434    * Function tests that trxn_id is set when passed in.
1435    *
1436    * Here we ensure that the civicrm_financial_trxn.trxn_id & the civicrm_contribution.trxn_id are set
1437    * when trxn_id is passed in.
1438    */
1439   public function testCreateUpdateContributionRefundTrxnIDPassedIn() {
1440     $contributionParams = [
1441       'contact_id' => $this->_individualId,
1442       'receive_date' => '2012-01-01',
1443       'total_amount' => 100.00,
1444       'financial_type_id' => $this->_financialTypeId,
1445       'payment_instrument_id' => 4,
1446       'contribution_status_id' => 1,
1447       'trxn_id' => 'original_payment',
1448     ];
1449     $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
1450     $newParams = array_merge($contributionParams, [
1451       'id' => $contribution['id'],
1452       'contribution_status_id' => 'Refunded',
1453       'cancel_date' => '2015-01-01 09:00',
1454       'trxn_id' => 'the refund',
1455     ]);
1456
1457     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1458     $this->_checkFinancialTrxn($contribution, 'refund');
1459     $this->_checkFinancialItem($contribution['id'], 'refund');
1460     $this->assertEquals('the refund', $this->callAPISuccessGetValue('Contribution', [
1461       'id' => $contribution['id'],
1462       'return' => 'trxn_id',
1463     ]));
1464   }
1465
1466   /**
1467    * Function tests that trxn_id is set when passed in.
1468    *
1469    * Here we ensure that the civicrm_contribution.trxn_id is set
1470    * when trxn_id is passed in but if refund_trxn_id is different then that
1471    * is kept for the refund transaction.
1472    */
1473   public function testCreateUpdateContributionRefundRefundAndTrxnIDPassedIn() {
1474     $contributionParams = [
1475       'contact_id' => $this->_individualId,
1476       'receive_date' => '2012-01-01',
1477       'total_amount' => 100.00,
1478       'financial_type_id' => $this->_financialTypeId,
1479       'payment_instrument_id' => 4,
1480       'contribution_status_id' => 1,
1481       'trxn_id' => 'original_payment',
1482     ];
1483     $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
1484     $newParams = array_merge($contributionParams, [
1485       'id' => $contribution['id'],
1486       'contribution_status_id' => 'Refunded',
1487       'cancel_date' => '2015-01-01 09:00',
1488       'trxn_id' => 'cont id',
1489       'refund_trxn_id' => 'the refund',
1490     ]);
1491
1492     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1493     $this->_checkFinancialTrxn($contribution, 'refund');
1494     $this->_checkFinancialItem($contribution['id'], 'refund');
1495     $this->assertEquals('cont id', $this->callAPISuccessGetValue('Contribution', [
1496       'id' => $contribution['id'],
1497       'return' => 'trxn_id',
1498     ]));
1499   }
1500
1501   /**
1502    * Function tests that refund_trxn_id is set when passed in empty.
1503    *
1504    * Here we ensure that the civicrm_contribution.trxn_id is set
1505    * when trxn_id is passed in but if refund_trxn_id isset but empty then that
1506    * is kept for the refund transaction.
1507    */
1508   public function testCreateUpdateContributionRefundRefundNullTrxnIDPassedIn() {
1509     $contributionParams = [
1510       'contact_id' => $this->_individualId,
1511       'receive_date' => '2012-01-01',
1512       'total_amount' => 100.00,
1513       'financial_type_id' => $this->_financialTypeId,
1514       'payment_instrument_id' => 4,
1515       'contribution_status_id' => 1,
1516       'trxn_id' => 'original_payment',
1517     ];
1518     $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
1519     $newParams = array_merge($contributionParams, [
1520       'id' => $contribution['id'],
1521       'contribution_status_id' => 'Refunded',
1522       'cancel_date' => '2015-01-01 09:00',
1523       'trxn_id' => 'cont id',
1524       'refund_trxn_id' => '',
1525     ]);
1526
1527     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1528     $this->_checkFinancialTrxn($contribution, 'refund', NULL, ['trxn_id' => NULL]);
1529     $this->_checkFinancialItem($contribution['id'], 'refund');
1530     $this->assertEquals('cont id', $this->callAPISuccessGetValue('Contribution', [
1531       'id' => $contribution['id'],
1532       'return' => 'trxn_id',
1533     ]));
1534   }
1535
1536   /**
1537    * Function tests invalid contribution status change.
1538    */
1539   public function testCreateUpdateContributionInValidStatusChange() {
1540     $contribParams = [
1541       'contact_id' => 1,
1542       'receive_date' => '2012-01-01',
1543       'total_amount' => 100.00,
1544       'financial_type_id' => 1,
1545       'payment_instrument_id' => 1,
1546       'contribution_status_id' => 1,
1547     ];
1548     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1549     $newParams = array_merge($contribParams, [
1550       'id' => $contribution['id'],
1551       'contribution_status_id' => 2,
1552     ]);
1553     $this->callAPIFailure('contribution', 'create', $newParams, ts('Cannot change contribution status from Completed to Pending.'));
1554
1555   }
1556
1557   /**
1558    * Function tests that financial records are added when Pending Contribution is Canceled.
1559    */
1560   public function testCreateUpdateContributionCancelPending() {
1561     // Enable & disable invoicing just to standardise the credit note id setting.
1562     // Longer term we want to separate that setting from 'taxAndInvoicing'.
1563     // and / or remove from core.
1564     $this->enableTaxAndInvoicing();
1565     $contribParams = [
1566       'contact_id' => $this->_individualId,
1567       'receive_date' => '2012-01-01',
1568       'total_amount' => 100.00,
1569       'financial_type_id' => $this->_financialTypeId,
1570       'payment_instrument_id' => 1,
1571       'contribution_status_id' => 2,
1572       'is_pay_later' => 1,
1573
1574     ];
1575     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1576     $newParams = array_merge($contribParams, [
1577       'id' => $contribution['id'],
1578       'contribution_status_id' => 3,
1579       'cancel_date' => '2012-02-02 09:00',
1580     ]);
1581     //Check if trxn_date is same as cancel_date.
1582     $checkTrxnDate = [
1583       'trxn_date' => '2012-02-02 09:00:00',
1584     ];
1585     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1586     $this->_checkFinancialTrxn($contribution, 'cancelPending', NULL, $checkTrxnDate);
1587     $this->_checkFinancialItem($contribution['id'], 'cancelPending');
1588     $this->assertEquals('CN_1', $contribution['values'][$contribution['id']]['creditnote_id']);
1589     $this->disableTaxAndInvoicing();
1590   }
1591
1592   /**
1593    * Function tests that financial records are added when Financial Type is Changed.
1594    *
1595    * @throws \CRM_Core_Exception
1596    */
1597   public function testCreateUpdateContributionChangeFinancialType() {
1598     $contribParams = [
1599       'contact_id' => $this->_individualId,
1600       'receive_date' => '2012-01-01',
1601       'total_amount' => 100.00,
1602       'financial_type_id' => 1,
1603       'payment_instrument_id' => 1,
1604       'contribution_status_id' => 1,
1605
1606     ];
1607     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1608     $newParams = array_merge($contribParams, [
1609       'id' => $contribution['id'],
1610       'financial_type_id' => 3,
1611     ]);
1612     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1613     $this->_checkFinancialTrxn($contribution, 'changeFinancial');
1614     $this->_checkFinancialItem($contribution['id'], 'changeFinancial');
1615   }
1616
1617   /**
1618    * Test that update does not change status id CRM-15105.
1619    */
1620   public function testCreateUpdateWithoutChangingPendingStatus() {
1621     $contribution = $this->callAPISuccess('contribution', 'create', array_merge($this->_params, ['contribution_status_id' => 2]));
1622     $this->callAPISuccess('contribution', 'create', ['id' => $contribution['id'], 'source' => 'new source']);
1623     $contribution = $this->callAPISuccess('contribution', 'getsingle', [
1624       'id' => $contribution['id'],
1625       'api.contribution.delete' => 1,
1626     ]);
1627     $this->assertEquals(2, $contribution['contribution_status_id']);
1628   }
1629
1630   /**
1631    * Test Updating a Contribution.
1632    *
1633    * CHANGE: we require the API to do an incremental update
1634    */
1635   public function testCreateUpdateContribution() {
1636     $contributionID = $this->contributionCreate([
1637       'contact_id' => $this->_individualId,
1638       'trxn_id' => 212355,
1639       'financial_type_id' => $this->_financialTypeId,
1640       'invoice_id' => 'old_invoice',
1641     ]);
1642     $old_params = [
1643       'contribution_id' => $contributionID,
1644     ];
1645     $original = $this->callAPISuccess('contribution', 'get', $old_params);
1646     $this->assertEquals($original['id'], $contributionID);
1647     //set up list of old params, verify
1648
1649     //This should not be required on update:
1650     $old_contact_id = $original['values'][$contributionID]['contact_id'];
1651     $old_payment_instrument = $original['values'][$contributionID]['instrument_id'];
1652     $old_fee_amount = $original['values'][$contributionID]['fee_amount'];
1653     $old_source = $original['values'][$contributionID]['contribution_source'];
1654
1655     $old_trxn_id = $original['values'][$contributionID]['trxn_id'];
1656     $old_invoice_id = $original['values'][$contributionID]['invoice_id'];
1657
1658     //check against values in CiviUnitTestCase::createContribution()
1659     $this->assertEquals($old_contact_id, $this->_individualId);
1660     $this->assertEquals($old_fee_amount, 5.00);
1661     $this->assertEquals($old_source, 'SSF');
1662     $this->assertEquals($old_trxn_id, 212355);
1663     $this->assertEquals($old_invoice_id, 'old_invoice');
1664     $params = [
1665       'id' => $contributionID,
1666       'contact_id' => $this->_individualId,
1667       'total_amount' => 105.00,
1668       'fee_amount' => 7.00,
1669       'financial_type_id' => $this->_financialTypeId,
1670       'non_deductible_amount' => 22.00,
1671       'contribution_status_id' => 1,
1672       'note' => 'Donating for Noble Cause',
1673     ];
1674
1675     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1676
1677     $new_params = [
1678       'contribution_id' => $contribution['id'],
1679     ];
1680     $contribution = $this->callAPISuccessGetSingle('contribution', $new_params);
1681
1682     $this->assertEquals($contribution['contact_id'], $this->_individualId);
1683     $this->assertEquals($contribution['total_amount'], 105.00);
1684     $this->assertEquals($contribution['financial_type_id'], $this->_financialTypeId);
1685     $this->assertEquals($contribution['financial_type'], 'Donation');
1686     $this->assertEquals($contribution['instrument_id'], $old_payment_instrument);
1687     $this->assertEquals($contribution['non_deductible_amount'], 22.00);
1688     $this->assertEquals($contribution['fee_amount'], 7.00);
1689     $this->assertEquals($contribution['trxn_id'], $old_trxn_id);
1690     $this->assertEquals($contribution['invoice_id'], $old_invoice_id);
1691     $this->assertEquals($contribution['contribution_source'], $old_source);
1692     $this->assertEquals($contribution['contribution_status'], 'Completed');
1693
1694     $this->assertEquals($contribution['net_amount'], $contribution['total_amount'] - $contribution['fee_amount']);
1695
1696     $params = [
1697       'contribution_id' => $contributionID,
1698     ];
1699     $result = $this->callAPISuccess('contribution', 'delete', $params);
1700     $this->assertAPISuccess($result);
1701   }
1702
1703   /**
1704    * Check that net_amount is updated when a contribution is updated.
1705    *
1706    * Update fee amount AND total amount, just fee amount, just total amount
1707    * and neither to check that net_amount is keep updated.
1708    */
1709   public function testUpdateContributionNetAmountVariants() {
1710     $contributionID = $this->contributionCreate(['contact_id' => $this->individualCreate()]);
1711
1712     $this->callAPISuccess('Contribution', 'create', [
1713       'id' => $contributionID,
1714       'total_amount' => 90,
1715       'fee_amount' => 6,
1716     ]);
1717     $contribution = $this->callAPISuccessGetSingle('Contribution', [
1718       'id' => $contributionID,
1719       'return' => ['net_amount', 'fee_amount', 'total_amount'],
1720     ]);
1721     $this->assertEquals(6, $contribution['fee_amount']);
1722     $this->assertEquals(90, $contribution['total_amount']);
1723     $this->assertEquals(84, $contribution['net_amount']);
1724
1725     $this->callAPISuccess('Contribution', 'create', [
1726       'id' => $contributionID,
1727       'fee_amount' => 3,
1728     ]);
1729     $contribution = $this->callAPISuccessGetSingle('Contribution', [
1730       'id' => $contributionID,
1731       'return' => ['net_amount', 'fee_amount', 'total_amount'],
1732     ]);
1733     $this->assertEquals(3, $contribution['fee_amount']);
1734     $this->assertEquals(90, $contribution['total_amount']);
1735     $this->assertEquals(87, $contribution['net_amount']);
1736
1737     $this->callAPISuccess('Contribution', 'create', [
1738       'id' => $contributionID,
1739       'total_amount' => 200,
1740     ]);
1741     $contribution = $this->callAPISuccessGetSingle('Contribution', [
1742       'id' => $contributionID,
1743       'return' => ['net_amount', 'fee_amount', 'total_amount'],
1744     ]);
1745     $this->assertEquals(3, $contribution['fee_amount']);
1746     $this->assertEquals(200, $contribution['total_amount']);
1747     $this->assertEquals(197, $contribution['net_amount']);
1748
1749     $this->callAPISuccess('Contribution', 'create', [
1750       'id' => $contributionID,
1751       'payment_instrument' => 'Cash',
1752     ]);
1753     $contribution = $this->callAPISuccessGetSingle('Contribution', [
1754       'id' => $contributionID,
1755       'return' => ['net_amount', 'fee_amount', 'total_amount'],
1756     ]);
1757     $this->assertEquals(3, $contribution['fee_amount']);
1758     $this->assertEquals(200, $contribution['total_amount']);
1759     $this->assertEquals(197, $contribution['net_amount']);
1760   }
1761
1762   /**
1763    * Attempt (but fail) to delete a contribution without parameters.
1764    */
1765   public function testDeleteEmptyParamsContribution() {
1766     $params = [];
1767     $this->callAPIFailure('contribution', 'delete', $params);
1768   }
1769
1770   public function testDeleteParamsNotArrayContribution() {
1771     $params = 'contribution_id= 1';
1772     $contribution = $this->callAPIFailure('contribution', 'delete', $params);
1773     $this->assertEquals($contribution['error_message'], 'Input variable `params` is not an array');
1774   }
1775
1776   public function testDeleteWrongParamContribution() {
1777     $params = [
1778       'contribution_source' => 'SSF',
1779     ];
1780     $this->callAPIFailure('contribution', 'delete', $params);
1781   }
1782
1783   public function testDeleteContribution() {
1784     $contributionID = $this->contributionCreate([
1785       'contact_id' => $this->_individualId,
1786       'financial_type_id' => $this->_financialTypeId,
1787     ]);
1788     $params = [
1789       'id' => $contributionID,
1790     ];
1791     $this->callAPIAndDocument('contribution', 'delete', $params, __FUNCTION__, __FILE__);
1792   }
1793
1794   /**
1795    * Test civicrm_contribution_search with empty params.
1796    *
1797    * All available contributions expected.
1798    */
1799   public function testSearchEmptyParams() {
1800     $params = [];
1801
1802     $p = [
1803       'contact_id' => $this->_individualId,
1804       'receive_date' => date('Ymd'),
1805       'total_amount' => 100.00,
1806       'financial_type_id' => $this->_financialTypeId,
1807       'non_deductible_amount' => 10.00,
1808       'fee_amount' => 5.00,
1809       'net_amount' => 95.00,
1810       'trxn_id' => 23456,
1811       'invoice_id' => 78910,
1812       'source' => 'SSF',
1813       'contribution_status_id' => 1,
1814     ];
1815     $contribution = $this->callAPISuccess('contribution', 'create', $p);
1816
1817     $result = $this->callAPISuccess('contribution', 'get', $params);
1818     // We're taking the first element.
1819     $res = $result['values'][$contribution['id']];
1820
1821     $this->assertEquals($p['contact_id'], $res['contact_id']);
1822     $this->assertEquals($p['total_amount'], $res['total_amount']);
1823     $this->assertEquals($p['financial_type_id'], $res['financial_type_id']);
1824     $this->assertEquals($p['net_amount'], $res['net_amount']);
1825     $this->assertEquals($p['non_deductible_amount'], $res['non_deductible_amount']);
1826     $this->assertEquals($p['fee_amount'], $res['fee_amount']);
1827     $this->assertEquals($p['trxn_id'], $res['trxn_id']);
1828     $this->assertEquals($p['invoice_id'], $res['invoice_id']);
1829     $this->assertEquals($p['source'], $res['contribution_source']);
1830     // contribution_status_id = 1 => Completed
1831     $this->assertEquals('Completed', $res['contribution_status']);
1832
1833     $this->contributionDelete($contribution['id']);
1834   }
1835
1836   /**
1837    * Test civicrm_contribution_search. Success expected.
1838    */
1839   public function testSearch() {
1840     $p1 = [
1841       'contact_id' => $this->_individualId,
1842       'receive_date' => date('Ymd'),
1843       'total_amount' => 100.00,
1844       'financial_type_id' => $this->_financialTypeId,
1845       'non_deductible_amount' => 10.00,
1846       'contribution_status_id' => 1,
1847     ];
1848     $contribution1 = $this->callAPISuccess('contribution', 'create', $p1);
1849
1850     $p2 = [
1851       'contact_id' => $this->_individualId,
1852       'receive_date' => date('Ymd'),
1853       'total_amount' => 200.00,
1854       'financial_type_id' => $this->_financialTypeId,
1855       'non_deductible_amount' => 20.00,
1856       'trxn_id' => 5454565,
1857       'invoice_id' => 1212124,
1858       'fee_amount' => 50.00,
1859       'net_amount' => 60.00,
1860       'contribution_status_id' => 2,
1861     ];
1862     $contribution2 = $this->callAPISuccess('contribution', 'create', $p2);
1863
1864     $params = [
1865       'contribution_id' => $contribution2['id'],
1866     ];
1867     $result = $this->callAPISuccess('contribution', 'get', $params);
1868     $res = $result['values'][$contribution2['id']];
1869
1870     $this->assertEquals($p2['contact_id'], $res['contact_id']);
1871     $this->assertEquals($p2['total_amount'], $res['total_amount']);
1872     $this->assertEquals($p2['financial_type_id'], $res['financial_type_id']);
1873     $this->assertEquals($p2['net_amount'], $res['net_amount']);
1874     $this->assertEquals($p2['non_deductible_amount'], $res['non_deductible_amount']);
1875     $this->assertEquals($p2['fee_amount'], $res['fee_amount']);
1876     $this->assertEquals($p2['trxn_id'], $res['trxn_id']);
1877     $this->assertEquals($p2['invoice_id'], $res['invoice_id']);
1878     $this->assertEquals(CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending'), $res['contribution_status_id']);
1879
1880     $this->contributionDelete($contribution1['id']);
1881     $this->contributionDelete($contribution2['id']);
1882   }
1883
1884   /**
1885    * Test completing a transaction via the API.
1886    *
1887    * Note that we are creating a logged in user because email goes out from
1888    * that person
1889    */
1890   public function testCompleteTransaction() {
1891     $mut = new CiviMailUtils($this, TRUE);
1892     $this->swapMessageTemplateForTestTemplate();
1893     $this->createLoggedInUser();
1894     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
1895     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1896     $this->callAPISuccess('contribution', 'completetransaction', [
1897       'id' => $contribution['id'],
1898     ]);
1899     $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id']]);
1900     $this->assertEquals('SSF', $contribution['contribution_source']);
1901     $this->assertEquals('Completed', $contribution['contribution_status']);
1902     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receipt_date'])));
1903     $mut->checkMailLog([
1904       'email:::anthony_anderson@civicrm.org',
1905       'is_monetary:::1',
1906       'amount:::100.00',
1907       'currency:::USD',
1908       'receive_date:::' . date('Ymd', strtotime($contribution['receive_date'])),
1909       "receipt_date:::\n",
1910       'contributeMode:::notify',
1911       'title:::Contribution',
1912       'displayName:::Mr. Anthony Anderson II',
1913       'contributionStatus:::Completed',
1914     ]);
1915     $mut->stop();
1916     $this->revertTemplateToReservedTemplate();
1917   }
1918
1919   /**
1920    * Test completing a transaction via the API with a non-USD transaction.
1921    */
1922   public function testCompleteTransactionEuro() {
1923     $mut = new CiviMailUtils($this, TRUE);
1924     $this->swapMessageTemplateForTestTemplate();
1925     $this->createLoggedInUser();
1926     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'currency' => 'EUR']);
1927     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1928
1929     $this->callAPISuccess('contribution', 'completetransaction', [
1930       'id' => $contribution['id'],
1931     ]);
1932
1933     $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id']]);
1934     $this->assertEquals('SSF', $contribution['contribution_source']);
1935     $this->assertEquals('Completed', $contribution['contribution_status']);
1936     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receipt_date'])));
1937
1938     $entityFinancialTransactions = $this->getFinancialTransactionsForContribution($contribution['id']);
1939     $entityFinancialTransaction = reset($entityFinancialTransactions);
1940     $financialTrxn = $this->callAPISuccessGetSingle('FinancialTrxn', ['id' => $entityFinancialTransaction['financial_trxn_id']]);
1941     $this->assertEquals('EUR', $financialTrxn['currency']);
1942
1943     $mut->checkMailLog([
1944       'email:::anthony_anderson@civicrm.org',
1945       'is_monetary:::1',
1946       'amount:::100.00',
1947       'currency:::EUR',
1948       'receive_date:::' . date('Ymd', strtotime($contribution['receive_date'])),
1949       "receipt_date:::\n",
1950       'contributeMode:::notify',
1951       'title:::Contribution',
1952       'displayName:::Mr. Anthony Anderson II',
1953       'contributionStatus:::Completed',
1954     ]);
1955     $mut->stop();
1956     $this->revertTemplateToReservedTemplate();
1957   }
1958
1959   /**
1960    * Test to ensure mail is sent on chosing pay later
1961    */
1962   public function testpayLater() {
1963     $mut = new CiviMailUtils($this, TRUE);
1964     $this->swapMessageTemplateForTestTemplate();
1965     $this->createLoggedInUser();
1966
1967     // create contribution page first
1968     $contributionPageParams = [
1969       'title' => 'Help Support CiviCRM!',
1970       'financial_type_id' => 1,
1971       'is_monetary' => TRUE,
1972       'is_pay_later' => 1,
1973       'is_quick_config' => TRUE,
1974       'pay_later_text' => 'I will send payment by check',
1975       'pay_later_receipt' => 'This is a pay later reciept',
1976       'is_allow_other_amount' => 1,
1977       'min_amount' => 10.00,
1978       'max_amount' => 10000.00,
1979       'goal_amount' => 100000.00,
1980       'is_email_receipt' => 1,
1981       'is_active' => 1,
1982       'amount_block_is_active' => 1,
1983       'currency' => 'USD',
1984       'is_billing_required' => 0,
1985     ];
1986     $contributionPageResult = $this->callAPISuccess('contribution_page', 'create', $contributionPageParams);
1987
1988     // submit form values
1989     $priceSet = $this->callAPISuccess('price_set', 'getsingle', ['name' => 'default_contribution_amount']);
1990     $params = [
1991       'id' => $contributionPageResult['id'],
1992       'contact_id' => $this->_individualId,
1993       'email-5' => 'anthony_anderson@civicrm.org',
1994       'payment_processor_id' => 0,
1995       'amount' => 100.00,
1996       'tax_amount' => '',
1997       'currencyID' => 'USD',
1998       'is_pay_later' => 1,
1999       'invoiceID' => 'f28e1ddc86f8c4a0ff5bcf46393e4bc8',
2000       'is_quick_config' => 1,
2001       'description' => 'Online Contribution: Help Support CiviCRM!',
2002       'price_set_id' => $priceSet['id'],
2003     ];
2004     $this->callAPISuccess('contribution_page', 'submit', $params);
2005
2006     $mut->checkMailLog([
2007       'is_pay_later:::1',
2008       'email:::anthony_anderson@civicrm.org',
2009       'pay_later_receipt:::' . $contributionPageParams['pay_later_receipt'],
2010       'displayName:::Mr. Anthony Anderson II',
2011       'contributionPageId:::' . $contributionPageResult['id'],
2012       'title:::' . $contributionPageParams['title'],
2013       'amount:::' . $params['amount'],
2014     ]);
2015     $mut->stop();
2016     $this->revertTemplateToReservedTemplate();
2017   }
2018
2019   /**
2020    * Test to check whether contact billing address is used when no contribution address
2021    */
2022   public function testBillingAddress() {
2023     $mut = new CiviMailUtils($this, TRUE);
2024     $this->swapMessageTemplateForTestTemplate();
2025     $this->createLoggedInUser();
2026
2027     //Scenario 1: When Contact don't have any address
2028     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2029     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2030     $this->callAPISuccess('contribution', 'completetransaction', [
2031       'id' => $contribution['id'],
2032     ]);
2033     $mut->checkMailLog([
2034       'address:::',
2035     ]);
2036
2037     // Scenario 2: Contribution using address
2038     $address = $this->callAPISuccess('address', 'create', [
2039       'street_address' => 'contribution billing st',
2040       'location_type_id' => 2,
2041       'contact_id' => $this->_params['contact_id'],
2042     ]);
2043     $params = array_merge($this->_params, [
2044       'contribution_status_id' => 2,
2045       'address_id' => $address['id'],
2046     ]
2047     );
2048     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2049     $this->callAPISuccess('contribution', 'completetransaction', [
2050       'id' => $contribution['id'],
2051     ]);
2052     $mut->checkMailLog([
2053       'address:::contribution billing st',
2054     ]);
2055
2056     // Scenario 3: Contribution wtth no address but contact has a billing address
2057     $this->callAPISuccess('address', 'create', [
2058       'id' => $address['id'],
2059       'street_address' => 'is billing st',
2060       'contact_id' => $this->_params['contact_id'],
2061     ]);
2062     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2063     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2064     $this->callAPISuccess('contribution', 'completetransaction', [
2065       'id' => $contribution['id'],
2066     ]);
2067     $mut->checkMailLog([
2068       'address:::is billing st',
2069     ]);
2070
2071     $mut->stop();
2072     $this->revertTemplateToReservedTemplate();
2073   }
2074
2075   /**
2076    * Test completing a transaction via the API.
2077    *
2078    * Note that we are creating a logged in user because email goes out from
2079    * that person
2080    */
2081   public function testCompleteTransactionFeeAmount() {
2082     $this->createLoggedInUser();
2083     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2084     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2085     $this->callAPISuccess('contribution', 'completetransaction', [
2086       'id' => $contribution['id'],
2087       'fee_amount' => '.56',
2088       'trxn_id' => '7778888',
2089     ]);
2090     $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id'], 'sequential' => 1]);
2091     $this->assertEquals('Completed', $contribution['contribution_status']);
2092     $this->assertEquals('7778888', $contribution['trxn_id']);
2093     $this->assertEquals('.56', $contribution['fee_amount']);
2094     $this->assertEquals('99.44', $contribution['net_amount']);
2095   }
2096
2097   /**
2098    * CRM-19126 Add test to verify when complete transaction is called tax amount is not changed.
2099    *
2100    * @param string $thousandSeparator
2101    *   punctuation used to refer to thousands.
2102    *
2103    * @dataProvider getThousandSeparators
2104    */
2105   public function testCheckTaxAmount($thousandSeparator) {
2106     $this->setCurrencySeparators($thousandSeparator);
2107     $contact = $this->createLoggedInUser();
2108     $financialType = $this->callAPISuccess('financial_type', 'create', [
2109       'name' => 'Test taxable financial Type',
2110       'is_reserved' => 0,
2111       'is_active' => 1,
2112     ]);
2113     $financialAccount = $this->callAPISuccess('financial_account', 'create', [
2114       'name' => 'Test Tax financial account ',
2115       'contact_id' => $contact,
2116       'financial_account_type_id' => 2,
2117       'is_tax' => 1,
2118       'tax_rate' => 5.00,
2119       'is_reserved' => 0,
2120       'is_active' => 1,
2121       'is_default' => 0,
2122     ]);
2123     $financialTypeId = $financialType['id'];
2124     $financialAccountId = $financialAccount['id'];
2125     $financialAccountParams = [
2126       'entity_table' => 'civicrm_financial_type',
2127       'entity_id' => $financialTypeId,
2128       'account_relationship' => 10,
2129       'financial_account_id' => $financialAccountId,
2130     ];
2131     CRM_Financial_BAO_FinancialTypeAccount::add($financialAccountParams);
2132
2133     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'financial_type_id' => $financialTypeId]);
2134     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2135     $contribution1 = $this->callAPISuccess('contribution', 'get', ['id' => $contribution['id'], 'return' => 'tax_amount', 'sequential' => 1]);
2136     $this->callAPISuccess('contribution', 'completetransaction', [
2137       'id' => $contribution['id'],
2138       'trxn_id' => '777788888',
2139       'fee_amount' => '6.00',
2140     ]);
2141     $contribution2 = $this->callAPISuccess('contribution', 'get', ['id' => $contribution['id'], 'return' => ['tax_amount', 'fee_amount', 'net_amount'], 'sequential' => 1]);
2142     $this->assertEquals($contribution1['values'][0]['tax_amount'], $contribution2['values'][0]['tax_amount']);
2143     $this->assertEquals('6.00', $contribution2['values'][0]['fee_amount']);
2144     $this->assertEquals('99.00', $contribution2['values'][0]['net_amount']);
2145   }
2146
2147   /**
2148    * Test repeat contribution successfully creates line item.
2149    */
2150   public function testRepeatTransaction() {
2151     $originalContribution = $this->setUpRepeatTransaction($recurParams = [], 'single');
2152     $this->callAPISuccess('contribution', 'repeattransaction', [
2153       'original_contribution_id' => $originalContribution['id'],
2154       'contribution_status_id' => 'Completed',
2155       'trxn_id' => uniqid(),
2156     ]);
2157     $lineItemParams = [
2158       'entity_id' => $originalContribution['id'],
2159       'sequential' => 1,
2160       'return' => [
2161         'entity_table',
2162         'qty',
2163         'unit_price',
2164         'line_total',
2165         'label',
2166         'financial_type_id',
2167         'deductible_amount',
2168         'price_field_value_id',
2169         'price_field_id',
2170       ],
2171     ];
2172     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2173       'entity_id' => $originalContribution['id'],
2174     ]));
2175     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2176       'entity_id' => $originalContribution['id'] + 1,
2177     ]));
2178     unset($lineItem1['values'][0]['id'], $lineItem1['values'][0]['entity_id']);
2179     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2180     $this->assertEquals($lineItem1['values'][0], $lineItem2['values'][0]);
2181     $this->_checkFinancialRecords([
2182       'id' => $originalContribution['id'] + 1,
2183       'payment_instrument_id' => $this->callAPISuccessGetValue('PaymentProcessor', [
2184         'id' => $originalContribution['payment_processor_id'],
2185         'return' => 'payment_instrument_id',
2186       ]),
2187     ], 'online');
2188     $this->quickCleanUpFinancialEntities();
2189   }
2190
2191   /**
2192    * Test repeat contribution successfully creates line items (plural).
2193    */
2194   public function testRepeatTransactionLineItems() {
2195     // CRM-19309
2196     $originalContribution = $this->setUpRepeatTransaction($recurParams = [], 'multiple');
2197     $this->callAPISuccess('contribution', 'repeattransaction', [
2198       'original_contribution_id' => $originalContribution['id'],
2199       'contribution_status_id' => 'Completed',
2200       'trxn_id' => uniqid(),
2201     ]);
2202
2203     $lineItemParams = [
2204       'entity_id' => $originalContribution['id'],
2205       'sequential' => 1,
2206       'return' => [
2207         'entity_table',
2208         'qty',
2209         'unit_price',
2210         'line_total',
2211         'label',
2212         'financial_type_id',
2213         'deductible_amount',
2214         'price_field_value_id',
2215         'price_field_id',
2216       ],
2217     ];
2218     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2219       'entity_id' => $originalContribution['id'],
2220     ]));
2221     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2222       'entity_id' => $originalContribution['id'] + 1,
2223     ]));
2224
2225     // unset id and entity_id for all of them to be able to compare the lineItems:
2226     unset($lineItem1['values'][0]['id'], $lineItem1['values'][0]['entity_id']);
2227     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2228     $this->assertEquals($lineItem1['values'][0], $lineItem2['values'][0]);
2229
2230     unset($lineItem1['values'][1]['id'], $lineItem1['values'][1]['entity_id']);
2231     unset($lineItem2['values'][1]['id'], $lineItem2['values'][1]['entity_id']);
2232     $this->assertEquals($lineItem1['values'][1], $lineItem2['values'][1]);
2233
2234     // CRM-19309 so in future we also want to:
2235     // check that financial_line_items have been created for entity_id 3 and 4;
2236
2237     $this->callAPISuccessGetCount('FinancialItem', ['description' => 'Sales Tax', 'amount' => 0], 0);
2238     $this->quickCleanUpFinancialEntities();
2239   }
2240
2241   /**
2242    * Test repeat contribution successfully creates is_test transaction.
2243    */
2244   public function testRepeatTransactionIsTest() {
2245     $this->_params['is_test'] = 1;
2246     $originalContribution = $this->setUpRepeatTransaction(['is_test' => 1], 'single');
2247
2248     $this->callAPISuccess('contribution', 'repeattransaction', [
2249       'original_contribution_id' => $originalContribution['id'],
2250       'contribution_status_id' => 'Completed',
2251       'trxn_id' => uniqid(),
2252     ]);
2253     $this->callAPISuccessGetCount('Contribution', ['contribution_test' => 1], 2);
2254   }
2255
2256   /**
2257    * Test repeat contribution passed in status.
2258    */
2259   public function testRepeatTransactionPassedInStatus() {
2260     $originalContribution = $this->setUpRepeatTransaction($recurParams = [], 'single');
2261
2262     $this->callAPISuccess('contribution', 'repeattransaction', [
2263       'original_contribution_id' => $originalContribution['id'],
2264       'contribution_status_id' => 'Pending',
2265       'trxn_id' => uniqid(),
2266     ]);
2267     $this->callAPISuccessGetCount('Contribution', ['contribution_status_id' => 2], 1);
2268   }
2269
2270   /**
2271    * Test repeat contribution accepts recur_id instead of original_contribution_id.
2272    */
2273   public function testRepeatTransactionAcceptRecurID() {
2274     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2275       'contact_id' => $this->_individualId,
2276       'installments' => '12',
2277       'frequency_interval' => '1',
2278       'amount' => '100',
2279       'contribution_status_id' => 1,
2280       'start_date' => '2012-01-01 00:00:00',
2281       'currency' => 'USD',
2282       'frequency_unit' => 'month',
2283       'payment_processor_id' => $this->paymentProcessorID,
2284     ]);
2285     $this->callAPISuccess('contribution', 'create', array_merge(
2286         $this->_params,
2287         ['contribution_recur_id' => $contributionRecur['id']])
2288     );
2289
2290     $this->callAPISuccess('contribution', 'repeattransaction', [
2291       'contribution_recur_id' => $contributionRecur['id'],
2292       'contribution_status_id' => 'Completed',
2293       'trxn_id' => uniqid(),
2294     ]);
2295
2296     $this->quickCleanUpFinancialEntities();
2297   }
2298
2299   /**
2300    * CRM-19873 Test repattransaction if contribution_recur_id is a test.
2301    */
2302   public function testRepeatTransactionTestRecurId() {
2303     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2304       'contact_id' => $this->_individualId,
2305       'frequency_interval' => '1',
2306       'amount' => '1.00',
2307       'contribution_status_id' => 1,
2308       'start_date' => '2017-01-01 00:00:00',
2309       'currency' => 'USD',
2310       'frequency_unit' => 'month',
2311       'payment_processor_id' => $this->paymentProcessorID,
2312       'is_test' => 1,
2313     ]);
2314     $this->callAPISuccess('contribution', 'create', array_merge(
2315         $this->_params,
2316         [
2317           'contribution_recur_id' => $contributionRecur['id'],
2318           'is_test' => 1,
2319         ])
2320     );
2321
2322     $repeatedContribution = $this->callAPISuccess('contribution', 'repeattransaction', [
2323       'contribution_recur_id' => $contributionRecur['id'],
2324       'contribution_status_id' => 'Completed',
2325       'trxn_id' => uniqid(),
2326     ]);
2327
2328     $this->assertEquals($contributionRecur['values'][1]['is_test'], $repeatedContribution['values'][2]['is_test']);
2329     $this->quickCleanUpFinancialEntities();
2330   }
2331
2332   /**
2333    * CRM-19945 Tests that Contribute.repeattransaction renews a membership when contribution status=Completed
2334    *
2335    */
2336   public function testRepeatTransactionMembershipRenewCompletedContribution() {
2337     list($originalContribution, $membership) = $this->setUpAutoRenewMembership();
2338
2339     $this->callAPISuccess('contribution', 'create', [
2340       'contact_id' => $originalContribution['values'][1]['contact_id'],
2341       'financial_type_id' => $originalContribution['values'][1]['financial_type_id'],
2342       'total_amount' => $originalContribution['values'][1]['total_amount'],
2343       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2344       'contribution_status_id' => "Failed",
2345     ]);
2346
2347     $this->callAPISuccess('membership', 'create', [
2348       'id' => $membership['id'],
2349       'end_date' => 'yesterday',
2350       'status_id' => 'Expired',
2351     ]);
2352
2353     $contribution = $this->callAPISuccess('contribution', 'repeattransaction', [
2354       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2355       'contribution_status_id' => 'Completed',
2356       'trxn_id' => 'bobsled',
2357     ]);
2358
2359     $membershipStatusId = $this->callAPISuccess('membership', 'getvalue', [
2360       'id' => $membership['id'],
2361       'return' => 'status_id',
2362     ]);
2363
2364     $membership = $this->callAPISuccess('membership', 'get', [
2365       'id' => $membership['id'],
2366     ]);
2367
2368     $this->assertEquals('New', CRM_Core_PseudoConstant::getName('CRM_Member_BAO_Membership', 'status_id', $membershipStatusId));
2369
2370     $lineItem = $this->callAPISuccessGetSingle('LineItem', ['contribution_id' => $contribution['id']]);
2371     $this->assertEquals('civicrm_membership', $lineItem['entity_table']);
2372     $this->callAPISuccessGetCount('MembershipPayment', ['membership_id' => $membership['id']]);
2373     $this->quickCleanUpFinancialEntities();
2374     $this->contactDelete($originalContribution['values'][1]['contact_id']);
2375   }
2376
2377   /**
2378    * CRM-19945 Tests that Contribute.repeattransaction DOES NOT renew a membership when contribution status=Failed
2379    *
2380    * @dataProvider contributionStatusProvider
2381    */
2382   public function testRepeatTransactionMembershipRenewContributionNotCompleted($contributionStatus) {
2383     // Completed status should renew so we don't test that here
2384     // In Progress status is only for recurring contributions so we don't test that here
2385     if (in_array($contributionStatus['name'], ['Completed', 'In Progress'])) {
2386       return;
2387     }
2388     list($originalContribution, $membership) = $this->setUpAutoRenewMembership();
2389
2390     $this->callAPISuccess('contribution', 'create', [
2391       'contact_id' => $originalContribution['values'][1]['contact_id'],
2392       'financial_type_id' => $originalContribution['values'][1]['financial_type_id'],
2393       'total_amount' => $originalContribution['values'][1]['total_amount'],
2394       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2395       'contribution_status_id' => "Completed",
2396     ]);
2397
2398     $this->callAPISuccess('membership', 'create', [
2399       'id' => $membership['id'],
2400       'end_date' => 'yesterday',
2401       'status_id' => 'Expired',
2402     ]);
2403
2404     $contribution = $this->callAPISuccess('contribution', 'repeattransaction', [
2405       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
2406       'contribution_status_id' => $contributionStatus['name'],
2407       'trxn_id' => 'bobsled',
2408     ]);
2409
2410     $updatedMembership = $this->callAPISuccess('membership', 'getsingle', [
2411       'id' => $membership['id'],
2412     ]);
2413
2414     $dateTime = new DateTime('yesterday');
2415     $this->assertEquals($dateTime->format('Y-m-d'), $updatedMembership['end_date']);
2416     $this->assertEquals(CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Expired'), $updatedMembership['status_id']);
2417
2418     $lineItem = $this->callAPISuccessGetSingle('LineItem', ['contribution_id' => $contribution['id']]);
2419     $this->assertEquals('civicrm_membership', $lineItem['entity_table']);
2420     $this->callAPISuccessGetCount('MembershipPayment', ['membership_id' => $membership['id']]);
2421     $this->quickCleanUpFinancialEntities();
2422     $this->contactDelete($originalContribution['values'][1]['contact_id']);
2423   }
2424
2425   /**
2426    * Dataprovider provides contribution status as [optionvalue=>contribution_status_name]
2427    * FIXME: buildOptions seems to die in CRM_Core_Config::_construct when in test mode.
2428    *
2429    * @return array
2430    * @throws \CiviCRM_API3_Exception
2431    */
2432   public function contributionStatusProvider() {
2433     $contributionStatuses = civicrm_api3('OptionValue', 'get', [
2434       'return' => ["id", "name"],
2435       'option_group_id' => "contribution_status",
2436     ]);
2437     foreach ($contributionStatuses['values'] as $statusName) {
2438       $statuses[] = [$statusName];
2439     }
2440     return $statuses;
2441   }
2442
2443   /**
2444    * CRM-16397 test appropriate action if total amount has changed for single line items.
2445    */
2446   public function testRepeatTransactionAlteredAmount() {
2447     $paymentProcessorID = $this->paymentProcessorCreate();
2448     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2449       'contact_id' => $this->_individualId,
2450       'installments' => '12',
2451       'frequency_interval' => '1',
2452       'amount' => '500',
2453       'contribution_status_id' => 1,
2454       'start_date' => '2012-01-01 00:00:00',
2455       'currency' => 'USD',
2456       'frequency_unit' => 'month',
2457       'payment_processor_id' => $paymentProcessorID,
2458     ]);
2459     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2460         $this->_params,
2461         [
2462           'contribution_recur_id' => $contributionRecur['id'],
2463         ])
2464     );
2465
2466     $this->callAPISuccess('contribution', 'repeattransaction', [
2467       'original_contribution_id' => $originalContribution['id'],
2468       'contribution_status_id' => 'Completed',
2469       'trxn_id' => uniqid(),
2470       'total_amount' => '400',
2471       'fee_amount' => 50,
2472     ]);
2473
2474     $lineItemParams = [
2475       'entity_id' => $originalContribution['id'],
2476       'sequential' => 1,
2477       'return' => [
2478         'entity_table',
2479         'qty',
2480         'unit_price',
2481         'line_total',
2482         'label',
2483         'financial_type_id',
2484         'deductible_amount',
2485         'price_field_value_id',
2486         'price_field_id',
2487       ],
2488     ];
2489     $this->callAPISuccessGetSingle('contribution', [
2490       'total_amount' => 400,
2491       'fee_amount' => 50,
2492       'net_amount' => 350,
2493     ]);
2494     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2495       'entity_id' => $originalContribution['id'],
2496     ]));
2497     $expectedLineItem = array_merge(
2498       $lineItem1['values'][0], [
2499         'line_total' => '400.00',
2500         'unit_price' => '400.00',
2501       ]
2502     );
2503
2504     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2505       'entity_id' => $originalContribution['id'] + 1,
2506     ]));
2507
2508     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
2509     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2510     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2511   }
2512
2513   /**
2514    * CRM-17718 test appropriate action if financial type has changed for single line items.
2515    */
2516   public function testRepeatTransactionPassedInFinancialType() {
2517     $originalContribution = $this->setUpRecurringContribution();
2518
2519     $this->callAPISuccess('contribution', 'repeattransaction', [
2520       'original_contribution_id' => $originalContribution['id'],
2521       'contribution_status_id' => 'Completed',
2522       'trxn_id' => uniqid(),
2523       'financial_type_id' => 2,
2524     ]);
2525     $lineItemParams = [
2526       'entity_id' => $originalContribution['id'],
2527       'sequential' => 1,
2528       'return' => [
2529         'entity_table',
2530         'qty',
2531         'unit_price',
2532         'line_total',
2533         'label',
2534         'financial_type_id',
2535         'deductible_amount',
2536         'price_field_value_id',
2537         'price_field_id',
2538       ],
2539     ];
2540
2541     $this->callAPISuccessGetSingle('contribution', [
2542       'total_amount' => 100,
2543       'financial_type_id' => 2,
2544     ]);
2545     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2546       'entity_id' => $originalContribution['id'],
2547     ]));
2548     $expectedLineItem = array_merge(
2549       $lineItem1['values'][0], [
2550         'line_total' => '100.00',
2551         'unit_price' => '100.00',
2552         'financial_type_id' => 2,
2553         'contribution_type_id' => 2,
2554       ]
2555     );
2556     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2557       'entity_id' => $originalContribution['id'] + 1,
2558     ]));
2559     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
2560     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2561     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2562   }
2563
2564   /**
2565    * CRM-17718 test appropriate action if financial type has changed for single line items.
2566    */
2567   public function testRepeatTransactionUpdatedFinancialType() {
2568     $originalContribution = $this->setUpRecurringContribution([], ['financial_type_id' => 2]);
2569
2570     $this->callAPISuccess('contribution', 'repeattransaction', [
2571       'contribution_recur_id' => $originalContribution['id'],
2572       'contribution_status_id' => 'Completed',
2573       'trxn_id' => uniqid(),
2574     ]);
2575     $lineItemParams = [
2576       'entity_id' => $originalContribution['id'],
2577       'sequential' => 1,
2578       'return' => [
2579         'entity_table',
2580         'qty',
2581         'unit_price',
2582         'line_total',
2583         'label',
2584         'financial_type_id',
2585         'deductible_amount',
2586         'price_field_value_id',
2587         'price_field_id',
2588       ],
2589     ];
2590
2591     $this->callAPISuccessGetSingle('contribution', [
2592       'total_amount' => 100,
2593       'financial_type_id' => 2,
2594     ]);
2595     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2596       'entity_id' => $originalContribution['id'],
2597     ]));
2598     $expectedLineItem = array_merge(
2599       $lineItem1['values'][0], [
2600         'line_total' => '100.00',
2601         'unit_price' => '100.00',
2602         'financial_type_id' => 2,
2603         'contribution_type_id' => 2,
2604       ]
2605     );
2606
2607     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2608       'entity_id' => $originalContribution['id'] + 1,
2609     ]));
2610     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
2611     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2612     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2613   }
2614
2615   /**
2616    * CRM-16397 test appropriate action if campaign has been passed in.
2617    */
2618   public function testRepeatTransactionPassedInCampaign() {
2619     $paymentProcessorID = $this->paymentProcessorCreate();
2620     $campaignID = $this->campaignCreate();
2621     $campaignID2 = $this->campaignCreate();
2622     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2623       'contact_id' => $this->_individualId,
2624       'installments' => '12',
2625       'frequency_interval' => '1',
2626       'amount' => '100',
2627       'contribution_status_id' => 1,
2628       'start_date' => '2012-01-01 00:00:00',
2629       'currency' => 'USD',
2630       'frequency_unit' => 'month',
2631       'payment_processor_id' => $paymentProcessorID,
2632     ]);
2633     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2634       $this->_params,
2635       [
2636         'contribution_recur_id' => $contributionRecur['id'],
2637         'campaign_id' => $campaignID,
2638       ])
2639     );
2640
2641     $this->callAPISuccess('contribution', 'repeattransaction', [
2642       'original_contribution_id' => $originalContribution['id'],
2643       'contribution_status_id' => 'Completed',
2644       'trxn_id' => uniqid(),
2645       'campaign_id' => $campaignID2,
2646     ]);
2647
2648     $this->callAPISuccessGetSingle('contribution', [
2649       'total_amount' => 100,
2650       'campaign_id' => $campaignID2,
2651     ]);
2652   }
2653
2654   /**
2655    * CRM-17718 campaign stored on contribution recur gets priority.
2656    *
2657    * This reflects the fact we permit people to update them.
2658    */
2659   public function testRepeatTransactionUpdatedCampaign() {
2660     $paymentProcessorID = $this->paymentProcessorCreate();
2661     $campaignID = $this->campaignCreate();
2662     $campaignID2 = $this->campaignCreate();
2663     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
2664       'contact_id' => $this->_individualId,
2665       'installments' => '12',
2666       'frequency_interval' => '1',
2667       'amount' => '100',
2668       'contribution_status_id' => 1,
2669       'start_date' => '2012-01-01 00:00:00',
2670       'currency' => 'USD',
2671       'frequency_unit' => 'month',
2672       'payment_processor_id' => $paymentProcessorID,
2673       'campaign_id' => $campaignID,
2674     ]);
2675     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2676       $this->_params,
2677       [
2678         'contribution_recur_id' => $contributionRecur['id'],
2679         'campaign_id' => $campaignID2,
2680       ])
2681     );
2682
2683     $this->callAPISuccess('contribution', 'repeattransaction', [
2684       'original_contribution_id' => $originalContribution['id'],
2685       'contribution_status_id' => 'Completed',
2686       'trxn_id' => uniqid(),
2687     ]);
2688
2689     $this->callAPISuccessGetSingle('contribution', [
2690       'total_amount' => 100,
2691       'campaign_id' => $campaignID,
2692     ]);
2693   }
2694
2695   /**
2696    * CRM-20685 Repeattransaction produces incorrect Financial Type ID (in specific circumstance) - if number of lineItems = 1.
2697    *
2698    * This case happens when the line item & contribution do not have the same type in his initiating transaction.
2699    */
2700   public function testRepeatTransactionUpdatedFinancialTypeAndNotEquals() {
2701     $originalContribution = $this->setUpRecurringContribution([], ['financial_type_id' => 2]);
2702     // This will made the trick to get the not equals behaviour.
2703     $this->callAPISuccess('line_item', 'create', ['id' => 1, 'financial_type_id' => 4]);
2704     $this->callAPISuccess('contribution', 'repeattransaction', [
2705       'contribution_recur_id' => $originalContribution['id'],
2706       'contribution_status_id' => 'Completed',
2707       'trxn_id' => uniqid(),
2708     ]);
2709     $lineItemParams = [
2710       'entity_id' => $originalContribution['id'],
2711       'sequential' => 1,
2712       'return' => [
2713         'entity_table',
2714         'qty',
2715         'unit_price',
2716         'line_total',
2717         'label',
2718         'financial_type_id',
2719         'deductible_amount',
2720         'price_field_value_id',
2721         'price_field_id',
2722       ],
2723     ];
2724     $this->callAPISuccessGetSingle('contribution', [
2725       'total_amount' => 100,
2726       'financial_type_id' => 2,
2727     ]);
2728     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2729       'entity_id' => $originalContribution['id'],
2730     ]));
2731     $expectedLineItem = array_merge(
2732       $lineItem1['values'][0], [
2733         'line_total' => '100.00',
2734         'unit_price' => '100.00',
2735         'financial_type_id' => 4,
2736         'contribution_type_id' => 4,
2737       ]
2738     );
2739
2740     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, [
2741       'entity_id' => $originalContribution['id'] + 1,
2742     ]));
2743     $this->callAPISuccess('line_item', 'create', ['id' => 1, 'financial_type_id' => 1]);
2744     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
2745     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
2746     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
2747   }
2748
2749   /**
2750    * Test completing a transaction does not 'mess' with net amount (CRM-15960).
2751    */
2752   public function testCompleteTransactionNetAmountOK() {
2753     $this->createLoggedInUser();
2754     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2755     unset($params['net_amount']);
2756     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2757     $this->callAPISuccess('contribution', 'completetransaction', [
2758       'id' => $contribution['id'],
2759     ]);
2760     $contribution = $this->callAPISuccess('contribution', 'getsingle', ['id' => $contribution['id']]);
2761     $this->assertEquals('Completed', $contribution['contribution_status']);
2762     $this->assertTrue(($contribution['total_amount'] - $contribution['net_amount']) == $contribution['fee_amount']);
2763   }
2764
2765   /**
2766    * CRM-14151 - Test completing a transaction via the API.
2767    */
2768   public function testCompleteTransactionWithReceiptDateSet() {
2769     $this->swapMessageTemplateForTestTemplate();
2770     $mut = new CiviMailUtils($this, TRUE);
2771     $this->createLoggedInUser();
2772     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'receipt_date' => 'now']);
2773     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2774     $this->callAPISuccess('contribution', 'completetransaction', ['id' => $contribution['id'], 'trxn_date' => date('Y-m-d')]);
2775     $contribution = $this->callAPISuccess('contribution', 'get', ['id' => $contribution['id'], 'sequential' => 1]);
2776     $this->assertEquals('Completed', $contribution['values'][0]['contribution_status']);
2777     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['values'][0]['receive_date'])));
2778     $mut->checkMailLog([
2779       'Receipt - Contribution',
2780       'receipt_date:::' . date('Ymd'),
2781     ]);
2782     $mut->stop();
2783     $this->revertTemplateToReservedTemplate();
2784   }
2785
2786   /**
2787    * CRM-1960 - Test to ensure that completetransaction respects the is_email_receipt setting
2788    */
2789   public function testCompleteTransactionWithEmailReceiptInput() {
2790     $contributionPage = $this->createReceiptableContributionPage();
2791
2792     $this->_params['contribution_page_id'] = $contributionPage['id'];
2793     $params = array_merge($this->_params, ['contribution_status_id' => 2]);
2794     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2795     // Complete the transaction overriding is_email_receipt to = FALSE
2796     $this->callAPISuccess('contribution', 'completetransaction', [
2797       'id' => $contribution['id'],
2798       'trxn_date' => date('2011-04-09'),
2799       'trxn_id' => 'kazam',
2800       'is_email_receipt' => 0,
2801     ]);
2802     // Check if a receipt was issued
2803     $receipt_date = $this->callAPISuccess('Contribution', 'getvalue', ['id' => $contribution['id'], 'return' => 'receipt_date']);
2804     $this->assertEquals('', $receipt_date);
2805   }
2806
2807   /**
2808    * Test that $is_recur is assigned to the receipt.
2809    */
2810   public function testCompleteTransactionForRecurring() {
2811
2812     $this->swapMessageTemplateForTestTemplate();
2813     $recurring = $this->setUpRecurringContribution();
2814     $contributionPage = $this->createReceiptableContributionPage(['is_recur' => TRUE, 'recur_frequency_unit' => 'month', 'recur_interval' => 1]);
2815
2816     $this->_params['contribution_page_id'] = $contributionPage['id'];
2817     $this->_params['contribution_recur_id'] = $recurring['id'];
2818
2819     $contribution = $this->setUpForCompleteTransaction();
2820
2821     $this->callAPISuccess('contribution', 'completetransaction', [
2822       'id' => $contribution['id'],
2823       'trxn_date' => date('2011-04-09'),
2824       'trxn_id' => 'kazam',
2825       'is_email_receipt' => 1,
2826     ]);
2827
2828     $this->mut->checkMailLog([
2829       'is_recur:::1',
2830       'cancelSubscriptionUrl:::' . CIVICRM_UF_BASEURL,
2831     ]);
2832     $this->mut->stop();
2833     $this->revertTemplateToReservedTemplate();
2834   }
2835
2836   /**
2837    * CRM-19710 - Test to ensure that completetransaction respects the input for is_email_receipt setting.
2838    *
2839    * If passed in it will override the default from contribution page.
2840    */
2841   public function testCompleteTransactionWithEmailReceiptInputTrue() {
2842     $mut = new CiviMailUtils($this, TRUE);
2843     $this->createLoggedInUser();
2844     // Create a Contribution Page with is_email_receipt = FALSE
2845     $contributionPage = $this->callAPISuccess('ContributionPage', 'create', [
2846       'receipt_from_name' => 'Mickey Mouse',
2847       'receipt_from_email' => 'mickey@mouse.com',
2848       'title' => "Test Contribution Page",
2849       'financial_type_id' => 1,
2850       'currency' => 'CAD',
2851       'is_monetary' => TRUE,
2852       'is_email_receipt' => 0,
2853     ]);
2854     $this->_params['contribution_page_id'] = $contributionPage['id'];
2855     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'receipt_date' => 'now']);
2856     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2857     // Complete the transaction overriding is_email_receipt to = TRUE
2858     $this->callAPISuccess('contribution', 'completetransaction', [
2859       'id' => $contribution['id'],
2860       'is_email_receipt' => 1,
2861     ]);
2862     $mut->checkMailLog([
2863       'Contribution Information',
2864     ]);
2865     $mut->stop();
2866   }
2867
2868   /**
2869    * Complete the transaction using the template with all the possible.
2870    */
2871   public function testCompleteTransactionWithTestTemplate() {
2872     $this->swapMessageTemplateForTestTemplate();
2873     $contribution = $this->setUpForCompleteTransaction();
2874     $this->callAPISuccess('contribution', 'completetransaction', [
2875       'id' => $contribution['id'],
2876       'trxn_date' => date('2011-04-09'),
2877       'trxn_id' => 'kazam',
2878     ]);
2879     $receive_date = $this->callAPISuccess('Contribution', 'getvalue', ['id' => $contribution['id'], 'return' => 'receive_date']);
2880     $this->mut->checkMailLog([
2881       'email:::anthony_anderson@civicrm.org',
2882       'is_monetary:::1',
2883       'amount:::100.00',
2884       'currency:::USD',
2885       'receive_date:::' . date('Ymd', strtotime($receive_date)),
2886       'receipt_date:::' . date('Ymd'),
2887       'contributeMode:::notify',
2888       'title:::Contribution',
2889       'displayName:::Mr. Anthony Anderson II',
2890       'trxn_id:::kazam',
2891       'contactID:::' . $this->_params['contact_id'],
2892       'contributionID:::' . $contribution['id'],
2893       'financialTypeId:::1',
2894       'financialTypeName:::Donation',
2895     ]);
2896     $this->mut->stop();
2897     $this->revertTemplateToReservedTemplate();
2898   }
2899
2900   /**
2901    * Complete the transaction using the template with all the possible.
2902    */
2903   public function testCompleteTransactionContributionPageFromAddress() {
2904     $contributionPage = $this->callAPISuccess('ContributionPage', 'create', [
2905       'receipt_from_name' => 'Mickey Mouse',
2906       'receipt_from_email' => 'mickey@mouse.com',
2907       'title' => "Test Contribution Page",
2908       'financial_type_id' => 1,
2909       'currency' => 'NZD',
2910       'goal_amount' => 50,
2911       'is_pay_later' => 1,
2912       'is_monetary' => TRUE,
2913       'is_email_receipt' => TRUE,
2914     ]);
2915     $this->_params['contribution_page_id'] = $contributionPage['id'];
2916     $contribution = $this->setUpForCompleteTransaction();
2917     $this->callAPISuccess('contribution', 'completetransaction', ['id' => $contribution['id']]);
2918     $this->mut->checkMailLog([
2919       'mickey@mouse.com',
2920       'Mickey Mouse <',
2921     ]);
2922     $this->mut->stop();
2923   }
2924
2925   /**
2926    * Test completing first transaction in a recurring series.
2927    *
2928    * The status should be set to 'in progress' and the next scheduled payment date calculated.
2929    *
2930    * @dataProvider getScheduledDateData
2931    *
2932    * @param array $dataSet
2933    *
2934    * @throws \Exception
2935    */
2936   public function testCompleteTransactionSetStatusToInProgress($dataSet) {
2937     $paymentProcessorID = $this->paymentProcessorCreate();
2938     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
2939       'contact_id' => $this->_individualId,
2940       'installments' => '2',
2941       'frequency_interval' => '1',
2942       'amount' => '500',
2943       'contribution_status_id' => 'Pending',
2944       'start_date' => '2012-01-01 00:00:00',
2945       'currency' => 'USD',
2946       'frequency_unit' => 'month',
2947       'payment_processor_id' => $paymentProcessorID,
2948     ], $dataSet['data']));
2949     $contribution = $this->callAPISuccess('contribution', 'create', array_merge(
2950       $this->_params,
2951       [
2952         'contribution_recur_id' => $contributionRecur['id'],
2953         'contribution_status_id' => 'Pending',
2954         'receive_date' => $dataSet['receive_date'],
2955       ])
2956     );
2957     $this->callAPISuccess('Contribution', 'completetransaction', [
2958       'id' => $contribution,
2959       'receive_date' => $dataSet['receive_date'],
2960     ]);
2961     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
2962       'id' => $contributionRecur['id'],
2963       'return' => ['next_sched_contribution_date', 'contribution_status_id'],
2964     ]);
2965     $this->assertEquals(5, $contributionRecur['contribution_status_id']);
2966     $this->assertEquals($dataSet['expected'], $contributionRecur['next_sched_contribution_date']);
2967     $this->callAPISuccess('Contribution', 'create', array_merge(
2968       $this->_params,
2969       [
2970         'contribution_recur_id' => $contributionRecur['id'],
2971         'contribution_status_id' => 'Completed',
2972       ]
2973     ));
2974     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', [
2975       'id' => $contributionRecur['id'],
2976       'return' => ['contribution_status_id'],
2977     ]);
2978     $this->assertEquals(1, $contributionRecur['contribution_status_id']);
2979   }
2980
2981   /**
2982    * Get dates for testing.
2983    *
2984    * @return array
2985    */
2986   public function getScheduledDateData() {
2987     $result = [];
2988     $result[]['2016-08-31-1-month'] = [
2989       'data' => [
2990         'start_date' => '2016-08-31',
2991         'frequency_interval' => 1,
2992         'frequency_unit' => 'month',
2993       ],
2994       'receive_date' => '2016-08-31',
2995       'expected' => '2016-10-01 00:00:00',
2996     ];
2997     $result[]['2012-01-01-1-month'] = [
2998       'data' => [
2999         'start_date' => '2012-01-01',
3000         'frequency_interval' => 1,
3001         'frequency_unit' => 'month',
3002       ],
3003       'receive_date' => '2012-01-01',
3004       'expected' => '2012-02-01 00:00:00',
3005     ];
3006     $result[]['2012-01-01-1-month'] = [
3007       'data' => [
3008         'start_date' => '2012-01-01',
3009         'frequency_interval' => 1,
3010         'frequency_unit' => 'month',
3011       ],
3012       'receive_date' => '2012-02-29',
3013       'expected' => '2012-03-29 00:00:00',
3014     ];
3015     $result['receive_date_includes_time']['2012-01-01-1-month'] = [
3016       'data' => [
3017         'start_date' => '2012-01-01',
3018         'frequency_interval' => 1,
3019         'frequency_unit' => 'month',
3020         'next_sched_contribution_date' => '2012-02-29',
3021       ],
3022       'receive_date' => '2012-02-29 16:00:00',
3023       'expected' => '2012-03-29 00:00:00',
3024     ];
3025     return $result;
3026   }
3027
3028   /**
3029    * Test completing a pledge with the completeTransaction api..
3030    *
3031    * Note that we are creating a logged in user because email goes out from
3032    * that person.
3033    */
3034   public function testCompleteTransactionUpdatePledgePayment() {
3035     $this->swapMessageTemplateForTestTemplate();
3036     $mut = new CiviMailUtils($this, TRUE);
3037     $mut->clearMessages();
3038     $this->createLoggedInUser();
3039     $contributionID = $this->createPendingPledgeContribution();
3040     $this->callAPISuccess('contribution', 'completetransaction', [
3041       'id' => $contributionID,
3042       'trxn_date' => '1 Feb 2013',
3043     ]);
3044     $pledge = $this->callAPISuccessGetSingle('Pledge', [
3045       'id' => $this->_ids['pledge'],
3046     ]);
3047     $this->assertEquals('Completed', $pledge['pledge_status']);
3048
3049     $status = $this->callAPISuccessGetValue('PledgePayment', [
3050       'pledge_id' => $this->_ids['pledge'],
3051       'return' => 'status_id',
3052     ]);
3053     $this->assertEquals(1, $status);
3054     $mut->checkMailLog([
3055       'amount:::500.00',
3056       'receive_date:::20130201000000',
3057       "receipt_date:::\n",
3058     ]);
3059     $mut->stop();
3060     $this->revertTemplateToReservedTemplate();
3061   }
3062
3063   /**
3064    * Test completing a transaction with an event via the API.
3065    *
3066    * Note that we are creating a logged in user because email goes out from
3067    * that person
3068    *
3069    * @throws \CRM_Core_Exception
3070    */
3071   public function testCompleteTransactionWithParticipantRecord() {
3072     $mut = new CiviMailUtils($this, TRUE);
3073     $mut->clearMessages();
3074     $this->_individualId = $this->createLoggedInUser();
3075     $contributionID = $this->createPendingParticipantContribution();
3076     $this->createJoinedProfile(['entity_id' => $this->_ids['event']['test'], 'entity_table' => 'civicrm_event']);
3077     $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']);
3078     $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']);
3079     $this->eliminateUFGroupOne();
3080
3081     $this->callAPISuccess('contribution', 'completetransaction', [
3082       'id' => $contributionID,
3083     ]
3084     );
3085     $participantStatus = $this->callAPISuccessGetValue('participant', [
3086       'id' => $this->_ids['participant'],
3087       'return' => 'participant_status_id',
3088     ]);
3089     $this->assertEquals(1, $participantStatus);
3090
3091     //Assert only three activities are created.
3092     $activities = $this->callAPISuccess('Activity', 'get', [
3093       'contact_id' => $this->_individualId,
3094     ])['values'];
3095
3096     $this->assertCount(3, $activities);
3097     $activityNames = array_count_values(CRM_Utils_Array::collect('activity_name', $activities));
3098     // record two activities before and after completing payment for Event registration
3099     $this->assertEquals(2, $activityNames['Event Registration']);
3100     // update the original 'Contribution' activity created after completing payment
3101     $this->assertEquals(1, $activityNames['Contribution']);
3102
3103     $mut->checkMailLog([
3104       'Annual CiviCRM meet',
3105       'Event',
3106       'This is a confirmation that your registration has been received and your status has been updated to Registered.',
3107       'First Name: Logged In',
3108       'Public title',
3109       'public 2',
3110       'public 3',
3111     ], ['Back end title', 'title_post_2', 'title_post_3']);
3112     $mut->stop();
3113   }
3114
3115   /**
3116    * Test membership is renewed when transaction completed.
3117    */
3118   public function testCompleteTransactionMembershipPriceSet() {
3119     $this->createPriceSetWithPage('membership');
3120     $stateOfGrace = $this->callAPISuccess('MembershipStatus', 'getvalue', [
3121       'name' => 'Grace',
3122       'return' => 'id',
3123     ]);
3124     $this->setUpPendingContribution($this->_ids['price_field_value'][0]);
3125     $membership = $this->callAPISuccess('membership', 'getsingle', ['id' => $this->_ids['membership']]);
3126     $logs = $this->callAPISuccess('MembershipLog', 'get', [
3127       'membership_id' => $this->_ids['membership'],
3128     ]);
3129     $this->assertEquals(1, $logs['count']);
3130     $this->assertEquals($stateOfGrace, $membership['status_id']);
3131     $this->callAPISuccess('contribution', 'completetransaction', ['id' => $this->_ids['contribution']]);
3132     $membership = $this->callAPISuccess('membership', 'getsingle', ['id' => $this->_ids['membership']]);
3133     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 1 year')), $membership['end_date']);
3134     $this->callAPISuccessGetSingle('LineItem', [
3135       'entity_id' => $this->_ids['membership'],
3136       'entity_table' => 'civicrm_membership',
3137     ]);
3138     $logs = $this->callAPISuccess('MembershipLog', 'get', [
3139       'membership_id' => $this->_ids['membership'],
3140     ]);
3141     $this->assertEquals(2, $logs['count']);
3142     $this->assertNotEquals($stateOfGrace, $logs['values'][2]['status_id']);
3143     //Assert only three activities are created.
3144     $activities = CRM_Activity_BAO_Activity::getContactActivity($this->_ids['contact']);
3145     $this->assertEquals(3, count($activities));
3146     $activityNames = array_flip(CRM_Utils_Array::collect('activity_name', $activities));
3147     $this->assertArrayHasKey('Contribution', $activityNames);
3148     $this->assertArrayHasKey('Membership Signup', $activityNames);
3149     $this->assertArrayHasKey('Change Membership Status', $activityNames);
3150     $this->cleanUpAfterPriceSets();
3151   }
3152
3153   /**
3154    * Test if renewal activity is create after changing Pending contribution to Completed via offline
3155    */
3156   public function testPendingToCompleteContribution() {
3157     $this->createPriceSetWithPage('membership');
3158     $this->setUpPendingContribution($this->_ids['price_field_value'][0]);
3159     $this->callAPISuccess('membership', 'getsingle', ['id' => $this->_ids['membership']]);
3160     // Case 1: Assert that Membership Signup Activity is created on Pending to Completed Contribution via backoffice
3161     $activity = $this->callAPISuccess('Activity', 'get', [
3162       'activity_type_id' => 'Membership Signup',
3163       'source_record_id' => $this->_ids['membership'],
3164       'status_id' => 'Scheduled',
3165     ]);
3166     $this->assertEquals(1, $activity['count']);
3167
3168     // change pending contribution to completed
3169     $form = new CRM_Contribute_Form_Contribution();
3170
3171     $form->_params = [
3172       'id' => $this->_ids['contribution'],
3173       'total_amount' => 20,
3174       'net_amount' => 20,
3175       'fee_amount' => 0,
3176       'financial_type_id' => 1,
3177       'contact_id' => $this->_individualId,
3178       'contribution_status_id' => 1,
3179       'billing_middle_name' => '',
3180       'billing_last_name' => 'Adams',
3181       'billing_street_address-5' => '790L Lincoln St S',
3182       'billing_city-5' => 'Maryknoll',
3183       'billing_state_province_id-5' => 1031,
3184       'billing_postal_code-5' => 10545,
3185       'billing_country_id-5' => 1228,
3186       'frequency_interval' => 1,
3187       'frequency_unit' => 'month',
3188       'installments' => '',
3189       'hidden_AdditionalDetail' => 1,
3190       'hidden_Premium' => 1,
3191       'from_email_address' => '"civi45" <civi45@civicrm.com>',
3192       'receipt_date' => '',
3193       'receipt_date_time' => '',
3194       'payment_processor_id' => $this->paymentProcessorID,
3195       'currency' => 'USD',
3196       'contribution_page_id' => $this->_ids['contribution_page'],
3197       'contribution_mode' => 'membership',
3198       'source' => 'Membership Signup and Renewal',
3199     ];
3200
3201     $form->testSubmit($form->_params, CRM_Core_Action::UPDATE);
3202
3203     // Case 2: After successful payment for Pending backoffice there are three activities created
3204     //  2.a Update status of existing Scheduled Membership Signup (created in step 1) to Completed
3205     $activity = $this->callAPISuccess('Activity', 'get', [
3206       'activity_type_id' => 'Membership Signup',
3207       'source_record_id' => $this->_ids['membership'],
3208       'status_id' => 'Completed',
3209     ]);
3210     $this->assertEquals(1, $activity['count']);
3211     // 2.b Contribution activity created to record successful payment
3212     $activity = $this->callAPISuccess('Activity', 'get', [
3213       'activity_type_id' => 'Contribution',
3214       'source_record_id' => $this->_ids['contribution'],
3215       'status_id' => 'Completed',
3216     ]);
3217     $this->assertEquals(1, $activity['count']);
3218
3219     // 2.c 'Change membership type' activity created to record Membership status change from Grace to Current
3220     $activity = $this->callAPISuccess('Activity', 'get', [
3221       'activity_type_id' => 'Change Membership Status',
3222       'source_record_id' => $this->_ids['membership'],
3223       'status_id' => 'Completed',
3224     ]);
3225     $this->assertEquals(1, $activity['count']);
3226     $this->assertEquals('Status changed from Grace to Current', $activity['values'][$activity['id']]['subject']);
3227
3228     //Create another pending contribution for renewal
3229     $contribution = $this->callAPISuccess('contribution', 'create', [
3230       'domain_id' => 1,
3231       'contact_id' => $this->_ids['contact'],
3232       'receive_date' => date('Ymd'),
3233       'total_amount' => 20.00,
3234       'financial_type_id' => 1,
3235       'payment_instrument_id' => 'Credit Card',
3236       'non_deductible_amount' => 10.00,
3237       'trxn_id' => 'rdhfi88',
3238       'invoice_id' => 'dofhiewuyr',
3239       'source' => 'SSF',
3240       'contribution_status_id' => 2,
3241       'contribution_page_id' => $this->_ids['contribution_page'],
3242       // We can't rely on contribution api to link line items correctly to membership
3243       'skipLineItem' => TRUE,
3244       'api.membership_payment.create' => ['membership_id' => $this->_ids['membership']],
3245     ]);
3246
3247     $this->callAPISuccess('line_item', 'create', [
3248       'entity_id' => $contribution['id'],
3249       'entity_table' => 'civicrm_contribution',
3250       'contribution_id' => $contribution['id'],
3251       'price_field_id' => $this->_ids['price_field'][0],
3252       'qty' => 1,
3253       'unit_price' => 20,
3254       'line_total' => 20,
3255       'financial_type_id' => 1,
3256       'price_field_value_id' => $this->_ids['price_field_value']['cont'],
3257     ]);
3258     $this->callAPISuccess('line_item', 'create', [
3259       'entity_id' => $this->_ids['membership'],
3260       'entity_table' => 'civicrm_membership',
3261       'contribution_id' => $contribution['id'],
3262       'price_field_id' => $this->_ids['price_field'][0],
3263       'qty' => 1,
3264       'unit_price' => 20,
3265       'line_total' => 20,
3266       'financial_type_id' => 1,
3267       'price_field_value_id' => $this->_ids['price_field_value'][0],
3268       'membership_type_id' => $this->_ids['membership_type'],
3269     ]);
3270
3271     //Update it to Failed.
3272     $form->_params['id'] = $contribution['id'];
3273     $form->_params['contribution_status_id'] = 4;
3274
3275     $form->testSubmit($form->_params, CRM_Core_Action::UPDATE);
3276     //Existing membership should not get updated to expired.
3277     $membership = $this->callAPISuccess('membership', 'getsingle', ['id' => $this->_ids['membership']]);
3278     $this->assertNotEquals($membership['status_id'], 4);
3279   }
3280
3281   /**
3282    * Test membership is renewed when transaction completed.
3283    */
3284   public function testCompleteTransactionMembershipPriceSetTwoTerms() {
3285     $this->createPriceSetWithPage('membership');
3286     $this->setUpPendingContribution($this->_ids['price_field_value'][1]);
3287     $this->callAPISuccess('contribution', 'completetransaction', ['id' => $this->_ids['contribution']]);
3288     $membership = $this->callAPISuccess('membership', 'getsingle', ['id' => $this->_ids['membership']]);
3289     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 2 years')), $membership['end_date']);
3290     $this->cleanUpAfterPriceSets();
3291   }
3292
3293   public function cleanUpAfterPriceSets() {
3294     $this->quickCleanUpFinancialEntities();
3295     $this->contactDelete($this->_ids['contact']);
3296   }
3297
3298   /**
3299    * Set up a pending transaction with a specific price field id.
3300    *
3301    * @param int $priceFieldValueID
3302    * @param array $contriParams
3303    */
3304   public function setUpPendingContribution($priceFieldValueID, $contriParams = []) {
3305     $contactID = $this->individualCreate();
3306     $membership = $this->callAPISuccess('membership', 'create', [
3307       'contact_id' => $contactID,
3308       'membership_type_id' => $this->_ids['membership_type'],
3309       'start_date' => 'yesterday - 1 year',
3310       'end_date' => 'yesterday',
3311       'join_date' => 'yesterday - 1 year',
3312     ]);
3313     $contribution = $this->callAPISuccess('contribution', 'create', array_merge([
3314       'domain_id' => 1,
3315       'contact_id' => $contactID,
3316       'receive_date' => date('Ymd'),
3317       'total_amount' => 20.00,
3318       'financial_type_id' => 1,
3319       'payment_instrument_id' => 'Credit Card',
3320       'non_deductible_amount' => 10.00,
3321       'trxn_id' => 'jdhfi' . rand(1, 100),
3322       'invoice_id' => 'djfhiew' . rand(5, 100),
3323       'source' => 'SSF',
3324       'contribution_status_id' => 2,
3325       'contribution_page_id' => $this->_ids['contribution_page'],
3326       'api.membership_payment.create' => ['membership_id' => $membership['id']],
3327     ], $contriParams));
3328
3329     $this->callAPISuccess('line_item', 'create', [
3330       'entity_id' => $contribution['id'],
3331       'entity_table' => 'civicrm_contribution',
3332       'contribution_id' => $contribution['id'],
3333       'price_field_id' => $this->_ids['price_field'][0],
3334       'qty' => 1,
3335       'unit_price' => 20,
3336       'line_total' => 20,
3337       'financial_type_id' => 1,
3338       'price_field_value_id' => $priceFieldValueID,
3339     ]);
3340     $this->_ids['contact'] = $contactID;
3341     $this->_ids['contribution'] = $contribution['id'];
3342     $this->_ids['membership'] = $membership['id'];
3343   }
3344
3345   /**
3346    * Test sending a mail via the API.
3347    */
3348   public function testSendMail() {
3349     $mut = new CiviMailUtils($this, TRUE);
3350     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
3351     $this->callAPISuccess('contribution', 'sendconfirmation', [
3352       'id' => $contribution['id'],
3353       'receipt_from_email' => 'api@civicrm.org',
3354     ]);
3355     $mut->checkMailLog([
3356       '$ 100.00',
3357       'Contribution Information',
3358     ], [
3359       'Event',
3360     ]);
3361
3362     $this->checkCreditCardDetails($mut, $contribution['id']);
3363     $mut->stop();
3364   }
3365
3366   /**
3367    * Test sending a mail via the API.
3368    * This simulates webform_civicrm using pay later contribution page
3369    */
3370   public function testSendconfirmationPayLater() {
3371     $mut = new CiviMailUtils($this, TRUE);
3372
3373     // Create contribution page
3374     $pageParams = [
3375       'title' => 'Webform Contributions',
3376       'financial_type_id' => 1,
3377       'contribution_type_id' => 1,
3378       'is_confirm_enabled' => 1,
3379       'is_pay_later' => 1,
3380       'pay_later_text' => 'I will send payment by cheque',
3381       'pay_later_receipt' => 'Send your cheque payable to "CiviCRM LLC" to the office',
3382     ];
3383     $contributionPage = $this->callAPISuccess('contribution_page', 'create', $pageParams);
3384
3385     // Create pay later contribution
3386     $contribParams = [
3387       'contact_id' => $this->_individualId,
3388       'financial_type_id' => 1,
3389       'is_pay_later' => 1,
3390       'contribution_status_id' => 2,
3391       'contribution_page_id' => $contributionPage['id'],
3392       'total_amount' => '10.00',
3393     ];
3394     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
3395
3396     // Create line item
3397     $lineItemParams = [
3398       'contribution_id' => $contribution['id'],
3399       'entity_id' => $contribution['id'],
3400       'entity_table' => 'civicrm_contribution',
3401       'label' => 'My lineitem label',
3402       'qty' => 1,
3403       'unit_price' => "10.00",
3404       'line_total' => "10.00",
3405     ];
3406     $lineItem = $this->callAPISuccess('lineItem', 'create', $lineItemParams);
3407
3408     // Create email
3409     try {
3410       civicrm_api3('contribution', 'sendconfirmation', [
3411         'id' => $contribution['id'],
3412         'receipt_from_email' => 'api@civicrm.org',
3413       ]);
3414     }
3415     catch (Exception $e) {
3416       // Need to figure out how to stop this some other day
3417       // We don't care about the Payment Processor because this is Pay Later
3418       // The point of this test is to check we get the pay_later version of the mail
3419       if ($e->getMessage() != "Undefined variable: CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage") {
3420         throw $e;
3421       }
3422     }
3423
3424     // Retrieve mail & check it has the pay_later_receipt info
3425     $mut->getMostRecentEmail('raw');
3426     $mut->checkMailLog([
3427       (string) $contribParams['total_amount'],
3428       $pageParams['pay_later_receipt'],
3429     ], [
3430       'Event',
3431     ]);
3432     $mut->stop();
3433   }
3434
3435   /**
3436    * Check credit card details in sent mail via API
3437    *
3438    * @param $mut obj CiviMailUtils instance
3439    * @param int $contributionID Contribution ID
3440    *
3441    */
3442   public function checkCreditCardDetails($mut, $contributionID) {
3443     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
3444     $this->callAPISuccess('contribution', 'sendconfirmation', [
3445       'id' => $contributionID,
3446       'receipt_from_email' => 'api@civicrm.org',
3447       'payment_processor_id' => $this->paymentProcessorID,
3448     ]);
3449     $mut->checkMailLog([
3450       // credit card header
3451       'Credit Card Information',
3452       // billing header
3453       'Billing Name and Address',
3454       // billing name
3455       'anthony_anderson@civicrm.org',
3456     ], [
3457       'Event',
3458     ]);
3459   }
3460
3461   /**
3462    * Test sending a mail via the API.
3463    */
3464   public function testSendMailEvent() {
3465     $mut = new CiviMailUtils($this, TRUE);
3466     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
3467     $event = $this->eventCreate([
3468       'is_email_confirm' => 1,
3469       'confirm_from_email' => 'test@civicrm.org',
3470     ]);
3471     $this->_eventID = $event['id'];
3472     $participantParams = [
3473       'contact_id' => $this->_individualId,
3474       'event_id' => $this->_eventID,
3475       'status_id' => 1,
3476       'role_id' => 1,
3477       // to ensure it matches later on
3478       'register_date' => '2007-07-21 00:00:00',
3479       'source' => 'Online Event Registration: API Testing',
3480
3481     ];
3482     $participant = $this->callAPISuccess('participant', 'create', $participantParams);
3483     $this->callAPISuccess('participant_payment', 'create', [
3484       'participant_id' => $participant['id'],
3485       'contribution_id' => $contribution['id'],
3486     ]);
3487     $this->callAPISuccess('contribution', 'sendconfirmation', [
3488       'id' => $contribution['id'],
3489       'receipt_from_email' => 'api@civicrm.org',
3490     ]);
3491
3492     $mut->checkMailLog([
3493       'Annual CiviCRM meet',
3494       'Event',
3495       'To: "Mr. Anthony Anderson II" <anthony_anderson@civicrm.org>',
3496     ], []);
3497     $mut->stop();
3498   }
3499
3500   /**
3501    * This function does a GET & compares the result against the $params.
3502    *
3503    * Use as a double check on Creates.
3504    *
3505    * @param array $params
3506    * @param int $id
3507    * @param bool $delete
3508    */
3509   public function contributionGetnCheck($params, $id, $delete = TRUE) {
3510
3511     $contribution = $this->callAPISuccess('Contribution', 'Get', [
3512       'id' => $id,
3513     ]);
3514
3515     if ($delete) {
3516       $this->callAPISuccess('contribution', 'delete', ['id' => $id]);
3517     }
3518     $this->assertAPISuccess($contribution, 0);
3519     $values = $contribution['values'][$contribution['id']];
3520     $params['receive_date'] = date('Y-m-d H:i:s', strtotime($params['receive_date']));
3521     // this is not returned in id format
3522     unset($params['payment_instrument_id']);
3523     $params['contribution_source'] = $params['source'];
3524     unset($params['source']);
3525     foreach ($params as $key => $value) {
3526       $this->assertEquals($value, $values[$key], $key . " value: $value doesn't match " . print_r($values, TRUE));
3527     }
3528   }
3529
3530   /**
3531    * Create a pending contribution & linked pending pledge record.
3532    */
3533   public function createPendingPledgeContribution() {
3534
3535     $pledgeID = $this->pledgeCreate(['contact_id' => $this->_individualId, 'installments' => 1, 'amount' => 500]);
3536     $this->_ids['pledge'] = $pledgeID;
3537     $contribution = $this->callAPISuccess('contribution', 'create', array_merge($this->_params, [
3538       'contribution_status_id' => 'Pending',
3539       'total_amount' => 500,
3540     ]));
3541     $paymentID = $this->callAPISuccessGetValue('PledgePayment', [
3542       'options' => ['limit' => 1],
3543       'return' => 'id',
3544     ]);
3545     $this->callAPISuccess('PledgePayment', 'create', [
3546       'id' => $paymentID,
3547       'contribution_id' =>
3548       $contribution['id'],
3549       'status_id' => 'Pending',
3550       'scheduled_amount' => 500,
3551     ]);
3552
3553     return $contribution['id'];
3554   }
3555
3556   /**
3557    * Create a pending contribution & linked pending participant record (along with an event).
3558    */
3559   public function createPendingParticipantContribution() {
3560     $this->_ids['event']['test'] = $this->eventCreate(['is_email_confirm' => 1, 'confirm_from_email' => 'test@civicrm.org'])['id'];
3561     $participantID = $this->participantCreate(['event_id' => $this->_ids['event']['test'], 'status_id' => 6, 'contact_id' => $this->_individualId]);
3562     $this->_ids['participant'] = $participantID;
3563     $params = array_merge($this->_params, ['contact_id' => $this->_individualId, 'contribution_status_id' => 2, 'financial_type_id' => 'Event Fee']);
3564     $contribution = $this->callAPISuccess('contribution', 'create', $params);
3565     $this->callAPISuccess('participant_payment', 'create', [
3566       'contribution_id' => $contribution['id'],
3567       'participant_id' => $participantID,
3568     ]);
3569     $this->callAPISuccess('line_item', 'get', [
3570       'entity_id' => $contribution['id'],
3571       'entity_table' => 'civicrm_contribution',
3572       'api.line_item.create' => [
3573         'entity_id' => $participantID,
3574         'entity_table' => 'civicrm_participant',
3575       ],
3576     ]);
3577     return $contribution['id'];
3578   }
3579
3580   /**
3581    * Get financial transaction amount.
3582    *
3583    * @param int $contId
3584    *
3585    * @return null|string
3586    */
3587   public function _getFinancialTrxnAmount($contId) {
3588     $query = "SELECT
3589      SUM( ft.total_amount ) AS total
3590      FROM civicrm_financial_trxn AS ft
3591      LEFT JOIN civicrm_entity_financial_trxn AS ceft ON ft.id = ceft.financial_trxn_id
3592      WHERE ceft.entity_table = 'civicrm_contribution'
3593      AND ceft.entity_id = {$contId}";
3594
3595     $result = CRM_Core_DAO::singleValueQuery($query);
3596     return $result;
3597   }
3598
3599   /**
3600    * @param int $contId
3601    *
3602    * @return null|string
3603    */
3604   public function _getFinancialItemAmount($contId) {
3605     $lineItem = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
3606     $query = "SELECT
3607      SUM(amount)
3608      FROM civicrm_financial_item
3609      WHERE entity_table = 'civicrm_line_item'
3610      AND entity_id = {$lineItem}";
3611     $result = CRM_Core_DAO::singleValueQuery($query);
3612     return $result;
3613   }
3614
3615   /**
3616    * @param int $contId
3617    * @param $context
3618    */
3619   public function _checkFinancialItem($contId, $context) {
3620     if ($context != 'paylater') {
3621       $params = [
3622         'entity_id' => $contId,
3623         'entity_table' => 'civicrm_contribution',
3624       ];
3625       $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($params, TRUE));
3626       $entityParams = [
3627         'financial_trxn_id' => $trxn['financial_trxn_id'],
3628         'entity_table' => 'civicrm_financial_item',
3629       ];
3630       $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
3631       $params = [
3632         'id' => $entityTrxn['entity_id'],
3633       ];
3634     }
3635     if ($context == 'paylater') {
3636       $lineItems = CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution');
3637       foreach ($lineItems as $key => $item) {
3638         $params = [
3639           'entity_id' => $key,
3640           'entity_table' => 'civicrm_line_item',
3641         ];
3642         $compareParams = ['status_id' => 1];
3643         $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
3644       }
3645     }
3646     elseif ($context == 'refund') {
3647       $compareParams = [
3648         'status_id' => 1,
3649         'financial_account_id' => 1,
3650         'amount' => -100,
3651       ];
3652     }
3653     elseif ($context == 'cancelPending') {
3654       $compareParams = [
3655         'status_id' => 3,
3656         'financial_account_id' => 1,
3657         'amount' => -100,
3658       ];
3659     }
3660     elseif ($context == 'changeFinancial') {
3661       $lineKey = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
3662       $params = [
3663         'entity_id' => $lineKey,
3664         'amount' => -100,
3665       ];
3666       $compareParams = [
3667         'financial_account_id' => 1,
3668       ];
3669       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
3670       $params = [
3671         'financial_account_id' => 3,
3672         'entity_id' => $lineKey,
3673       ];
3674       $compareParams = [
3675         'amount' => 100,
3676       ];
3677     }
3678     if ($context != 'paylater') {
3679       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
3680     }
3681   }
3682
3683   /**
3684    * Check correct financial transaction entries were created for the change in payment instrument.
3685    *
3686    * @param int $contributionID
3687    * @param int $originalInstrumentID
3688    * @param int $newInstrumentID
3689    * @param int $amount
3690    */
3691   public function checkFinancialTrxnPaymentInstrumentChange($contributionID, $originalInstrumentID, $newInstrumentID, $amount = 100) {
3692
3693     $entityFinancialTrxns = $this->getFinancialTransactionsForContribution($contributionID);
3694
3695     $originalTrxnParams = [
3696       'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($originalInstrumentID),
3697       'payment_instrument_id' => $originalInstrumentID,
3698       'amount' => $amount,
3699       'status_id' => 1,
3700     ];
3701
3702     $reversalTrxnParams = [
3703       'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($originalInstrumentID),
3704       'payment_instrument_id' => $originalInstrumentID,
3705       'amount' => -$amount,
3706       'status_id' => 1,
3707     ];
3708
3709     $newTrxnParams = [
3710       'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($newInstrumentID),
3711       'payment_instrument_id' => $newInstrumentID,
3712       'amount' => $amount,
3713       'status_id' => 1,
3714     ];
3715
3716     foreach ([$originalTrxnParams, $reversalTrxnParams, $newTrxnParams] as $index => $transaction) {
3717       $entityFinancialTrxn = $entityFinancialTrxns[$index];
3718       $this->assertEquals($entityFinancialTrxn['amount'], $transaction['amount']);
3719
3720       $financialTrxn = $this->callAPISuccessGetSingle('FinancialTrxn', [
3721         'id' => $entityFinancialTrxn['financial_trxn_id'],
3722       ]);
3723       $this->assertEquals($transaction['status_id'], $financialTrxn['status_id']);
3724       $this->assertEquals($transaction['amount'], $financialTrxn['total_amount']);
3725       $this->assertEquals($transaction['amount'], $financialTrxn['net_amount']);
3726       $this->assertEquals(0, $financialTrxn['fee_amount']);
3727       $this->assertEquals($transaction['payment_instrument_id'], $financialTrxn['payment_instrument_id']);
3728       $this->assertEquals($transaction['to_financial_account_id'], $financialTrxn['to_financial_account_id']);
3729
3730       // Generic checks.
3731       $this->assertEquals(1, $financialTrxn['is_payment']);
3732       $this->assertEquals('USD', $financialTrxn['currency']);
3733       $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($financialTrxn['trxn_date'])));
3734     }
3735   }
3736
3737   /**
3738    * Check financial transaction.
3739    *
3740    * @todo break this down into sensible functions - most calls to it only use a few lines out of the big if.
3741    *
3742    * @param array $contribution
3743    * @param string $context
3744    * @param int $instrumentId
3745    * @param array $extraParams
3746    */
3747   public function _checkFinancialTrxn($contribution, $context, $instrumentId = NULL, $extraParams = []) {
3748     $financialTrxns = $this->getFinancialTransactionsForContribution($contribution['id']);
3749     $trxn = array_pop($financialTrxns);
3750
3751     $params = [
3752       'id' => $trxn['financial_trxn_id'],
3753     ];
3754     if ($context == 'payLater') {
3755       $compareParams = [
3756         'status_id' => 1,
3757         'from_financial_account_id' => CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($contribution['financial_type_id'], 'Accounts Receivable Account is'),
3758       ];
3759     }
3760     elseif ($context == 'refund') {
3761       $compareParams = [
3762         'to_financial_account_id' => 6,
3763         'total_amount' => -100,
3764         'status_id' => 7,
3765         'trxn_date' => '2015-01-01 09:00:00',
3766         'trxn_id' => 'the refund',
3767       ];
3768     }
3769     elseif ($context == 'cancelPending') {
3770       $compareParams = [
3771         'to_financial_account_id' => 7,
3772         'total_amount' => -100,
3773         'status_id' => 3,
3774       ];
3775     }
3776     elseif ($context == 'changeFinancial' || $context == 'paymentInstrument') {
3777       // @todo checkFinancialTrxnPaymentInstrumentChange instead for paymentInstrument.
3778       // It does the same thing with greater readability.
3779       // @todo remove handling for
3780
3781       $entityParams = [
3782         'entity_id' => $contribution['id'],
3783         'entity_table' => 'civicrm_contribution',
3784         'amount' => -100,
3785       ];
3786       $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
3787       $trxnParams1 = [
3788         'id' => $trxn['financial_trxn_id'],
3789       ];
3790       if (empty($extraParams)) {
3791         $compareParams = [
3792           'total_amount' => -100,
3793           'status_id' => 1,
3794         ];
3795       }
3796       else {
3797         $compareParams = [
3798           'total_amount' => 100,
3799           'status_id' => 1,
3800         ];
3801       }
3802       if ($context == 'paymentInstrument') {
3803         $compareParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($instrumentId);
3804         $compareParams['payment_instrument_id'] = $instrumentId;
3805       }
3806       else {
3807         $compareParams['to_financial_account_id'] = 12;
3808       }
3809       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams1, array_merge($compareParams, $extraParams));
3810       $compareParams['total_amount'] = 100;
3811     }
3812
3813     $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $params, array_merge($compareParams, $extraParams));
3814   }
3815
3816   /**
3817    * @return mixed
3818    */
3819   public function _addPaymentInstrument() {
3820     $gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'payment_instrument', 'id', 'name');
3821     $optionParams = [
3822       'option_group_id' => $gId,
3823       'label' => 'Test Card',
3824       'name' => 'Test Card',
3825       'value' => '6',
3826       'weight' => '6',
3827       'is_active' => 1,
3828     ];
3829     $optionValue = $this->callAPISuccess('option_value', 'create', $optionParams);
3830     $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
3831     $financialParams = [
3832       'entity_table' => 'civicrm_option_value',
3833       'entity_id' => $optionValue['id'],
3834       'account_relationship' => $relationTypeId,
3835       'financial_account_id' => 7,
3836     ];
3837     CRM_Financial_BAO_FinancialTypeAccount::add($financialParams);
3838     $this->assertNotEmpty($optionValue['values'][$optionValue['id']]['value']);
3839     return $optionValue['values'][$optionValue['id']]['value'];
3840   }
3841
3842   public function _deletedAddedPaymentInstrument() {
3843     $result = $this->callAPISuccess('OptionValue', 'get', [
3844       'option_group_id' => 'payment_instrument',
3845       'name' => 'Test Card',
3846       'value' => '6',
3847       'is_active' => 1,
3848     ]);
3849     if ($id = CRM_Utils_Array::value('id', $result)) {
3850       $this->callAPISuccess('OptionValue', 'delete', ['id' => $id]);
3851     }
3852   }
3853
3854   /**
3855    * Set up the basic recurring contribution for tests.
3856    *
3857    * @param array $generalParams
3858    *   Parameters that can be merged into the recurring AND the contribution.
3859    *
3860    * @param array $recurParams
3861    *   Parameters to merge into the recur only.
3862    *
3863    * @return array|int
3864    */
3865   protected function setUpRecurringContribution($generalParams = [], $recurParams = []) {
3866     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
3867       'contact_id' => $this->_individualId,
3868       'installments' => '12',
3869       'frequency_interval' => '1',
3870       'amount' => '100',
3871       'contribution_status_id' => 1,
3872       'start_date' => '2012-01-01 00:00:00',
3873       'currency' => 'USD',
3874       'frequency_unit' => 'month',
3875       'payment_processor_id' => $this->paymentProcessorID,
3876     ], $generalParams, $recurParams));
3877     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
3878       $this->_params,
3879       [
3880         'contribution_recur_id' => $contributionRecur['id'],
3881       ], $generalParams)
3882     );
3883     return $originalContribution;
3884   }
3885
3886   /**
3887    * Set up a basic auto-renew membership for tests.
3888    *
3889    * @param array $generalParams
3890    *   Parameters that can be merged into the recurring AND the contribution.
3891    *
3892    * @param array $recurParams
3893    *   Parameters to merge into the recur only.
3894    *
3895    * @return array|int
3896    */
3897   protected function setUpAutoRenewMembership($generalParams = [], $recurParams = []) {
3898     $newContact = $this->callAPISuccess('Contact', 'create', [
3899       'contact_type' => 'Individual',
3900       'sort_name' => 'McTesterson, Testy',
3901       'display_name' => 'Testy McTesterson',
3902       'preferred_language' => 'en_US',
3903       'preferred_mail_format' => 'Both',
3904       'first_name' => 'Testy',
3905       'last_name' => 'McTesterson',
3906       'contact_is_deleted' => '0',
3907       'email_id' => '4',
3908       'email' => 'tmctesterson@example.com',
3909       'on_hold' => '0',
3910     ]);
3911     $membershipType = $this->callAPISuccess('MembershipType', 'create', [
3912       'domain_id' => "Default Domain Name",
3913       'member_of_contact_id' => 1,
3914       'financial_type_id' => "Member Dues",
3915       'duration_unit' => "month",
3916       'duration_interval' => 1,
3917       'period_type' => 'rolling',
3918       'name' => "Standard Member",
3919       'minimum_fee' => 100,
3920     ]);
3921     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
3922       'contact_id' => $newContact['id'],
3923       'installments' => '12',
3924       'frequency_interval' => '1',
3925       'amount' => '100',
3926       'contribution_status_id' => 1,
3927       'start_date' => '2012-01-01 00:00:00',
3928       'currency' => 'USD',
3929       'frequency_unit' => 'month',
3930       'payment_processor_id' => $this->paymentProcessorID,
3931     ], $generalParams, $recurParams));
3932
3933     $membership = $this->callAPISuccess('membership', 'create', [
3934       'contact_id' => $newContact['id'],
3935       'contribution_recur_id' => $contributionRecur['id'],
3936       'financial_type_id' => "Member Dues",
3937       'membership_type_id' => $membershipType['id'],
3938       'num_terms' => 1,
3939       'skipLineItem' => TRUE,
3940     ]);
3941
3942     CRM_Price_BAO_LineItem::getLineItemArray($this->_params, NULL, 'membership', $membershipType['id']);
3943     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
3944       $this->_params,
3945       [
3946         'contact_id' => $newContact['id'],
3947         'contribution_recur_id' => $contributionRecur['id'],
3948         'financial_type_id' => "Member Dues",
3949         'contribution_status_id' => 1,
3950         'invoice_id' => uniqid(),
3951       ], $generalParams)
3952     );
3953     $lineItem = $this->callAPISuccess('LineItem', 'getsingle', []);
3954     $this->assertEquals('civicrm_membership', $lineItem['entity_table']);
3955     $membership = $this->callAPISuccess('Membership', 'getsingle', ['id' => $lineItem['entity_id']]);
3956     $this->callAPISuccess('LineItem', 'getsingle', []);
3957     $this->callAPISuccessGetCount('MembershipPayment', ['membership_id' => $membership['id']], 1);
3958
3959     return [$originalContribution, $membership];
3960   }
3961
3962   /**
3963    * Set up a repeat transaction.
3964    *
3965    * @param array $recurParams
3966    * @param mixed $flag
3967    * @param array $contributionParams
3968    * @return array
3969    */
3970   protected function setUpRepeatTransaction($recurParams = [], $flag, $contributionParams = []) {
3971     $paymentProcessorID = $this->paymentProcessorCreate();
3972     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge([
3973       'contact_id' => $this->_individualId,
3974       'installments' => '12',
3975       'frequency_interval' => '1',
3976       'amount' => '500',
3977       'contribution_status_id' => 1,
3978       'start_date' => '2012-01-01 00:00:00',
3979       'currency' => 'USD',
3980       'frequency_unit' => 'month',
3981       'payment_processor_id' => $paymentProcessorID,
3982     ], $recurParams));
3983
3984     $originalContribution = '';
3985     if ($flag == 'multiple') {
3986       // CRM-19309 create a contribution + also add in line_items (plural):
3987       $params = array_merge($this->_params, $contributionParams);
3988       $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
3989           $params,
3990           [
3991             'contribution_recur_id' => $contributionRecur['id'],
3992             'skipLineItem' => 1,
3993             'api.line_item.create' => [
3994               [
3995                 'price_field_id' => 1,
3996                 'qty' => 2,
3997                 'line_total' => '20',
3998                 'unit_price' => '10',
3999                 'financial_type_id' => 1,
4000               ],
4001               [
4002                 'price_field_id' => 1,
4003                 'qty' => 1,
4004                 'line_total' => '80',
4005                 'unit_price' => '80',
4006                 'financial_type_id' => 2,
4007               ],
4008             ],
4009           ]
4010         )
4011       );
4012     }
4013     elseif ($flag == 'single') {
4014       $params = array_merge($this->_params, ['contribution_recur_id' => $contributionRecur['id']]);
4015       $params = array_merge($params, $contributionParams);
4016       $originalContribution = $this->callAPISuccess('contribution', 'create', $params);
4017     }
4018     $originalContribution['payment_processor_id'] = $paymentProcessorID;
4019     return $originalContribution;
4020   }
4021
4022   /**
4023    * Common set up routine.
4024    *
4025    * @return array
4026    */
4027   protected function setUpForCompleteTransaction() {
4028     $this->mut = new CiviMailUtils($this, TRUE);
4029     $this->createLoggedInUser();
4030     $params = array_merge($this->_params, ['contribution_status_id' => 2, 'receipt_date' => 'now']);
4031     $contribution = $this->callAPISuccess('contribution', 'create', $params);
4032     return $contribution;
4033   }
4034
4035   /**
4036    * Test repeat contribution uses the Payment Processor' payment_instrument setting.
4037    */
4038   public function testRepeatTransactionWithNonCreditCardDefault() {
4039     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
4040       'contact_id' => $this->_individualId,
4041       'installments' => '12',
4042       'frequency_interval' => '1',
4043       'amount' => '100',
4044       'contribution_status_id' => 1,
4045       'start_date' => '2012-01-01 00:00:00',
4046       'currency' => 'USD',
4047       'frequency_unit' => 'month',
4048       'payment_processor_id' => $this->paymentProcessorID,
4049     ]);
4050     $contribution1 = $this->callAPISuccess('contribution', 'create', array_merge(
4051         $this->_params,
4052         ['contribution_recur_id' => $contributionRecur['id'], 'payment_instrument_id' => 2])
4053     );
4054     $paymentInstruments = CRM_Contribute_PseudoConstant::paymentInstrument('name');
4055     $contribution2 = $this->callAPISuccess('contribution', 'repeattransaction', [
4056       'contribution_status_id' => 'Completed',
4057       'trxn_id' => uniqid(),
4058       'original_contribution_id' => $contribution1,
4059     ]);
4060     $this->assertEquals(array_search('Debit Card', $paymentInstruments), $contribution2['values'][$contribution2['id']]['payment_instrument_id']);
4061     $this->quickCleanUpFinancialEntities();
4062   }
4063
4064   /**
4065    * CRM-20008 Tests repeattransaction creates pending membership.
4066    */
4067   public function testRepeatTransactionMembershipCreatePendingContribution() {
4068     list($originalContribution, $membership) = $this->setUpAutoRenewMembership();
4069     $this->callAPISuccess('membership', 'create', [
4070       'id' => $membership['id'],
4071       'end_date' => 'yesterday',
4072       'status_id' => 'Expired',
4073     ]);
4074     $repeatedContribution = $this->callAPISuccess('contribution', 'repeattransaction', [
4075       'contribution_recur_id' => $originalContribution['values'][1]['contribution_recur_id'],
4076       'contribution_status_id' => 'Pending',
4077       'trxn_id' => uniqid(),
4078     ]);
4079     $membershipStatusId = $this->callAPISuccess('membership', 'getvalue', [
4080       'id' => $membership['id'],
4081       'return' => 'status_id',
4082     ]);
4083
4084     // Let's see if the membership payments got created while we're at it.
4085     $membershipPayments = $this->callAPISuccess('MembershipPayment', 'get', [
4086       'membership_id' => $membership['id'],
4087     ]);
4088     $this->assertEquals(2, $membershipPayments['count']);
4089
4090     $this->assertEquals('Expired', CRM_Core_PseudoConstant::getLabel('CRM_Member_BAO_Membership', 'status_id', $membershipStatusId));
4091     $this->callAPISuccess('Contribution', 'completetransaction', ['id' => $repeatedContribution['id']]);
4092     $membership = $this->callAPISuccessGetSingle('membership', [
4093       'id' => $membership['id'],
4094       'return' => 'status_id, end_date',
4095     ]);
4096     $this->assertEquals('New', CRM_Core_PseudoConstant::getName('CRM_Member_BAO_Membership', 'status_id', $membership['status_id']));
4097     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 1 month')), $membership['end_date']);
4098
4099     $this->quickCleanUpFinancialEntities();
4100     $this->contactDelete($originalContribution['values'][1]['contact_id']);
4101   }
4102
4103   /**
4104    * Test sending a mail via the API.
4105    */
4106   public function testSendMailWithAPISetFromDetails() {
4107     $mut = new CiviMailUtils($this, TRUE);
4108     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
4109     $this->callAPISuccess('contribution', 'sendconfirmation', [
4110       'id' => $contribution['id'],
4111       'receipt_from_email' => 'api@civicrm.org',
4112       'receipt_from_name' => 'CiviCRM LLC',
4113     ]);
4114     $mut->checkMailLog([
4115       'From: CiviCRM LLC <api@civicrm.org>',
4116       'Contribution Information',
4117     ], [
4118       'Event',
4119     ]);
4120     $mut->stop();
4121   }
4122
4123   /**
4124    * Test sending a mail via the API.
4125    */
4126   public function testSendMailWithNoFromSetFallToDomain() {
4127     $this->createLoggedInUser();
4128     $mut = new CiviMailUtils($this, TRUE);
4129     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
4130     $this->callAPISuccess('contribution', 'sendconfirmation', [
4131       'id' => $contribution['id'],
4132     ]);
4133     $domain = $this->callAPISuccess('domain', 'getsingle', ['id' => 1]);
4134     $mut->checkMailLog([
4135       'From: ' . $domain['from_name'] . ' <' . $domain['from_email'] . '>',
4136       'Contribution Information',
4137     ], [
4138       'Event',
4139     ]);
4140     $mut->stop();
4141   }
4142
4143   /**
4144    * Test sending a mail via the API.
4145    */
4146   public function testSendMailWithRepeatTransactionAPIFalltoDomain() {
4147     $this->createLoggedInUser();
4148     $mut = new CiviMailUtils($this, TRUE);
4149     $contribution = $this->setUpRepeatTransaction([], 'single');
4150     $this->callAPISuccess('contribution', 'repeattransaction', [
4151       'contribution_status_id' => 'Completed',
4152       'trxn_id' => uniqid(),
4153       'original_contribution_id' => $contribution,
4154     ]);
4155     $domain = $this->callAPISuccess('domain', 'getsingle', ['id' => 1]);
4156     $mut->checkMailLog([
4157       'From: ' . $domain['from_name'] . ' <' . $domain['from_email'] . '>',
4158       'Contribution Information',
4159     ], [
4160       'Event',
4161     ]
4162     );
4163     $mut->stop();
4164   }
4165
4166   /**
4167    * Test sending a mail via the API.
4168    */
4169   public function testSendMailWithRepeatTransactionAPIFalltoContributionPage() {
4170     $mut = new CiviMailUtils($this, TRUE);
4171     $contributionPage = $this->contributionPageCreate(['receipt_from_name' => 'CiviCRM LLC', 'receipt_from_email' => 'contributionpage@civicrm.org', 'is_email_receipt' => 1]);
4172     $paymentProcessorID = $this->paymentProcessorCreate();
4173     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', [
4174       'contact_id' => $this->_individualId,
4175       'installments' => '12',
4176       'frequency_interval' => '1',
4177       'amount' => '500',
4178       'contribution_status_id' => 1,
4179       'start_date' => '2012-01-01 00:00:00',
4180       'currency' => 'USD',
4181       'frequency_unit' => 'month',
4182       'payment_processor_id' => $paymentProcessorID,
4183     ]);
4184     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
4185       $this->_params,
4186       [
4187         'contribution_recur_id' => $contributionRecur['id'],
4188         'contribution_page_id' => $contributionPage['id'],
4189       ])
4190     );
4191     $this->callAPISuccess('contribution', 'repeattransaction', [
4192       'contribution_status_id' => 'Completed',
4193       'trxn_id' => uniqid(),
4194       'original_contribution_id' => $originalContribution,
4195     ]
4196     );
4197     $mut->checkMailLog([
4198       'From: CiviCRM LLC <contributionpage@civicrm.org>',
4199       'Contribution Information',
4200     ], [
4201       'Event',
4202     ]);
4203     $mut->stop();
4204   }
4205
4206   /**
4207    * Test sending a mail via the API.
4208    */
4209   public function testSendMailWithRepeatTransactionAPIFalltoSystemFromNoDefaultFrom() {
4210     $mut = new CiviMailUtils($this, TRUE);
4211     $originalContribution = $contribution = $this->setUpRepeatTransaction([], 'single');
4212     $fromEmail = $this->CallAPISuccess('optionValue', 'get', ['is_default' => 1, 'option_group_id' => 'from_email_address', 'sequential' => 1]);
4213     foreach ($fromEmail['values'] as $from) {
4214       $this->callAPISuccess('optionValue', 'create', ['is_default' => 0, 'id' => $from['id']]);
4215     }
4216     $domain = $this->callAPISuccess('domain', 'getsingle', ['id' => CRM_Core_Config::domainID()]);
4217     $this->callAPISuccess('contribution', 'repeattransaction', [
4218       'contribution_status_id' => 'Completed',
4219       'trxn_id' => uniqid(),
4220       'original_contribution_id' => $originalContribution,
4221     ]);
4222     $mut->checkMailLog([
4223       'From: ' . $domain['name'] . ' <' . $domain['domain_email'] . '>',
4224       'Contribution Information',
4225     ], [
4226       'Event',
4227     ]);
4228     $mut->stop();
4229   }
4230
4231   /**
4232    * Create a Contribution Page with is_email_receipt = TRUE.
4233    *
4234    * @param array $params
4235    *   Params to overwrite with.
4236    *
4237    * @return array|int
4238    */
4239   protected function createReceiptableContributionPage($params = []) {
4240     $contributionPage = $this->callAPISuccess('ContributionPage', 'create', array_merge([
4241       'receipt_from_name' => 'Mickey Mouse',
4242       'receipt_from_email' => 'mickey@mouse.com',
4243       'title' => "Test Contribution Page",
4244       'financial_type_id' => 1,
4245       'currency' => 'CAD',
4246       'is_monetary' => TRUE,
4247       'is_email_receipt' => TRUE,
4248     ], $params));
4249     return $contributionPage;
4250   }
4251
4252   /**
4253    * function to test card_type and pan truncation.
4254    */
4255   public function testCardTypeAndPanTruncation() {
4256     $creditCardTypeIDs = array_flip(CRM_Financial_DAO_FinancialTrxn::buildOptions('card_type_id'));
4257     $contactId = $this->individualCreate();
4258     $params = [
4259       'contact_id' => $contactId,
4260       'receive_date' => '2016-01-20',
4261       'total_amount' => 100,
4262       'financial_type_id' => 1,
4263       'payment_instrument' => 'Credit Card',
4264       'card_type_id' => $creditCardTypeIDs['Visa'],
4265       'pan_truncation' => 4567,
4266     ];
4267     $contribution = $this->callAPISuccess('contribution', 'create', $params);
4268     $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contribution['id'], 'DESC');
4269     $financialTrxn = $this->callAPISuccessGetSingle(
4270       'FinancialTrxn',
4271       [
4272         'id' => $lastFinancialTrxnId['financialTrxnId'],
4273         'return' => ['card_type_id', 'pan_truncation'],
4274       ]
4275     );
4276     $this->assertEquals(CRM_Utils_Array::value('card_type_id', $financialTrxn), $creditCardTypeIDs['Visa']);
4277     $this->assertEquals(CRM_Utils_Array::value('pan_truncation', $financialTrxn), 4567);
4278     $params = [
4279       'id' => $contribution['id'],
4280       'pan_truncation' => 2345,
4281       'card_type_id' => $creditCardTypeIDs['Amex'],
4282     ];
4283     $contribution = $this->callAPISuccess('contribution', 'create', $params);
4284     $financialTrxn = $this->callAPISuccessGetSingle(
4285       'FinancialTrxn',
4286       [
4287         'id' => $lastFinancialTrxnId['financialTrxnId'],
4288         'return' => ['card_type_id', 'pan_truncation'],
4289       ]
4290     );
4291     $this->assertEquals(CRM_Utils_Array::value('card_type_id', $financialTrxn), $creditCardTypeIDs['Amex']);
4292     $this->assertEquals(CRM_Utils_Array::value('pan_truncation', $financialTrxn), 2345);
4293   }
4294
4295   /**
4296    * Test repeat contribution uses non default currency
4297    * @see https://issues.civicrm.org/jira/projects/CRM/issues/CRM-20678
4298    */
4299   public function testRepeatTransactionWithDifferenceCurrency() {
4300     $originalContribution = $this->setUpRepeatTransaction(['currency' => 'AUD'], 'single', ['currency' => 'AUD']);
4301     $contribution = $this->callAPISuccess('contribution', 'repeattransaction', [
4302       'original_contribution_id' => $originalContribution['id'],
4303       'contribution_status_id' => 'Completed',
4304       'trxn_id' => uniqid(),
4305     ]);
4306     $this->assertEquals('AUD', $contribution['values'][$contribution['id']]['currency']);
4307   }
4308
4309   /**
4310    * Get the financial items for the contribution.
4311    *
4312    * @param int $contributionID
4313    *
4314    * @return array
4315    *   Array of associated financial items.
4316    */
4317   protected function getFinancialTransactionsForContribution($contributionID) {
4318     $trxnParams = [
4319       'entity_id' => $contributionID,
4320       'entity_table' => 'civicrm_contribution',
4321     ];
4322     // @todo the following function has naming errors & has a weird signature & appears to
4323     // only be called from test classes. Move into test suite & maybe just use api
4324     // from this function.
4325     return array_merge(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($trxnParams, FALSE, []));
4326   }
4327
4328   /**
4329    * Test getunique api call for Contribution entity
4330    */
4331   public function testContributionGetUnique() {
4332     $result = $this->callAPIAndDocument($this->_entity, 'getunique', [], __FUNCTION__, __FILE__);
4333     $this->assertEquals(2, $result['count']);
4334     $this->assertEquals(['trxn_id'], $result['values']['UI_contrib_trxn_id']);
4335     $this->assertEquals(['invoice_id'], $result['values']['UI_contrib_invoice_id']);
4336   }
4337
4338   /**
4339    * Test Repeat Transaction Contribution with Tax amount.
4340    * https://lab.civicrm.org/dev/core/issues/806
4341    */
4342   public function testRepeatContributionWithTaxAmount() {
4343     $this->enableTaxAndInvoicing();
4344     $financialType = $this->callAPISuccess('financial_type', 'create', [
4345       'name' => 'Test taxable financial Type',
4346       'is_reserved' => 0,
4347       'is_active' => 1,
4348     ]);
4349     $this->relationForFinancialTypeWithFinancialAccount($financialType['id']);
4350     $contribution = $this->setUpRepeatTransaction(
4351       [],
4352       'single',
4353       [
4354         'financial_type_id' => $financialType['id'],
4355       ]
4356     );
4357     $this->callAPISuccess('contribution', 'repeattransaction', [
4358       'original_contribution_id' => $contribution['id'],
4359       'contribution_status_id' => 'Completed',
4360       'trxn_id' => uniqid(),
4361     ]);
4362     $payments = $this->callAPISuccess('Contribution', 'get', ['sequential' => 1])['values'];
4363     //Assert if first payment and repeated payment has the same contribution amount.
4364     $this->assertEquals($payments[0]['total_amount'], $payments[1]['total_amount']);
4365     $this->callAPISuccessGetCount('Contribution', [], 2);
4366   }
4367
4368   public function testGetCurrencyOptions() {
4369     $result = $this->callAPISuccess('Contribution', 'getoptions', [
4370       'field' => 'currency',
4371     ]);
4372     $this->assertEquals('US Dollar', $result['values']['USD']);
4373     $this->assertNotContains('$', $result['values']);
4374     $result = $this->callAPISuccess('Contribution', 'getoptions', [
4375       'field' => 'currency',
4376       'context' => "abbreviate",
4377     ]);
4378     $this->assertEquals('$', $result['values']['USD']);
4379     $this->assertNotContains('US Dollar', $result['values']);
4380   }
4381
4382 }