tests/phpunit/api/v3/ContributionTest.php

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