tests/phpunit/api/v3/ContributionTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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 require_once 'CiviTest/CiviUnitTestCase.php';
  29 require_once 'CiviTest/CiviMailUtils.php';
  30
  31
  32 /**
  33  *  Test APIv3 civicrm_contribute_* functions
  34  *
  35  * @package CiviCRM_APIv3
  36  * @subpackage API_Contribution
  37  */
  38 class api_v3_ContributionTest extends CiviUnitTestCase {
  39
  40   /**
  41    * Assume empty database with just civicrm_data.
  42    */
  43   protected $_individualId;
  44   protected $_contribution;
  45   protected $_financialTypeId = 1;
  46   protected $_apiversion;
  47   protected $_entity = 'Contribution';
  48   public $debug = 0;
  49   protected $_params;
  50   protected $_ids = array();
  51   protected $_pageParams = array();
  52
  53   /**
  54    * Parameters to create payment processor.
  55    *
  56    * @var array
  57    */
  58   protected $_processorParams = array();
  59
  60   /**
  61    * ID of created event.
  62    *
  63    * @var int
  64    */
  65   protected $_eventID;
  66
  67   /**
  68    * Setup function.
  69    */
  70   public function setUp() {
  71     parent::setUp();
  72
  73     $this->_apiversion = 3;
  74     $this->_individualId = $this->individualCreate();
  75     $this->_params = array(
  76       'contact_id' => $this->_individualId,
  77       'receive_date' => '20120511',
  78       'total_amount' => 100.00,
  79       'financial_type_id' => $this->_financialTypeId,
  80       'non_deductible_amount' => 10.00,
  81       'fee_amount' => 5.00,
  82       'net_amount' => 95.00,
  83       'source' => 'SSF',
  84       'contribution_status_id' => 1,
  85     );
  86     $this->_processorParams = array(
  87       'domain_id' => 1,
  88       'name' => 'Dummy',
  89       'payment_processor_type_id' => 10,
  90       'financial_account_id' => 12,
  91       'is_active' => 1,
  92       'user_name' => '',
  93       'url_site' => 'http://dummy.com',
  94       'url_recur' => 'http://dummy.com',
  95       'billing_mode' => 1,
  96     );
  97     $this->_pageParams = array(
  98       'title' => 'Test Contribution Page',
  99       'financial_type_id' => 1,
 100       'currency' => 'USD',
 101       'financial_account_id' => 1,
 102       'payment_processor' => $this->processorCreate(),
 103       'is_active' => 1,
 104       'is_allow_other_amount' => 1,
 105       'min_amount' => 10,
 106       'max_amount' => 1000,
 107     );
 108   }
 109
 110   /**
 111    * Clean up after each test.
 112    */
 113   public function tearDown() {
 114     $this->quickCleanUpFinancialEntities();
 115     $this->quickCleanup(array('civicrm_uf_match'));
 116   }
 117
 118   /**
 119    * Test Get.
 120    */
 121   public function testGetContribution() {
 122     $p = array(
 123       'contact_id' => $this->_individualId,
 124       'receive_date' => '2010-01-20',
 125       'total_amount' => 100.00,
 126       'financial_type_id' => $this->_financialTypeId,
 127       'non_deductible_amount' => 10.00,
 128       'fee_amount' => 5.00,
 129       'net_amount' => 95.00,
 130       'trxn_id' => 23456,
 131       'invoice_id' => 78910,
 132       'source' => 'SSF',
 133       'contribution_status_id' => 1,
 134     );
 135     $this->_contribution = $this->callAPISuccess('contribution', 'create', $p);
 136
 137     $params = array(
 138       'contribution_id' => $this->_contribution['id'],
 139     );
 140
 141     $contribution = $this->callAPIAndDocument('contribution', 'get', $params, __FUNCTION__, __FILE__);
 142     $financialParams['id'] = $this->_financialTypeId;
 143     $default = NULL;
 144     CRM_Financial_BAO_FinancialType::retrieve($financialParams, $default);
 145
 146     $this->assertEquals(1, $contribution['count']);
 147     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 148     // Note there was an assertion converting financial_type_id to 'Donation' which wasn't working.
 149     // Passing back a string rather than an id seems like an error/cruft.
 150     // If it is to be introduced we should discuss.
 151     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 152     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 153     $this->assertEquals($contribution['values'][$contribution['id']]['non_deductible_amount'], 10.00);
 154     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 5.00);
 155     $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 95.00);
 156     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 23456);
 157     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 78910);
 158     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_source'], 'SSF');
 159     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed');
 160     // Create a second contribution - we are testing that 'id' gets the right contribution id (not the contact id).
 161     $p['trxn_id'] = '3847';
 162     $p['invoice_id'] = '3847';
 163
 164     $contribution2 = $this->callAPISuccess('contribution', 'create', $p);
 165
 166     // Now we have 2 - test getcount.
 167     $contribution = $this->callAPISuccess('contribution', 'getcount', array());
 168     $this->assertEquals(2, $contribution);
 169     // Test id only format.
 170     $contribution = $this->callAPISuccess('contribution', 'get', array(
 171       'id' => $this->_contribution['id'],
 172       'format.only_id' => 1,
 173     ));
 174     $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution, TRUE));
 175     // Test id only format.
 176     $contribution = $this->callAPISuccess('contribution', 'get', array(
 177       'id' => $contribution2['id'],
 178       'format.only_id' => 1,
 179     ));
 180     $this->assertEquals($contribution2['id'], $contribution);
 181     // Test id as field.
 182     $contribution = $this->callAPISuccess('contribution', 'get', array(
 183       'id' => $this->_contribution['id'],
 184     ));
 185     $this->assertEquals(1, $contribution['count']);
 186
 187     // Test get by contact id works.
 188     $contribution = $this->callAPISuccess('contribution', 'get', array('contact_id' => $this->_individualId));
 189
 190     $this->assertEquals(2, $contribution['count']);
 191     $this->callAPISuccess('Contribution', 'Delete', array(
 192       'id' => $this->_contribution['id'],
 193     ));
 194     $this->callAPISuccess('Contribution', 'Delete', array(
 195       'id' => $contribution2['id'],
 196     ));
 197   }
 198
 199   /**
 200    * Test that test contributions can be retrieved.
 201    */
 202   public function testGetTestContribution() {
 203     $this->callAPISuccess('Contribution', 'create', array_merge($this->_params, array('is_test' => 1)));
 204     $this->callAPISuccessGetSingle('Contribution', array('is_test' => 1));
 205   }
 206
 207   /**
 208    * We need to ensure previous tested behaviour still works as part of the api contract.
 209    */
 210   public function testGetContributionLegacyBehaviour() {
 211     $p = array(
 212       'contact_id' => $this->_individualId,
 213       'receive_date' => '2010-01-20',
 214       'total_amount' => 100.00,
 215       'contribution_type_id' => $this->_financialTypeId,
 216       'non_deductible_amount' => 10.00,
 217       'fee_amount' => 5.00,
 218       'net_amount' => 95.00,
 219       'trxn_id' => 23456,
 220       'invoice_id' => 78910,
 221       'source' => 'SSF',
 222       'contribution_status_id' => 1,
 223     );
 224     $this->_contribution = $this->callAPISuccess('Contribution', 'create', $p);
 225
 226     $params = array(
 227       'contribution_id' => $this->_contribution['id'],
 228     );
 229     $contribution = $this->callAPIAndDocument('contribution', 'get', $params, __FUNCTION__, __FILE__);
 230     $financialParams['id'] = $this->_financialTypeId;
 231     $default = NULL;
 232     CRM_Financial_BAO_FinancialType::retrieve($financialParams, $default);
 233
 234     $this->assertEquals(1, $contribution['count']);
 235     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 236     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], $this->_financialTypeId);
 237     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_type_id'], $this->_financialTypeId);
 238     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 239     $this->assertEquals($contribution['values'][$contribution['id']]['non_deductible_amount'], 10.00);
 240     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 5.00);
 241     $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 95.00);
 242     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 23456);
 243     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 78910);
 244     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_source'], 'SSF');
 245     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed');
 246
 247     // Create a second contribution - we are testing that 'id' gets the right contribution id (not the contact id).
 248     $p['trxn_id'] = '3847';
 249     $p['invoice_id'] = '3847';
 250
 251     $contribution2 = $this->callAPISuccess('contribution', 'create', $p);
 252
 253     // now we have 2 - test getcount
 254     $contribution = $this->callAPISuccess('contribution', 'getcount', array());
 255     $this->assertEquals(2, $contribution);
 256     //test id only format
 257     $contribution = $this->callAPISuccess('contribution', 'get', array(
 258       'id' => $this->_contribution['id'],
 259       'format.only_id' => 1,
 260     ));
 261     $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution, TRUE));
 262     //test id only format
 263     $contribution = $this->callAPISuccess('contribution', 'get', array(
 264       'id' => $contribution2['id'],
 265       'format.only_id' => 1,
 266     ));
 267     $this->assertEquals($contribution2['id'], $contribution);
 268     $contribution = $this->callAPISuccess('contribution', 'get', array(
 269       'id' => $this->_contribution['id'],
 270     ));
 271     //test id as field
 272     $this->assertEquals(1, $contribution['count']);
 273     // $this->assertEquals($this->_contribution['id'], $contribution['id'] )  ;
 274     //test get by contact id works
 275     $contribution = $this->callAPISuccess('contribution', 'get', array('contact_id' => $this->_individualId));
 276
 277     $this->assertEquals(2, $contribution['count']);
 278     $this->callAPISuccess('Contribution', 'Delete', array(
 279       'id' => $this->_contribution['id'],
 280     ));
 281     $this->callAPISuccess('Contribution', 'Delete', array(
 282       'id' => $contribution2['id'],
 283     ));
 284   }
 285
 286   /**
 287    * Create an contribution_id=FALSE and financial_type_id=Donation.
 288    */
 289   public function testCreateEmptyContributionIDUseDonation() {
 290     $params = array(
 291       'contribution_id' => FALSE,
 292       'contact_id' => 1,
 293       'total_amount' => 1,
 294       'check_permissions' => FALSE,
 295       'financial_type_id' => 'Donation',
 296     );
 297     $this->callAPISuccess('contribution', 'create', $params);
 298   }
 299
 300   /**
 301    * Check with complete array + custom field.
 302    *
 303    * Note that the test is written on purpose without any
 304    * variables specific to participant so it can be replicated into other entities
 305    * and / or moved to the automated test suite
 306    */
 307   public function testCreateWithCustom() {
 308     $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 309
 310     $params = $this->_params;
 311     $params['custom_' . $ids['custom_field_id']] = "custom string";
 312
 313     $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);
 314     $this->assertEquals($result['id'], $result['values'][$result['id']]['id']);
 315     $check = $this->callAPISuccess($this->_entity, 'get', array(
 316       'return.custom_' . $ids['custom_field_id'] => 1,
 317       'id' => $result['id'],
 318     ));
 319     $this->customFieldDelete($ids['custom_field_id']);
 320     $this->customGroupDelete($ids['custom_group_id']);
 321     $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']]);
 322   }
 323
 324   /**
 325    * Check with complete array + custom field.
 326    *
 327    * Note that the test is written on purpose without any
 328    * variables specific to participant so it can be replicated into other entities
 329    * and / or moved to the automated test suite
 330    */
 331   public function testCreateGetFieldsWithCustom() {
 332     $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 333     $idsContact = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, 'ContactTest.php');
 334     $result = $this->callAPISuccess('Contribution', 'getfields', array());
 335     $this->assertArrayHasKey('custom_' . $ids['custom_field_id'], $result['values']);
 336     $this->assertArrayNotHasKey('custom_' . $idsContact['custom_field_id'], $result['values']);
 337     $this->customFieldDelete($ids['custom_field_id']);
 338     $this->customGroupDelete($ids['custom_group_id']);
 339     $this->customFieldDelete($idsContact['custom_field_id']);
 340     $this->customGroupDelete($idsContact['custom_group_id']);
 341   }
 342
 343   public function testCreateContributionNoLineItems() {
 344
 345     $params = array(
 346       'contact_id' => $this->_individualId,
 347       'receive_date' => '20120511',
 348       'total_amount' => 100.00,
 349       'financial_type_id' => $this->_financialTypeId,
 350       'payment_instrument_id' => 1,
 351       'non_deductible_amount' => 10.00,
 352       'fee_amount' => 50.00,
 353       'net_amount' => 90.00,
 354       'trxn_id' => 12345,
 355       'invoice_id' => 67890,
 356       'source' => 'SSF',
 357       'contribution_status_id' => 1,
 358       'skipLineItem' => 1,
 359     );
 360
 361     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 362     $lineItems = $this->callAPISuccess('line_item', 'get', array(
 363       'entity_id' => $contribution['id'],
 364       'entity_table' => 'civicrm_contribution',
 365       'sequential' => 1,
 366     ));
 367     $this->assertEquals(0, $lineItems['count']);
 368   }
 369
 370   /**
 371    * Test checks that passing in line items suppresses the create mechanism.
 372    */
 373   public function testCreateContributionChainedLineItems() {
 374     $params = array(
 375       'contact_id' => $this->_individualId,
 376       'receive_date' => '20120511',
 377       'total_amount' => 100.00,
 378       'financial_type_id' => $this->_financialTypeId,
 379       'payment_instrument_id' => 1,
 380       'non_deductible_amount' => 10.00,
 381       'fee_amount' => 50.00,
 382       'net_amount' => 90.00,
 383       'trxn_id' => 12345,
 384       'invoice_id' => 67890,
 385       'source' => 'SSF',
 386       'contribution_status_id' => 1,
 387       'skipLineItem' => 1,
 388       'api.line_item.create' => array(
 389         array(
 390           'price_field_id' => 1,
 391           'qty' => 2,
 392           'line_total' => '20',
 393           'unit_price' => '10',
 394         ),
 395         array(
 396           'price_field_id' => 1,
 397           'qty' => 1,
 398           'line_total' => '80',
 399           'unit_price' => '80',
 400         ),
 401       ),
 402     );
 403
 404     $description = "Create Contribution with Nested Line Items.";
 405     $subfile = "CreateWithNestedLineItems";
 406     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 407
 408     $lineItems = $this->callAPISuccess('line_item', 'get', array(
 409       'entity_id' => $contribution['id'],
 410       'contribution_id' => $contribution['id'],
 411       'entity_table' => 'civicrm_contribution',
 412       'sequential' => 1,
 413     ));
 414     $this->assertEquals(2, $lineItems['count']);
 415   }
 416
 417   public function testCreateContributionOffline() {
 418     $params = array(
 419       'contact_id' => $this->_individualId,
 420       'receive_date' => '20120511',
 421       'total_amount' => 100.00,
 422       'financial_type_id' => 1,
 423       'trxn_id' => 12345,
 424       'invoice_id' => 67890,
 425       'source' => 'SSF',
 426       'contribution_status_id' => 1,
 427     );
 428
 429     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
 430     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 431     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 432     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 433     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
 434     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
 435     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 436     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
 437     $lineItems = $this->callAPISuccess('line_item', 'get', array(
 438       'entity_id' => $contribution['id'],
 439       'contribution_id' => $contribution['id'],
 440       'entity_table' => 'civicrm_contribution',
 441       'sequential' => 1,
 442     ));
 443     $this->assertEquals(1, $lineItems['count']);
 444     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 445     $this->assertEquals($contribution['id'], $lineItems['values'][0]['contribution_id']);
 446     $this->_checkFinancialRecords($contribution, 'offline');
 447     $this->contributionGetnCheck($params, $contribution['id']);
 448   }
 449
 450   /**
 451    * Test create with valid payment instrument.
 452    */
 453   public function testCreateContributionWithPaymentInstrument() {
 454     $params = $this->_params + array('payment_instrument' => 'EFT');
 455     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 456     $contribution = $this->callAPISuccess('contribution', 'get', array(
 457       'sequential' => 1,
 458       'id' => $contribution['id'],
 459     ));
 460     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 461     $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
 462
 463     $this->callAPISuccess('contribution', 'create', array(
 464       'id' => $contribution['id'],
 465       'payment_instrument' => 'Credit Card',
 466     ));
 467     $contribution = $this->callAPISuccess('contribution', 'get', array(
 468       'sequential' => 1,
 469       'id' => $contribution['id'],
 470     ));
 471     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 472     $this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
 473   }
 474
 475   public function testGetContributionByPaymentInstrument() {
 476     $params = $this->_params + array('payment_instrument' => 'EFT');
 477     $params2 = $this->_params + array('payment_instrument' => 'Cash');
 478     $this->callAPISuccess('contribution', 'create', $params);
 479     $this->callAPISuccess('contribution', 'create', $params2);
 480     $contribution = $this->callAPISuccess('contribution', 'get', array(
 481       'sequential' => 1,
 482       'contribution_payment_instrument' => 'Cash',
 483     ));
 484     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 485     $this->assertEquals('Cash', $contribution['values'][0]['payment_instrument']);
 486     $this->assertEquals(1, $contribution['count']);
 487     $contribution = $this->callAPISuccess('contribution', 'get', array('sequential' => 1, 'payment_instrument' => 'Cash'));
 488     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 489     $this->assertEquals('Cash', $contribution['values'][0]['payment_instrument']);
 490     $this->assertEquals(1, $contribution['count']);
 491     $contribution = $this->callAPISuccess('contribution', 'get', array(
 492       'sequential' => 1,
 493       'payment_instrument_id' => 5,
 494     ));
 495     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 496     $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
 497     $this->assertEquals(1, $contribution['count']);
 498     $contribution = $this->callAPISuccess('contribution', 'get', array(
 499       'sequential' => 1,
 500       'payment_instrument' => 'EFT',
 501     ));
 502     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 503     $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
 504     $this->assertEquals(1, $contribution['count']);
 505     $contribution = $this->callAPISuccess('contribution', 'create', array(
 506       'id' => $contribution['id'],
 507       'payment_instrument' => 'Credit Card',
 508     ));
 509     $contribution = $this->callAPISuccess('contribution', 'get', array('sequential' => 1, 'id' => $contribution['id']));
 510     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 511     $this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
 512     $this->assertEquals(1, $contribution['count']);
 513   }
 514
 515   /**
 516    * CRM-16227 introduces invoice_id as a parameter.
 517    */
 518   public function testGetContributionByInvoice() {
 519     $this->callAPISuccess('Contribution', 'create', array_merge($this->_params, array('invoice_id' => 'curly')));
 520     $this->callAPISuccess('Contribution', 'create', array_merge($this->_params), array('invoice_id' => 'churlish'));
 521     $this->callAPISuccessGetCount('Contribution', array(), 2);
 522     $this->callAPISuccessGetSingle('Contribution', array('invoice_id' => 'curly'));
 523     // The following don't work. They are the format we are trying to introduce but although the form uses this format
 524     // CRM_Contact_BAO_Query::convertFormValues puts them into the other format & the where only supports that.
 525     // ideally the where clause would support this format (as it does on contact_BAO_Query) and those lines would
 526     // come out of convertFormValues
 527     // $this->callAPISuccessGetSingle('Contribution', array('invoice_id' => array('LIKE' => '%ish%')));
 528     // $this->callAPISuccessGetSingle('Contribution', array('invoice_id' => array('NOT IN' => array('curly'))));
 529     // $this->callAPISuccessGetCount('Contribution', array('invoice_id' => array('LIKE' => '%ly%')), 2);
 530     // $this->callAPISuccessGetCount('Contribution', array('invoice_id' => array('IN' => array('curly', 'churlish'))),
 531     // 2);
 532   }
 533
 534   /**
 535    * Create test with unique field name on source.
 536    */
 537   public function testCreateContributionSource() {
 538
 539     $params = array(
 540       'contact_id' => $this->_individualId,
 541       'receive_date' => date('Ymd'),
 542       'total_amount' => 100.00,
 543       'financial_type_id' => $this->_financialTypeId,
 544       'payment_instrument_id' => 1,
 545       'non_deductible_amount' => 10.00,
 546       'fee_amount' => 50.00,
 547       'net_amount' => 90.00,
 548       'trxn_id' => 12345,
 549       'invoice_id' => 67890,
 550       'contribution_source' => 'SSF',
 551       'contribution_status_id' => 1,
 552     );
 553
 554     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 555     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 556     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 557   }
 558
 559   /**
 560    * Create test with unique field name on source.
 561    */
 562   public function testCreateDefaultNow() {
 563
 564     $params = $this->_params;
 565     unset($params['receive_date']);
 566
 567     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 568     $contribution = $this->callAPISuccessGetSingle('contribution', array('id' => $contribution['id']));
 569     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receive_date'])));
 570   }
 571
 572   /**
 573    * Create test with unique field name on source.
 574    */
 575   public function testCreateContributionSourceInvalidContact() {
 576
 577     $params = array(
 578       'contact_id' => 999,
 579       'receive_date' => date('Ymd'),
 580       'total_amount' => 100.00,
 581       'financial_type_id' => $this->_financialTypeId,
 582       'payment_instrument_id' => 1,
 583       'non_deductible_amount' => 10.00,
 584       'fee_amount' => 50.00,
 585       'net_amount' => 90.00,
 586       'trxn_id' => 12345,
 587       'invoice_id' => 67890,
 588       'contribution_source' => 'SSF',
 589       'contribution_status_id' => 1,
 590     );
 591
 592     $this->callAPIFailure('contribution', 'create', $params, 'contact_id is not valid : 999');
 593   }
 594
 595   public function testCreateContributionSourceInvalidContContact() {
 596
 597     $params = array(
 598       'contribution_contact_id' => 999,
 599       'receive_date' => date('Ymd'),
 600       'total_amount' => 100.00,
 601       'financial_type_id' => $this->_financialTypeId,
 602       'payment_instrument_id' => 1,
 603       'non_deductible_amount' => 10.00,
 604       'fee_amount' => 50.00,
 605       'net_amount' => 90.00,
 606       'trxn_id' => 12345,
 607       'invoice_id' => 67890,
 608       'contribution_source' => 'SSF',
 609       'contribution_status_id' => 1,
 610     );
 611
 612     $this->callAPIFailure('contribution', 'create', $params, 'contact_id is not valid : 999');
 613   }
 614
 615   /**
 616    * Test note created correctly.
 617    */
 618   public function testCreateContributionWithNote() {
 619     $description = "Demonstrates creating contribution with Note Entity.";
 620     $subfile = "ContributionCreateWithNote";
 621     $params = array(
 622       'contact_id' => $this->_individualId,
 623       'receive_date' => '2012-01-01',
 624       'total_amount' => 100.00,
 625       'financial_type_id' => $this->_financialTypeId,
 626       'payment_instrument_id' => 1,
 627       'non_deductible_amount' => 10.00,
 628       'fee_amount' => 50.00,
 629       'net_amount' => 90.00,
 630       'trxn_id' => 12345,
 631       'invoice_id' => 67890,
 632       'source' => 'SSF',
 633       'contribution_status_id' => 1,
 634       'note' => 'my contribution note',
 635     );
 636
 637     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 638     $result = $this->callAPISuccess('note', 'get', array(
 639       'entity_table' => 'civicrm_contribution',
 640       'entity_id' => $contribution['id'],
 641       'sequential' => 1,
 642     ));
 643     $this->assertEquals('my contribution note', $result['values'][0]['note']);
 644     $this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id']));
 645   }
 646
 647   public function testCreateContributionWithNoteUniqueNameAliases() {
 648     $params = array(
 649       'contact_id' => $this->_individualId,
 650       'receive_date' => '2012-01-01',
 651       'total_amount' => 100.00,
 652       'financial_type_id' => $this->_financialTypeId,
 653       'payment_instrument_id' => 1,
 654       'non_deductible_amount' => 10.00,
 655       'fee_amount' => 50.00,
 656       'net_amount' => 90.00,
 657       'trxn_id' => 12345,
 658       'invoice_id' => 67890,
 659       'source' => 'SSF',
 660       'contribution_status_id' => 1,
 661       'contribution_note' => 'my contribution note',
 662     );
 663
 664     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 665     $result = $this->callAPISuccess('note', 'get', array(
 666       'entity_table' => 'civicrm_contribution',
 667       'entity_id' => $contribution['id'],
 668       'sequential' => 1,
 669     ));
 670     $this->assertEquals('my contribution note', $result['values'][0]['note']);
 671     $this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id']));
 672   }
 673
 674   /**
 675    * This is the test for creating soft credits.
 676    */
 677   public function testCreateContributionWithSoftCredit() {
 678     $description = "Demonstrates creating contribution with SoftCredit.";
 679     $subfile = "ContributionCreateWithSoftCredit";
 680     $contact2 = $this->callAPISuccess('Contact', 'create', array(
 681       'display_name' => 'superman',
 682       'contact_type' => 'Individual',
 683     ));
 684     $softParams = array(
 685       'contact_id' => $contact2['id'],
 686       'amount' => 50,
 687       'soft_credit_type_id' => 3,
 688     );
 689
 690     $params = $this->_params + array('soft_credit' => array(1 => $softParams));
 691     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 692     $result = $this->callAPISuccess('contribution', 'get', array('return' => 'soft_credit', 'sequential' => 1));
 693
 694     $this->assertEquals($softParams['contact_id'], $result['values'][0]['soft_credit'][1]['contact_id']);
 695     $this->assertEquals($softParams['amount'], $result['values'][0]['soft_credit'][1]['amount']);
 696     $this->assertEquals($softParams['soft_credit_type_id'], $result['values'][0]['soft_credit'][1]['soft_credit_type']);
 697
 698     $this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id']));
 699     $this->callAPISuccess('contact', 'delete', array('id' => $contact2['id']));
 700   }
 701
 702   public function testCreateContributionWithSoftCreditDefaults() {
 703     $description = "Demonstrates creating contribution with Soft Credit defaults for amount and type.";
 704     $subfile = "ContributionCreateWithSoftCreditDefaults";
 705     $contact2 = $this->callAPISuccess('Contact', 'create', array(
 706       'display_name' => 'superman',
 707       'contact_type' => 'Individual',
 708     ));
 709     $params = $this->_params + array(
 710       'soft_credit_to' => $contact2['id'],
 711     );
 712     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 713     $result = $this->callAPISuccess('contribution', 'get', array('return' => 'soft_credit', 'sequential' => 1));
 714
 715     $this->assertEquals($contact2['id'], $result['values'][0]['soft_credit'][1]['contact_id']);
 716     // Default soft credit amount = contribution.total_amount
 717     $this->assertEquals($this->_params['total_amount'], $result['values'][0]['soft_credit'][1]['amount']);
 718     $this->assertEquals(CRM_Core_OptionGroup::getDefaultValue("soft_credit_type"), $result['values'][0]['soft_credit'][1]['soft_credit_type']);
 719
 720     $this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id']));
 721     $this->callAPISuccess('contact', 'delete', array('id' => $contact2['id']));
 722   }
 723
 724   public function testCreateContributionWithHonoreeContact() {
 725     $description = "Demonstrates creating contribution with Soft Credit by passing in honor_contact_id.";
 726     $subfile = "ContributionCreateWithHonoreeContact";
 727     $contact2 = $this->callAPISuccess('Contact', 'create', array(
 728       'display_name' => 'superman',
 729       'contact_type' => 'Individual',
 730     ));
 731     $params = $this->_params + array(
 732       'honor_contact_id' => $contact2['id'],
 733     );
 734     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 735     $result = $this->callAPISuccess('contribution', 'get', array('return' => 'soft_credit', 'sequential' => 1));
 736
 737     $this->assertEquals($contact2['id'], $result['values'][0]['soft_credit'][1]['contact_id']);
 738     // Default soft credit amount = contribution.total_amount
 739     // Legacy mode in create api (honor_contact_id param) uses the standard "In Honor of" soft credit type
 740     $this->assertEquals($this->_params['total_amount'], $result['values'][0]['soft_credit'][1]['amount']);
 741     $this->assertEquals(CRM_Core_OptionGroup::getValue('soft_credit_type', 'in_honor_of', 'name'), $result['values'][0]['soft_credit'][1]['soft_credit_type']);
 742
 743     $this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id']));
 744     $this->callAPISuccess('contact', 'delete', array('id' => $contact2['id']));
 745   }
 746
 747   /**
 748    * Test using example code.
 749    */
 750   public function testContributionCreateExample() {
 751     //make sure at least on page exists since there is a truncate in tear down
 752     $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
 753     require_once 'api/v3/examples/Contribution/Create.php';
 754     $result = contribution_create_example();
 755     $id = $result['id'];
 756     $expectedResult = contribution_create_expectedresult();
 757     $this->checkArrayEquals($expectedResult, $result);
 758     $this->contributionDelete($id);
 759   }
 760
 761   /**
 762    * Function tests that additional financial records are created when fee amount is recorded.
 763    */
 764   public function testCreateContributionWithFee() {
 765     $params = array(
 766       'contact_id' => $this->_individualId,
 767       'receive_date' => '20120511',
 768       'total_amount' => 100.00,
 769       'fee_amount' => 50,
 770       'financial_type_id' => 1,
 771       'trxn_id' => 12345,
 772       'invoice_id' => 67890,
 773       'source' => 'SSF',
 774       'contribution_status_id' => 1,
 775     );
 776
 777     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
 778     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 779     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 780     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 50.00);
 781     $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 50.00);
 782     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 783     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
 784     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
 785     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 786     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
 787
 788     $lineItems = $this->callAPISuccess('line_item', 'get', array(
 789
 790       'entity_id' => $contribution['id'],
 791       'entity_table' => 'civicrm_contribution',
 792       'sequential' => 1,
 793     ));
 794     $this->assertEquals(1, $lineItems['count']);
 795     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 796     $this->assertEquals($contribution['id'], $lineItems['values'][0]['contribution_id']);
 797     $lineItems = $this->callAPISuccess('line_item', 'get', array(
 798
 799       'entity_id' => $contribution['id'],
 800       'contribution_id' => $contribution['id'],
 801       'entity_table' => 'civicrm_contribution',
 802       'sequential' => 1,
 803     ));
 804     $this->assertEquals(1, $lineItems['count']);
 805     $this->_checkFinancialRecords($contribution, 'feeAmount');
 806   }
 807
 808
 809   /**
 810    * Function tests that additional financial records are created when online contribution is created.
 811    */
 812   public function testCreateContributionOnline() {
 813     CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 814     $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
 815     $this->assertAPISuccess($contributionPage);
 816     $params = array(
 817       'contact_id' => $this->_individualId,
 818       'receive_date' => '20120511',
 819       'total_amount' => 100.00,
 820       'financial_type_id' => 1,
 821       'contribution_page_id' => $contributionPage['id'],
 822       'payment_processor' => 1,
 823       'trxn_id' => 12345,
 824       'invoice_id' => 67890,
 825       'source' => 'SSF',
 826       'contribution_status_id' => 1,
 827
 828     );
 829
 830     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
 831     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 832     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 833     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 834     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
 835     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
 836     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 837     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
 838     $this->_checkFinancialRecords($contribution, 'online');
 839   }
 840
 841   /**
 842    * Check handling of financial type.
 843    *
 844    * In the interests of removing financial type / contribution type checks from
 845    * legacy format function lets test that the api is doing this for us
 846    */
 847   public function testCreateInvalidFinancialType() {
 848     $params = $this->_params;
 849     $params['financial_type_id'] = 99999;
 850     $this->callAPIFailure($this->_entity, 'create', $params, "'99999' is not a valid option for field financial_type_id");
 851   }
 852
 853   /**
 854    * Check handling of financial type.
 855    *
 856    * In the interests of removing financial type / contribution type checks from
 857    * legacy format function lets test that the api is doing this for us
 858    */
 859   public function testValidNamedFinancialType() {
 860     $params = $this->_params;
 861     $params['financial_type_id'] = 'Donation';
 862     $this->callAPISuccess($this->_entity, 'create', $params);
 863   }
 864
 865   /**
 866    * Tests that additional financial records are created.
 867    *
 868    * Checks when online contribution with pay later option is created
 869    */
 870   public function testCreateContributionPayLaterOnline() {
 871     CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 872     $this->_pageParams['is_pay_later'] = 1;
 873     $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
 874     $this->assertAPISuccess($contributionPage);
 875     $params = array(
 876       'contact_id' => $this->_individualId,
 877       'receive_date' => '20120511',
 878       'total_amount' => 100.00,
 879       'financial_type_id' => 1,
 880       'contribution_page_id' => $contributionPage['id'],
 881       'trxn_id' => 12345,
 882       'is_pay_later' => 1,
 883       'invoice_id' => 67890,
 884       'source' => 'SSF',
 885       'contribution_status_id' => 2,
 886
 887     );
 888
 889     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
 890     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 891     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 892     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 893     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
 894     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
 895     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 896     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 2);
 897     $this->_checkFinancialRecords($contribution, 'payLater');
 898   }
 899
 900   /**
 901    * Function tests that additional financial records are created for online contribution with pending option.
 902    */
 903   public function testCreateContributionPendingOnline() {
 904     $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 905     $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
 906     $this->assertAPISuccess($contributionPage);
 907     $params = array(
 908       'contact_id' => $this->_individualId,
 909       'receive_date' => '20120511',
 910       'total_amount' => 100.00,
 911       'financial_type_id' => 1,
 912       'contribution_page_id' => $contributionPage['id'],
 913       'trxn_id' => 12345,
 914       'invoice_id' => 67890,
 915       'source' => 'SSF',
 916       'contribution_status_id' => 2,
 917     );
 918
 919     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
 920     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 921     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 922     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 923     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
 924     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
 925     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 926     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 2);
 927     $this->_checkFinancialRecords($contribution, 'pending');
 928   }
 929
 930   /**
 931    * Test that BAO defaults work.
 932    */
 933   public function testCreateBAODefaults() {
 934     unset($this->_params['contribution_source_id'], $this->_params['payment_instrument_id']);
 935     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
 936     $contribution = $this->callAPISuccess('contribution', 'getsingle', array(
 937       'id' => $contribution['id'],
 938       'api.contribution.delete' => 1,
 939     ));
 940     $this->assertEquals(1, $contribution['contribution_status_id']);
 941     $this->assertEquals('Check', $contribution['payment_instrument']);
 942   }
 943
 944   /**
 945    * Function tests that line items, financial records are updated when contribution amount is changed.
 946    */
 947   public function testCreateUpdateContributionChangeTotal() {
 948     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
 949     $lineItems = $this->callAPISuccess('line_item', 'getvalue', array(
 950
 951       'entity_id' => $contribution['id'],
 952       'entity_table' => 'civicrm_contribution',
 953       'sequential' => 1,
 954       'return' => 'line_total',
 955     ));
 956     $this->assertEquals('100.00', $lineItems);
 957     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
 958     // Financial trxn SUM = 100 + 5 (fee)
 959     $this->assertEquals('105.00', $trxnAmount);
 960     $newParams = array(
 961
 962       'id' => $contribution['id'],
 963       'total_amount' => '125',
 964     );
 965     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
 966
 967     $lineItems = $this->callAPISuccess('line_item', 'getvalue', array(
 968
 969       'entity_id' => $contribution['id'],
 970       'entity_table' => 'civicrm_contribution',
 971       'sequential' => 1,
 972       'return' => 'line_total',
 973     ));
 974
 975     $this->assertEquals('125.00', $lineItems);
 976     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
 977
 978     // Financial trxn SUM = 125 + 5 (fee).
 979     $this->assertEquals('130.00', $trxnAmount);
 980     $this->assertEquals('125.00', $this->_getFinancialItemAmount($contribution['id']));
 981   }
 982
 983   /**
 984    * Function tests that line items, financial records are updated when pay later contribution is received.
 985    */
 986   public function testCreateUpdateContributionPayLater() {
 987     $contribParams = array(
 988       'contact_id' => $this->_individualId,
 989       'receive_date' => '2012-01-01',
 990       'total_amount' => 100.00,
 991       'financial_type_id' => $this->_financialTypeId,
 992       'payment_instrument_id' => 1,
 993       'contribution_status_id' => 2,
 994       'is_pay_later' => 1,
 995
 996     );
 997     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
 998
 999     $newParams = array_merge($contribParams, array(
1000         'id' => $contribution['id'],
1001         'contribution_status_id' => 1,
1002       )
1003     );
1004     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1005     $contribution = $contribution['values'][$contribution['id']];
1006     $this->assertEquals($contribution['contribution_status_id'], '1');
1007     $this->_checkFinancialItem($contribution['id'], 'paylater');
1008     $this->_checkFinancialTrxn($contribution, 'payLater');
1009   }
1010
1011   /**
1012    * Function tests that financial records are updated when Payment Instrument is changed.
1013    */
1014   public function testCreateUpdateContributionPaymentInstrument() {
1015     $instrumentId = $this->_addPaymentInstrument();
1016     $contribParams = array(
1017       'contact_id' => $this->_individualId,
1018       'total_amount' => 100.00,
1019       'financial_type_id' => $this->_financialTypeId,
1020       'payment_instrument_id' => 4,
1021       'contribution_status_id' => 1,
1022
1023     );
1024     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1025
1026     $newParams = array_merge($contribParams, array(
1027         'id' => $contribution['id'],
1028         'payment_instrument_id' => $instrumentId,
1029       )
1030     );
1031     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1032     $this->assertAPISuccess($contribution);
1033     $this->_checkFinancialTrxn($contribution, 'paymentInstrument', $instrumentId);
1034   }
1035
1036   /**
1037    * Function tests that financial records are added when Contribution is Refunded.
1038    */
1039   public function testCreateUpdateContributionRefund() {
1040     $contribParams = array(
1041       'contact_id' => $this->_individualId,
1042       'receive_date' => '2012-01-01',
1043       'total_amount' => 100.00,
1044       'financial_type_id' => $this->_financialTypeId,
1045       'payment_instrument_id' => 4,
1046       'contribution_status_id' => 1,
1047
1048     );
1049     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1050     $newParams = array_merge($contribParams, array(
1051         'id' => $contribution['id'],
1052         'contribution_status_id' => 'Refunded',
1053         'cancel_date' => '2015-01-01 09:00',
1054       )
1055     );
1056
1057     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1058     $this->_checkFinancialTrxn($contribution, 'refund');
1059     $this->_checkFinancialItem($contribution['id'], 'refund');
1060   }
1061
1062   /**
1063    * Function tests invalid contribution status change.
1064    */
1065   public function testCreateUpdateContributionInValidStatusChange() {
1066     $contribParams = array(
1067       'contact_id' => 1,
1068       'receive_date' => '2012-01-01',
1069       'total_amount' => 100.00,
1070       'financial_type_id' => 1,
1071       'payment_instrument_id' => 1,
1072       'contribution_status_id' => 1,
1073     );
1074     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1075     $newParams = array_merge($contribParams, array(
1076         'id' => $contribution['id'],
1077         'contribution_status_id' => 2,
1078       )
1079     );
1080     $this->callAPIFailure('contribution', 'create', $newParams, ts('Cannot change contribution status from Completed to Pending.'));
1081
1082   }
1083
1084   /**
1085    * Function tests that financial records are added when Pending Contribution is Canceled.
1086    */
1087   public function testCreateUpdateContributionCancelPending() {
1088     $contribParams = array(
1089       'contact_id' => $this->_individualId,
1090       'receive_date' => '2012-01-01',
1091       'total_amount' => 100.00,
1092       'financial_type_id' => $this->_financialTypeId,
1093       'payment_instrument_id' => 1,
1094       'contribution_status_id' => 2,
1095       'is_pay_later' => 1,
1096
1097     );
1098     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1099     $newParams = array_merge($contribParams, array(
1100         'id' => $contribution['id'],
1101         'contribution_status_id' => 3,
1102       )
1103     );
1104     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1105     $this->_checkFinancialTrxn($contribution, 'cancelPending');
1106     $this->_checkFinancialItem($contribution['id'], 'cancelPending');
1107   }
1108
1109   /**
1110    * Function tests that financial records are added when Financial Type is Changed.
1111    */
1112   public function testCreateUpdateContributionChangeFinancialType() {
1113     $contribParams = array(
1114       'contact_id' => $this->_individualId,
1115       'receive_date' => '2012-01-01',
1116       'total_amount' => 100.00,
1117       'financial_type_id' => 1,
1118       'payment_instrument_id' => 1,
1119       'contribution_status_id' => 1,
1120
1121     );
1122     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1123     $newParams = array_merge($contribParams, array(
1124         'id' => $contribution['id'],
1125         'financial_type_id' => 3,
1126       )
1127     );
1128     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1129     $this->_checkFinancialTrxn($contribution, 'changeFinancial');
1130     $this->_checkFinancialItem($contribution['id'], 'changeFinancial');
1131   }
1132
1133   /**
1134    * Test that update does not change status id CRM-15105.
1135    */
1136   public function testCreateUpdateWithoutChangingPendingStatus() {
1137     $contribution = $this->callAPISuccess('contribution', 'create', array_merge($this->_params, array('contribution_status_id' => 2)));
1138     $this->callAPISuccess('contribution', 'create', array('id' => $contribution['id'], 'source' => 'new source'));
1139     $contribution = $this->callAPISuccess('contribution', 'getsingle', array(
1140       'id' => $contribution['id'],
1141       'api.contribution.delete' => 1,
1142     ));
1143     $this->assertEquals(2, $contribution['contribution_status_id']);
1144   }
1145
1146   /**
1147    * Test Updating a Contribution.
1148    *
1149    * CHANGE: we require the API to do an incremental update
1150    */
1151   public function testCreateUpdateContribution() {
1152
1153     $contributionID = $this->contributionCreate(array(
1154       'contact_id' => $this->_individualId,
1155       'trxn_id' => 212355,
1156       'financial_type_id' => $this->_financialTypeId,
1157       'invoice_id' => 'old_invoice',
1158     ));
1159     $old_params = array(
1160       'contribution_id' => $contributionID,
1161     );
1162     $original = $this->callAPISuccess('contribution', 'get', $old_params);
1163     $this->assertEquals($original['id'], $contributionID);
1164     //set up list of old params, verify
1165
1166     //This should not be required on update:
1167     $old_contact_id = $original['values'][$contributionID]['contact_id'];
1168     $old_payment_instrument = $original['values'][$contributionID]['instrument_id'];
1169     $old_fee_amount = $original['values'][$contributionID]['fee_amount'];
1170     $old_source = $original['values'][$contributionID]['contribution_source'];
1171
1172     $old_trxn_id = $original['values'][$contributionID]['trxn_id'];
1173     $old_invoice_id = $original['values'][$contributionID]['invoice_id'];
1174
1175     //check against values in CiviUnitTestCase::createContribution()
1176     $this->assertEquals($old_contact_id, $this->_individualId);
1177     $this->assertEquals($old_fee_amount, 5.00);
1178     $this->assertEquals($old_source, 'SSF');
1179     $this->assertEquals($old_trxn_id, 212355);
1180     $this->assertEquals($old_invoice_id, 'old_invoice');
1181     $params = array(
1182       'id' => $contributionID,
1183       'contact_id' => $this->_individualId,
1184       'total_amount' => 110.00,
1185       'financial_type_id' => $this->_financialTypeId,
1186       'non_deductible_amount' => 10.00,
1187       'net_amount' => 100.00,
1188       'contribution_status_id' => 1,
1189       'note' => 'Donating for Nobel Cause',
1190
1191     );
1192
1193     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1194
1195     $new_params = array(
1196       'contribution_id' => $contribution['id'],
1197
1198     );
1199     $contribution = $this->callAPISuccess('contribution', 'get', $new_params);
1200
1201     $this->assertEquals($contribution['values'][$contributionID]['contact_id'], $this->_individualId);
1202     $this->assertEquals($contribution['values'][$contributionID]['total_amount'], 110.00);
1203     $this->assertEquals($contribution['values'][$contributionID]['financial_type_id'], $this->_financialTypeId);
1204     $this->assertEquals($contribution['values'][$contributionID]['instrument_id'], $old_payment_instrument);
1205     $this->assertEquals($contribution['values'][$contributionID]['non_deductible_amount'], 10.00);
1206     $this->assertEquals($contribution['values'][$contributionID]['fee_amount'], $old_fee_amount);
1207     $this->assertEquals($contribution['values'][$contributionID]['net_amount'], 100.00);
1208     $this->assertEquals($contribution['values'][$contributionID]['trxn_id'], $old_trxn_id);
1209     $this->assertEquals($contribution['values'][$contributionID]['invoice_id'], $old_invoice_id);
1210     $this->assertEquals($contribution['values'][$contributionID]['contribution_source'], $old_source);
1211     $this->assertEquals($contribution['values'][$contributionID]['contribution_status'], 'Completed');
1212     $params = array(
1213       'contribution_id' => $contributionID,
1214
1215     );
1216     $result = $this->callAPISuccess('contribution', 'delete', $params);
1217     $this->assertAPISuccess($result);
1218   }
1219
1220   ///////////////// civicrm_contribution_delete methods
1221
1222   /**
1223    * Attempt (but fail) to delete a contribution without parameters.
1224    */
1225   public function testDeleteEmptyParamsContribution() {
1226     $params = array();
1227     $this->callAPIFailure('contribution', 'delete', $params);
1228   }
1229
1230   public function testDeleteParamsNotArrayContribution() {
1231     $params = 'contribution_id= 1';
1232     $contribution = $this->callAPIFailure('contribution', 'delete', $params);
1233     $this->assertEquals($contribution['error_message'], 'Input variable `params` is not an array');
1234   }
1235
1236   public function testDeleteWrongParamContribution() {
1237     $params = array(
1238       'contribution_source' => 'SSF',
1239
1240     );
1241     $this->callAPIFailure('contribution', 'delete', $params);
1242   }
1243
1244   public function testDeleteContribution() {
1245     $contributionID = $this->contributionCreate(array(
1246       'contact_id' => $this->_individualId,
1247       'financial_type_id' => $this->_financialTypeId,
1248     ));
1249     $params = array(
1250       'id' => $contributionID,
1251     );
1252     $this->callAPIAndDocument('contribution', 'delete', $params, __FUNCTION__, __FILE__);
1253   }
1254
1255   /**
1256    * Test civicrm_contribution_search with empty params.
1257    *
1258    * All available contributions expected.
1259    */
1260   public function testSearchEmptyParams() {
1261     $params = array();
1262
1263     $p = array(
1264       'contact_id' => $this->_individualId,
1265       'receive_date' => date('Ymd'),
1266       'total_amount' => 100.00,
1267       'financial_type_id' => $this->_financialTypeId,
1268       'non_deductible_amount' => 10.00,
1269       'fee_amount' => 5.00,
1270       'net_amount' => 95.00,
1271       'trxn_id' => 23456,
1272       'invoice_id' => 78910,
1273       'source' => 'SSF',
1274       'contribution_status_id' => 1,
1275
1276     );
1277     $contribution = $this->callAPISuccess('contribution', 'create', $p);
1278
1279     $result = $this->callAPISuccess('contribution', 'get', $params);
1280     // We're taking the first element.
1281     $res = $result['values'][$contribution['id']];
1282
1283     $this->assertEquals($p['contact_id'], $res['contact_id']);
1284     $this->assertEquals($p['total_amount'], $res['total_amount']);
1285     $this->assertEquals($p['financial_type_id'], $res['financial_type_id']);
1286     $this->assertEquals($p['net_amount'], $res['net_amount']);
1287     $this->assertEquals($p['non_deductible_amount'], $res['non_deductible_amount']);
1288     $this->assertEquals($p['fee_amount'], $res['fee_amount']);
1289     $this->assertEquals($p['trxn_id'], $res['trxn_id']);
1290     $this->assertEquals($p['invoice_id'], $res['invoice_id']);
1291     $this->assertEquals($p['source'], $res['contribution_source']);
1292     // contribution_status_id = 1 => Completed
1293     $this->assertEquals('Completed', $res['contribution_status']);
1294
1295     $this->contributionDelete($contribution['id']);
1296   }
1297
1298   /**
1299    * Test civicrm_contribution_search. Success expected.
1300    */
1301   public function testSearch() {
1302     $p1 = array(
1303       'contact_id' => $this->_individualId,
1304       'receive_date' => date('Ymd'),
1305       'total_amount' => 100.00,
1306       'financial_type_id' => $this->_financialTypeId,
1307       'non_deductible_amount' => 10.00,
1308       'contribution_status_id' => 1,
1309
1310     );
1311     $contribution1 = $this->callAPISuccess('contribution', 'create', $p1);
1312
1313     $p2 = array(
1314       'contact_id' => $this->_individualId,
1315       'receive_date' => date('Ymd'),
1316       'total_amount' => 200.00,
1317       'financial_type_id' => $this->_financialTypeId,
1318       'non_deductible_amount' => 20.00,
1319       'trxn_id' => 5454565,
1320       'invoice_id' => 1212124,
1321       'fee_amount' => 50.00,
1322       'net_amount' => 60.00,
1323       'contribution_status_id' => 2,
1324
1325     );
1326     $contribution2 = $this->callAPISuccess('contribution', 'create', $p2);
1327
1328     $params = array(
1329       'contribution_id' => $contribution2['id'],
1330
1331     );
1332     $result = $this->callAPISuccess('contribution', 'get', $params);
1333     $res = $result['values'][$contribution2['id']];
1334
1335     $this->assertEquals($p2['contact_id'], $res['contact_id']);
1336     $this->assertEquals($p2['total_amount'], $res['total_amount']);
1337     $this->assertEquals($p2['financial_type_id'], $res['financial_type_id']);
1338     $this->assertEquals($p2['net_amount'], $res['net_amount']);
1339     $this->assertEquals($p2['non_deductible_amount'], $res['non_deductible_amount']);
1340     $this->assertEquals($p2['fee_amount'], $res['fee_amount']);
1341     $this->assertEquals($p2['trxn_id'], $res['trxn_id']);
1342     $this->assertEquals($p2['invoice_id'], $res['invoice_id']);
1343     // contribution_status_id = 2 => Pending
1344     $this->assertEquals('Pending', $res['contribution_status']);
1345
1346     $this->contributionDelete($contribution1['id']);
1347     $this->contributionDelete($contribution2['id']);
1348   }
1349
1350   /**
1351    * Test completing a transaction via the API.
1352    *
1353    * Note that we are creating a logged in user because email goes out from
1354    * that person
1355    */
1356   public function testCompleteTransaction() {
1357     $mut = new CiviMailUtils($this, TRUE);
1358     $this->createLoggedInUser();
1359     $params = array_merge($this->_params, array('contribution_status_id' => 2));
1360     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1361     $this->callAPISuccess('contribution', 'completetransaction', array(
1362       'id' => $contribution['id'],
1363     ));
1364     $contribution = $this->callAPISuccess('contribution', 'get', array('id' => $contribution['id'], 'sequential' => 1));
1365     $this->assertEquals('Completed', $contribution['values'][0]['contribution_status']);
1366     $mut->checkMailLog(array(
1367       'Receipt - Contribution',
1368       'Please print this confirmation for your records.',
1369     ));
1370     $mut->stop();
1371   }
1372
1373   /**
1374    * Test completing a transaction via the API.
1375    *
1376    * Note that we are creating a logged in user because email goes out from
1377    * that person
1378    */
1379   public function testCompleteTransactionFeeAmount() {
1380     $this->createLoggedInUser();
1381     $params = array_merge($this->_params, array('contribution_status_id' => 2));
1382     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1383     $this->callAPISuccess('contribution', 'completetransaction', array(
1384       'id' => $contribution['id'],
1385       'fee_amount' => '.56',
1386       'trxn_id' => '7778888',
1387     ));
1388     $contribution = $this->callAPISuccess('contribution', 'getsingle', array('id' => $contribution['id'], 'sequential' => 1));
1389     $this->assertEquals('Completed', $contribution['contribution_status']);
1390     $this->assertEquals('7778888', $contribution['trxn_id']);
1391     $this->assertEquals('.56', $contribution['fee_amount']);
1392     $this->assertEquals('99.44', $contribution['net_amount']);
1393   }
1394
1395   /**
1396    * Test repeat contribution successfully creates line items.
1397    */
1398   public function testRepeatTransaction() {
1399     $paymentProcessorID = $this->paymentProcessorCreate();
1400     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
1401       'contact_id' => $this->_individualId,
1402       'installments' => '12',
1403       'frequency_interval' => '1',
1404       'amount' => '500',
1405       'contribution_status_id' => 1,
1406       'start_date' => '2012-01-01 00:00:00',
1407       'currency' => 'USD',
1408       'frequency_unit' => 'month',
1409       'payment_processor_id' => $paymentProcessorID,
1410     ));
1411     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
1412       $this->_params,
1413       array('contribution_recur_id' => $contributionRecur['id']))
1414     );
1415
1416     $this->callAPISuccess('contribution', 'repeattransaction', array(
1417       'original_contribution_id' => $originalContribution['id'],
1418       'contribution_status_id' => 'Completed',
1419       'trxn_id' => uniqid(),
1420     ));
1421     $lineItemParams = array(
1422       'entity_id' => $originalContribution['id'],
1423       'sequential' => 1,
1424       'return' => array(
1425         'entity_table',
1426         'qty',
1427         'unit_price',
1428         'line_total',
1429         'label',
1430         'financial_type_id',
1431         'deductible_amount',
1432         'price_field_value_id',
1433         'price_field_id',
1434       ),
1435     );
1436     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, array(
1437       'entity_id' => $originalContribution['id'],
1438     )));
1439     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, array(
1440       'entity_id' => $originalContribution['id'] + 1,
1441     )));
1442     unset($lineItem1['values'][0]['id'], $lineItem1['values'][0]['entity_id']);
1443     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
1444     $this->assertEquals($lineItem1['values'][0], $lineItem2['values'][0]);
1445
1446     $this->quickCleanUpFinancialEntities();
1447   }
1448
1449   /**
1450    * CRM-16397 test appropriate action if total amount has changed for single line items.
1451    */
1452   public function testRepeatTransactionAlteredAmount() {
1453     $paymentProcessorID = $this->paymentProcessorCreate();
1454     $campaignID = $this->campaignCreate();
1455     $campaignID2 = $this->campaignCreate();
1456     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
1457       'contact_id' => $this->_individualId,
1458       'installments' => '12',
1459       'frequency_interval' => '1',
1460       'amount' => '500',
1461       'contribution_status_id' => 1,
1462       'start_date' => '2012-01-01 00:00:00',
1463       'currency' => 'USD',
1464       'frequency_unit' => 'month',
1465       'payment_processor_id' => $paymentProcessorID,
1466     ));
1467     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
1468         $this->_params,
1469         array(
1470           'contribution_recur_id' => $contributionRecur['id'],
1471           'campaign_id' => $campaignID,
1472         ))
1473     );
1474
1475     $this->callAPISuccess('contribution', 'repeattransaction', array(
1476       'original_contribution_id' => $originalContribution['id'],
1477       'contribution_status_id' => 'Completed',
1478       'trxn_id' => uniqid(),
1479       'total_amount' => '400',
1480       'fee_amount' => 50,
1481       'campaign_id' => $campaignID2,
1482     ));
1483     $lineItemParams = array(
1484       'entity_id' => $originalContribution['id'],
1485       'sequential' => 1,
1486       'return' => array(
1487         'entity_table',
1488         'qty',
1489         'unit_price',
1490         'line_total',
1491         'label',
1492         'financial_type_id',
1493         'deductible_amount',
1494         'price_field_value_id',
1495         'price_field_id',
1496       ),
1497     );
1498     $this->callAPISuccessGetSingle('contribution', array(
1499       'total_amount' => 400,
1500       'campaign_id' => $campaignID2,
1501       'fee_amount' => 50,
1502       'net_amount' => 350,
1503     ));
1504     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, array(
1505       'entity_id' => $originalContribution['id'],
1506     )));
1507     $expectedLineItem = array_merge(
1508       $lineItem1['values'][0], array(
1509         'line_total' => '400.00',
1510         'unit_price' => '400.00',
1511       )
1512     );
1513
1514     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, array(
1515       'entity_id' => $originalContribution['id'] + 1,
1516     )));
1517     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
1518     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
1519     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
1520
1521     $this->quickCleanUpFinancialEntities();
1522   }
1523
1524   /**
1525    * Test completing a transaction does not 'mess' with net amount (CRM-15960).
1526    */
1527   public function testCompleteTransactionNetAmountOK() {
1528     $this->createLoggedInUser();
1529     $params = array_merge($this->_params, array('contribution_status_id' => 2));
1530     unset($params['net_amount']);
1531     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1532     $this->callAPISuccess('contribution', 'completetransaction', array(
1533       'id' => $contribution['id'],
1534     ));
1535     $contribution = $this->callAPISuccess('contribution', 'getsingle', array('id' => $contribution['id']));
1536     $this->assertEquals('Completed', $contribution['contribution_status']);
1537     $this->assertTrue(($contribution['total_amount'] - $contribution['net_amount']) == $contribution['fee_amount']);
1538   }
1539
1540   /**
1541    * CRM-14151 - Test completing a transaction via the API.
1542    */
1543   public function testCompleteTransactionWithReceiptDateSet() {
1544     $mut = new CiviMailUtils($this, TRUE);
1545     $this->createLoggedInUser();
1546     $params = array_merge($this->_params, array('contribution_status_id' => 2, 'receipt_date' => 'now'));
1547     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1548     $this->callAPISuccess('contribution', 'completetransaction', array('id' => $contribution['id'], 'trxn_date' => date('Y-m-d')));
1549     $contribution = $this->callAPISuccess('contribution', 'get', array('id' => $contribution['id'], 'sequential' => 1));
1550     $this->assertEquals('Completed', $contribution['values'][0]['contribution_status']);
1551     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['values'][0]['receive_date'])));
1552     $mut->checkMailLog(array(
1553       'Receipt - Contribution',
1554       'Please print this confirmation for your records.',
1555     ));
1556     $mut->stop();
1557   }
1558
1559   /**
1560    * Test completing first transaction in a recurring series.
1561    *
1562    * The status should be set to 'in progress' and the next scheduled payment date calculated.
1563    */
1564   public function testCompleteTransactionSetStatusToInProgress() {
1565     $paymentProcessorID = $this->paymentProcessorCreate();
1566     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
1567       'contact_id' => $this->_individualId,
1568       'installments' => '12',
1569       'frequency_interval' => '1',
1570       'amount' => '500',
1571       'contribution_status_id' => 'Pending',
1572       'start_date' => '2012-01-01 00:00:00',
1573       'currency' => 'USD',
1574       'frequency_unit' => 'month',
1575       'payment_processor_id' => $paymentProcessorID,
1576     ));
1577     $contribution = $this->callAPISuccess('contribution', 'create', array_merge(
1578       $this->_params,
1579       array(
1580         'contribution_recur_id' => $contributionRecur['id'],
1581         'contribution_status_id' => 'Pending',
1582       ))
1583     );
1584     $this->callAPISuccess('Contribution', 'completetransaction', array('id' => $contribution));
1585     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', array(
1586       'id' => $contributionRecur['id'],
1587       'return' => array('next_sched_contribution_date', 'contribution_status_id'),
1588     ));
1589     $this->assertEquals(5, $contributionRecur['contribution_status_id']);
1590     $this->assertEquals(date('Y-m-d 00:00:00', strtotime('+1 month')), $contributionRecur['next_sched_contribution_date']);
1591   }
1592
1593   /**
1594    * Test completing a transaction with an event via the API.
1595    *
1596    * Note that we are creating a logged in user because email goes out from
1597    * that person
1598    */
1599   public function testCompleteTransactionWithParticipantRecord() {
1600     $mut = new CiviMailUtils($this, TRUE);
1601     $mut->clearMessages();
1602     $this->createLoggedInUser();
1603     $contributionID = $this->createPendingParticipantContribution();
1604     $this->callAPISuccess('contribution', 'completetransaction', array(
1605         'id' => $contributionID,
1606       )
1607     );
1608     $participantStatus = $this->callAPISuccessGetValue('participant', array(
1609       'id' => $this->_ids['participant'],
1610       'return' => 'participant_status_id',
1611     ));
1612     $this->assertEquals(1, $participantStatus);
1613     $mut->checkMailLog(array(
1614       'Annual CiviCRM meet',
1615       'Event',
1616       'This letter is a confirmation that your registration has been received and your status has been updated to Registered.',
1617     ));
1618     $mut->stop();
1619   }
1620
1621   /**
1622    * Test membership is renewed when transaction completed.
1623    */
1624   public function testCompleteTransactionMembershipPriceSet() {
1625     $this->createPriceSetWithPage('membership');
1626     $stateOfGrace = $this->callAPISuccess('MembershipStatus', 'getvalue', array(
1627       'name' => 'Grace',
1628       'return' => 'id')
1629     );
1630     $this->setUpPendingContribution($this->_ids['price_field_value'][0]);
1631     $membership = $this->callAPISuccess('membership', 'getsingle', array('id' => $this->_ids['membership']));
1632     $logs = $this->callAPISuccess('MembershipLog', 'get', array(
1633       'membership_id' => $this->_ids['membership'],
1634     ));
1635     $this->assertEquals(1, $logs['count']);
1636     $this->assertEquals($stateOfGrace, $membership['status_id']);
1637     $this->callAPISuccess('contribution', 'completetransaction', array('id' => $this->_ids['contribution']));
1638     $membership = $this->callAPISuccess('membership', 'getsingle', array('id' => $this->_ids['membership']));
1639     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 1 year')), $membership['end_date']);
1640     $this->callAPISuccessGetSingle('LineItem', array(
1641       'entity_id' => $this->_ids['membership'],
1642       'entity_table' => 'civicrm_membership',
1643     ));
1644     $logs = $this->callAPISuccess('MembershipLog', 'get', array(
1645       'membership_id' => $this->_ids['membership'],
1646     ));
1647     $this->assertEquals(2, $logs['count']);
1648     $this->assertNotEquals($stateOfGrace, $logs['values'][2]['status_id']);
1649     $this->cleanUpAfterPriceSets();
1650   }
1651
1652   /**
1653    * Test membership is renewed when transaction completed.
1654    */
1655   public function testCompleteTransactionMembershipPriceSetTwoTerms() {
1656     $this->createPriceSetWithPage('membership');
1657     $this->setUpPendingContribution($this->_ids['price_field_value'][1]);
1658     $this->callAPISuccess('contribution', 'completetransaction', array('id' => $this->_ids['contribution']));
1659     $membership = $this->callAPISuccess('membership', 'getsingle', array('id' => $this->_ids['membership']));
1660     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 2 years')), $membership['end_date']);
1661     $this->cleanUpAfterPriceSets();
1662   }
1663
1664   public function cleanUpAfterPriceSets() {
1665     $this->quickCleanUpFinancialEntities();
1666     $this->contactDelete($this->_ids['contact']);
1667   }
1668
1669
1670   /**
1671    * Create price set with contribution test for test setup.
1672    *
1673    * This could be merged with 4.5 function setup in api_v3_ContributionPageTest::setUpContributionPage
1674    * on parent class at some point (fn is not in 4.4).
1675    *
1676    * @param $entity
1677    * @param array $params
1678    */
1679   public function createPriceSetWithPage($entity, $params = array()) {
1680     $membershipTypeID = $this->membershipTypeCreate();
1681     $contributionPageResult = $this->callAPISuccess('contribution_page', 'create', array(
1682       'title' => "Test Contribution Page",
1683       'financial_type_id' => 1,
1684       'currency' => 'NZD',
1685       'goal_amount' => 50,
1686       'is_pay_later' => 1,
1687       'is_monetary' => TRUE,
1688       'is_email_receipt' => FALSE,
1689     ));
1690     $priceSet = $this->callAPISuccess('price_set', 'create', array(
1691       'is_quick_config' => 0,
1692       'extends' => 'CiviMember',
1693       'financial_type_id' => 1,
1694       'title' => 'my Page',
1695     ));
1696     $priceSetID = $priceSet['id'];
1697
1698     CRM_Price_BAO_PriceSet::addTo('civicrm_contribution_page', $contributionPageResult['id'], $priceSetID);
1699     $priceField = $this->callAPISuccess('price_field', 'create', array(
1700       'price_set_id' => $priceSetID,
1701       'label' => 'Goat Breed',
1702       'html_type' => 'Radio',
1703     ));
1704     $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', array(
1705         'price_set_id' => $priceSetID,
1706         'price_field_id' => $priceField['id'],
1707         'label' => 'Long Haired Goat',
1708         'amount' => 20,
1709         'financial_type_id' => 'Donation',
1710         'membership_type_id' => $membershipTypeID,
1711         'membership_num_terms' => 1,
1712       )
1713     );
1714     $this->_ids['price_field_value'] = array($priceFieldValue['id']);
1715     $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', array(
1716         'price_set_id' => $priceSetID,
1717         'price_field_id' => $priceField['id'],
1718         'label' => 'Shoe-eating Goat',
1719         'amount' => 10,
1720         'financial_type_id' => 'Donation',
1721         'membership_type_id' => $membershipTypeID,
1722         'membership_num_terms' => 2,
1723       )
1724     );
1725     $this->_ids['price_field_value'][] = $priceFieldValue['id'];
1726     $this->_ids['price_set'] = $priceSetID;
1727     $this->_ids['contribution_page'] = $contributionPageResult['id'];
1728     $this->_ids['price_field'] = array($priceField['id']);
1729
1730     $this->_ids['membership_type'] = $membershipTypeID;
1731   }
1732
1733   /**
1734    * Set up a pending transaction with a specific price field id.
1735    *
1736    * @param int $priceFieldValueID
1737    */
1738   public function setUpPendingContribution($priceFieldValueID) {
1739     $contactID = $this->individualCreate();
1740     $membership = $this->callAPISuccess('membership', 'create', array(
1741       'contact_id' => $contactID,
1742       'membership_type_id' => $this->_ids['membership_type'],
1743       'start_date' => 'yesterday - 1 year',
1744       'end_date' => 'yesterday',
1745       'join_date' => 'yesterday - 1 year',
1746     ));
1747     $contribution = $this->callAPISuccess('contribution', 'create', array(
1748       'domain_id' => 1,
1749       'contact_id' => $contactID,
1750       'receive_date' => date('Ymd'),
1751       'total_amount' => 100.00,
1752       'financial_type_id' => 1,
1753       'payment_instrument_id' => 'Credit Card',
1754       'non_deductible_amount' => 10.00,
1755       'trxn_id' => 'jdhfi88',
1756       'invoice_id' => 'djfhiewuyr',
1757       'source' => 'SSF',
1758       'contribution_status_id' => 2,
1759       'contribution_page_id' => $this->_ids['contribution_page'],
1760       'api.membership_payment.create' => array('membership_id' => $membership['id']),
1761     ));
1762
1763     $this->callAPISuccess('line_item', 'create', array(
1764       'entity_id' => $contribution['id'],
1765       'entity_table' => 'civicrm_contribution',
1766       'contribution_id' => $contribution['id'],
1767       'price_field_id' => $this->_ids['price_field'][0],
1768       'qty' => 1,
1769       'unit_price' => 20,
1770       'line_total' => 20,
1771       'financial_type_id' => 1,
1772       'price_field_value_id' => $priceFieldValueID,
1773     ));
1774     $this->_ids['contact'] = $contactID;
1775     $this->_ids['contribution'] = $contribution['id'];
1776     $this->_ids['membership'] = $membership['id'];
1777   }
1778
1779   /**
1780    * Test sending a mail via the API.
1781    */
1782   public function testSendMail() {
1783     $mut = new CiviMailUtils($this, TRUE);
1784     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
1785     $this->callAPISuccess('contribution', 'sendconfirmation', array(
1786         'id' => $contribution['id'],
1787         'receipt_from_email' => 'api@civicrm.org',
1788       )
1789     );
1790     $mut->checkMailLog(array(
1791         '$ 100.00',
1792         'Contribution Information',
1793         'Please print this confirmation for your records',
1794       ), array(
1795         'Event',
1796       )
1797     );
1798     $mut->stop();
1799   }
1800
1801   /**
1802    * Test sending a mail via the API.
1803    */
1804   public function testSendMailEvent() {
1805     $mut = new CiviMailUtils($this, TRUE);
1806     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
1807     $event = $this->eventCreate(array(
1808       'is_email_confirm' => 1,
1809       'confirm_from_email' => 'test@civicrm.org',
1810     ));
1811     $this->_eventID = $event['id'];
1812     $participantParams = array(
1813       'contact_id' => $this->_individualId,
1814       'event_id' => $this->_eventID,
1815       'status_id' => 1,
1816       'role_id' => 1,
1817       // to ensure it matches later on
1818       'register_date' => '2007-07-21 00:00:00',
1819       'source' => 'Online Event Registration: API Testing',
1820
1821     );
1822     $participant = $this->callAPISuccess('participant', 'create', $participantParams);
1823     $this->callAPISuccess('participant_payment', 'create', array(
1824       'participant_id' => $participant['id'],
1825       'contribution_id' => $contribution['id'],
1826     ));
1827     $this->callAPISuccess('contribution', 'sendconfirmation', array(
1828         'id' => $contribution['id'],
1829         'receipt_from_email' => 'api@civicrm.org',
1830       )
1831     );
1832
1833     $mut->checkMailLog(array(
1834         'Annual CiviCRM meet',
1835         'Event',
1836         'To: "Mr. Anthony Anderson II" <anthony_anderson@civicrm.org>',
1837       ), array()
1838     );
1839     $mut->stop();
1840   }
1841
1842   /**
1843    * This function does a GET & compares the result against the $params.
1844    *
1845    * Use as a double check on Creates.
1846    *
1847    * @param array $params
1848    * @param int $id
1849    * @param bool $delete
1850    */
1851   public function contributionGetnCheck($params, $id, $delete = TRUE) {
1852
1853     $contribution = $this->callAPISuccess('Contribution', 'Get', array(
1854       'id' => $id,
1855
1856     ));
1857
1858     if ($delete) {
1859       $this->callAPISuccess('contribution', 'delete', array('id' => $id));
1860     }
1861     $this->assertAPISuccess($contribution, 0);
1862     $values = $contribution['values'][$contribution['id']];
1863     $params['receive_date'] = date('Y-m-d H:i:s', strtotime($params['receive_date']));
1864     // this is not returned in id format
1865     unset($params['payment_instrument_id']);
1866     $params['contribution_source'] = $params['source'];
1867     unset($params['source']);
1868     foreach ($params as $key => $value) {
1869       $this->assertEquals($value, $values[$key], $key . " value: $value doesn't match " . print_r($values, TRUE));
1870     }
1871   }
1872
1873   /**
1874    * Create a pending contribution & linked pending participant record (along with an event).
1875    */
1876   public function createPendingParticipantContribution() {
1877     $event = $this->eventCreate(array('is_email_confirm' => 1, 'confirm_from_email' => 'test@civicrm.org'));
1878     $participantID = $this->participantCreate(array('event_id' => $event['id'], 'status_id' => 6));
1879     $this->_ids['participant'] = $participantID;
1880     $params = array_merge($this->_params, array('contribution_status_id' => 2, 'financial_type_id' => 'Event Fee'));
1881     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1882     $this->callAPISuccess('participant_payment', 'create', array(
1883       'contribution_id' => $contribution['id'],
1884       'participant_id' => $participantID,
1885     ));
1886     $this->callAPISuccess('line_item', 'get', array(
1887       'entity_id' => $contribution['id'],
1888       'entity_table' => 'civicrm_contribution',
1889       'api.line_item.create' => array(
1890         'entity_id' => $participantID,
1891         'entity_table' => 'civicrm_participant',
1892       ),
1893     ));
1894     return $contribution['id'];
1895   }
1896
1897   /**
1898    * Get financial transaction amount.
1899    *
1900    * @param int $contId
1901    *
1902    * @return null|string
1903    */
1904   public function _getFinancialTrxnAmount($contId) {
1905     $query = "SELECT
1906      SUM( ft.total_amount ) AS total
1907      FROM civicrm_financial_trxn AS ft
1908      LEFT JOIN civicrm_entity_financial_trxn AS ceft ON ft.id = ceft.financial_trxn_id
1909      WHERE ceft.entity_table = 'civicrm_contribution'
1910      AND ceft.entity_id = {$contId}";
1911
1912     $result = CRM_Core_DAO::singleValueQuery($query);
1913     return $result;
1914   }
1915
1916   /**
1917    * @param int $contId
1918    *
1919    * @return null|string
1920    */
1921   public function _getFinancialItemAmount($contId) {
1922     $lineItem = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
1923     $query = "SELECT
1924      SUM(amount)
1925      FROM civicrm_financial_item
1926      WHERE entity_table = 'civicrm_line_item'
1927      AND entity_id = {$lineItem}";
1928     $result = CRM_Core_DAO::singleValueQuery($query);
1929     return $result;
1930   }
1931
1932   /**
1933    * @param int $contId
1934    * @param $context
1935    */
1936   public function _checkFinancialItem($contId, $context) {
1937     if ($context != 'paylater') {
1938       $params = array(
1939         'entity_id' => $contId,
1940         'entity_table' => 'civicrm_contribution',
1941       );
1942       $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($params, TRUE));
1943       $entityParams = array(
1944         'financial_trxn_id' => $trxn['financial_trxn_id'],
1945         'entity_table' => 'civicrm_financial_item',
1946       );
1947       $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1948       $params = array(
1949         'id' => $entityTrxn['entity_id'],
1950       );
1951     }
1952     if ($context == 'paylater') {
1953       $lineItems = CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution');
1954       foreach ($lineItems as $key => $item) {
1955         $params = array(
1956           'entity_id' => $key,
1957           'entity_table' => 'civicrm_line_item',
1958         );
1959         $compareParams = array('status_id' => 1);
1960         $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
1961       }
1962     }
1963     elseif ($context == 'refund') {
1964       $compareParams = array(
1965         'status_id' => 1,
1966         'financial_account_id' => 1,
1967         'amount' => -100,
1968       );
1969     }
1970     elseif ($context == 'cancelPending') {
1971       $compareParams = array(
1972         'status_id' => 3,
1973         'financial_account_id' => 1,
1974         'amount' => -100,
1975       );
1976     }
1977     elseif ($context == 'changeFinancial') {
1978       $lineKey = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
1979       $params = array(
1980         'entity_id' => $lineKey,
1981         'amount' => -100,
1982       );
1983       $compareParams = array(
1984         'financial_account_id' => 1,
1985       );
1986       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
1987       $params = array(
1988         'financial_account_id' => 3,
1989         'entity_id' => $lineKey,
1990       );
1991       $compareParams = array(
1992         'amount' => 100,
1993       );
1994     }
1995     if ($context != 'paylater') {
1996       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
1997     }
1998   }
1999
2000   /**
2001    * @param array $contribution
2002    * @param string $context
2003    * @param int $instrumentId
2004    */
2005   public function _checkFinancialTrxn($contribution, $context, $instrumentId = NULL) {
2006     $trxnParams = array(
2007       'entity_id' => $contribution['id'],
2008       'entity_table' => 'civicrm_contribution',
2009     );
2010     $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($trxnParams, TRUE));
2011     $params = array(
2012       'id' => $trxn['financial_trxn_id'],
2013     );
2014     if ($context == 'payLater') {
2015       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
2016       $compareParams = array(
2017         'status_id' => 1,
2018         'from_financial_account_id' => CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId),
2019       );
2020     }
2021     elseif ($context == 'refund') {
2022       $compareParams = array(
2023         'to_financial_account_id' => 6,
2024         'total_amount' => -100,
2025         'status_id' => 7,
2026         'trxn_date' => '2015-01-01 09:00:00',
2027       );
2028     }
2029     elseif ($context == 'cancelPending') {
2030       $compareParams = array(
2031         'to_financial_account_id' => 7,
2032         'total_amount' => -100,
2033         'status_id' => 3,
2034       );
2035     }
2036     elseif ($context == 'changeFinancial' || $context == 'paymentInstrument') {
2037       $entityParams = array(
2038         'entity_id' => $contribution['id'],
2039         'entity_table' => 'civicrm_contribution',
2040         'amount' => -100,
2041       );
2042       $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
2043       $trxnParams1 = array(
2044         'id' => $trxn['financial_trxn_id'],
2045       );
2046       $compareParams = array(
2047         'total_amount' => -100,
2048         'status_id' => 1,
2049       );
2050       if ($context == 'paymentInstrument') {
2051         $compareParams += array(
2052           'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount(4),
2053           'payment_instrument_id' => 4,
2054         );
2055       }
2056       else {
2057         $compareParams['to_financial_account_id'] = 12;
2058       }
2059       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams1, $compareParams);
2060       $compareParams['total_amount'] = 100;
2061       if ($context == 'paymentInstrument') {
2062         $compareParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($instrumentId);
2063         $compareParams['payment_instrument_id'] = $instrumentId;
2064       }
2065       else {
2066         $compareParams['to_financial_account_id'] = 12;
2067       }
2068     }
2069
2070     $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $params, $compareParams);
2071   }
2072
2073   /**
2074    * @return mixed
2075    */
2076   public function _addPaymentInstrument() {
2077     $gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'payment_instrument', 'id', 'name');
2078     $optionParams = array(
2079       'option_group_id' => $gId,
2080       'label' => 'Test Card',
2081       'name' => 'Test Card',
2082       'value' => '6',
2083       'weight' => '6',
2084       'is_active' => 1,
2085     );
2086     $optionValue = $this->callAPISuccess('option_value', 'create', $optionParams);
2087     $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
2088     $financialParams = array(
2089       'entity_table' => 'civicrm_option_value',
2090       'entity_id' => $optionValue['id'],
2091       'account_relationship' => $relationTypeId,
2092       'financial_account_id' => 7,
2093     );
2094     CRM_Financial_BAO_FinancialTypeAccount::add($financialParams, CRM_Core_DAO::$_nullArray);
2095     $this->assertNotEmpty($optionValue['values'][$optionValue['id']]['value']);
2096     return $optionValue['values'][$optionValue['id']]['value'];
2097   }
2098
2099   /**
2100    * @param array $params
2101    * @param $context
2102    */
2103   public function _checkFinancialRecords($params, $context) {
2104     $entityParams = array(
2105       'entity_id' => $params['id'],
2106       'entity_table' => 'civicrm_contribution',
2107     );
2108     $contribution = $this->callAPISuccess('contribution', 'getsingle', array('id' => $params['id']));
2109     $this->assertEquals($contribution['total_amount'] - $contribution['fee_amount'], $contribution['net_amount']);
2110     if ($context == 'pending') {
2111       $trxn = CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams);
2112       $this->assertNull($trxn, 'No Trxn to be created until IPN callback');
2113       return;
2114     }
2115     $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
2116     $trxnParams = array(
2117       'id' => $trxn['financial_trxn_id'],
2118     );
2119     if ($context != 'online' && $context != 'payLater') {
2120       $compareParams = array(
2121         'to_financial_account_id' => 6,
2122         'total_amount' => 100,
2123         'status_id' => 1,
2124       );
2125     }
2126     if ($context == 'feeAmount') {
2127       $compareParams['fee_amount'] = 50;
2128     }
2129     elseif ($context == 'online') {
2130       $compareParams = array(
2131         'to_financial_account_id' => 12,
2132         'total_amount' => 100,
2133         'status_id' => 1,
2134       );
2135     }
2136     elseif ($context == 'payLater') {
2137       $compareParams = array(
2138         'to_financial_account_id' => 7,
2139         'total_amount' => 100,
2140         'status_id' => 2,
2141       );
2142     }
2143     $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
2144     $entityParams = array(
2145       'financial_trxn_id' => $trxn['financial_trxn_id'],
2146       'entity_table' => 'civicrm_financial_item',
2147     );
2148     $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
2149     $fitemParams = array(
2150       'id' => $entityTrxn['entity_id'],
2151     );
2152     $compareParams = array(
2153       'amount' => 100,
2154       'status_id' => 1,
2155       'financial_account_id' => 1,
2156     );
2157     if ($context == 'payLater') {
2158       $compareParams = array(
2159         'amount' => 100,
2160         'status_id' => 3,
2161         'financial_account_id' => 1,
2162       );
2163     }
2164     $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
2165     if ($context == 'feeAmount') {
2166       $maxParams = array(
2167         'entity_id' => $params['id'],
2168         'entity_table' => 'civicrm_contribution',
2169       );
2170       $maxTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($maxParams, TRUE));
2171       $trxnParams = array(
2172         'id' => $maxTrxn['financial_trxn_id'],
2173       );
2174       $compareParams = array(
2175         'to_financial_account_id' => 5,
2176         'from_financial_account_id' => 6,
2177         'total_amount' => 50,
2178         'status_id' => 1,
2179       );
2180       $trxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['id'], 'DESC');
2181       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
2182       $fitemParams = array(
2183         'entity_id' => $trxnId['financialTrxnId'],
2184         'entity_table' => 'civicrm_financial_trxn',
2185       );
2186       $compareParams = array(
2187         'amount' => 50,
2188         'status_id' => 1,
2189         'financial_account_id' => 5,
2190       );
2191       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
2192     }
2193   }
2194
2195 }