tests/phpunit/api/v3/ContributionTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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
  39 class api_v3_ContributionTest extends CiviUnitTestCase {
  40
  41   /**
  42    * Assume empty database with just civicrm_data
  43    */
  44   protected $_individualId;
  45   protected $_contribution;
  46   protected $_contributionTypeId = 1;
  47   protected $_apiversion;
  48   protected $_entity = 'Contribution';
  49   public $debug = 0;
  50   protected $_params;
  51   public $_eNoticeCompliant = TRUE;
  52   function setUp() {
  53     parent::setUp();
  54
  55     $this->_apiversion = 3;
  56     $this->_individualId = $this->individualCreate();
  57     $paymentProcessor = $this->processorCreate();
  58     $this->_params = array(
  59       'contact_id' => $this->_individualId,
  60       'receive_date' => '20120511',
  61       'total_amount' => 100.00,
  62       'financial_type_id'   => $this->_contributionTypeId,
  63       'non_deductible_amount' => 10.00,
  64       'fee_amount' => 5.00,
  65       'net_amount' => 95.00,
  66       'source' => 'SSF',
  67       'contribution_status_id' => 1,
  68       'version' => $this->_apiversion,
  69     );
  70     $this->_processorParams = array(
  71       'domain_id' => 1,
  72       'name' => 'Dummy',
  73       'payment_processor_type_id' => 10,
  74       'financial_account_id' => 12,
  75       'is_active' => 1,
  76       'user_name' => '',
  77       'url_site' => 'http://dummy.com',
  78       'url_recur' => 'http://dummy.com',
  79       'billing_mode' => 1,
  80     );
  81     $this->_pageParams = array(
  82       'version' => 3,
  83       'title' => 'Test Contribution Page',
  84       'financial_type_id' => 1,
  85       'currency' => 'USD',
  86       'financial_account_id' => 1,
  87       'payment_processor' => $paymentProcessor->id,
  88       'is_active' => 1,
  89       'is_allow_other_amount' => 1,
  90       'min_amount' => 10,
  91       'max_amount' => 1000,
  92      );
  93   }
  94
  95   function tearDown() {
  96
  97     $this->contributionTypeDelete();
  98     $this->quickCleanup(array(
  99       'civicrm_contribution',
 100       'civicrm_contribution_soft',
 101       'civicrm_event',
 102       'civicrm_contribution_page',
 103       'civicrm_participant',
 104       'civicrm_participant_payment',
 105       'civicrm_line_item',
 106       'civicrm_financial_trxn',
 107       'civicrm_financial_item',
 108       'civicrm_entity_financial_trxn',
 109       'civicrm_contact',
 110     ));
 111   }
 112
 113   ///////////////// civicrm_contribution_get methods
 114
 115   function testGetParamsNotArrayContribution() {
 116     $params = 'contact_id= 1';
 117     $contribution = $this->callAPIFailure('contribution', 'get', $params);
 118     $this->assertEquals($contribution['error_message'], 'Input variable `params` is not an array');
 119   }
 120
 121   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->_contributionTypeId,
 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       'version' => $this->_apiversion,
 135     );
 136     $this->_contribution = $this->callAPISuccess('contribution', 'create', $p);
 137
 138     $params = array(
 139       'contribution_id' => $this->_contribution['id'],
 140       'version' => $this->_apiversion,
 141     );
 142     $contribution = $this->callAPIAndDocument('contribution', 'get', $params, __FUNCTION__, __FILE__);
 143     $financialParams['id'] = $this->_contributionTypeId;
 144     $default = null;
 145     $financialType  =  CRM_Financial_BAO_FinancialType::retrieve($financialParams,$default);
 146
 147     $this->assertEquals(1,$contribution['count']);
 148     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 149     // note there was an assertion converting financial_type_id to 'Donation' which wasn't working.
 150     // passing back a string rather than an id seems like an error / cruft - & 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, 'In line ' . __LINE__);
 153     $this->assertEquals($contribution['values'][$contribution['id']]['non_deductible_amount'], 10.00, 'In line ' . __LINE__);
 154     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 5.00, 'In line ' . __LINE__);
 155     $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 95.00, 'In line ' . __LINE__);
 156     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 23456, 'In line ' . __LINE__);
 157     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 78910, 'In line ' . __LINE__);
 158     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_source'], 'SSF', 'In line ' . __LINE__);
 159     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed', 'In line ' . __LINE__);
 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
 167     $params = array(
 168       'version' => $this->_apiversion,
 169     );
 170     // now we have 2 - test getcount
 171     $contribution = civicrm_api('contribution', 'getcount', array(
 172       'version' => $this->_apiversion,
 173       ));
 174     $this->assertEquals(2, $contribution);
 175     //test id only format
 176     $contribution = $this->callAPISuccess('contribution', 'get', array
 177       ('version' => $this->_apiversion,
 178         'id' => $this->_contribution['id'],
 179         'format.only_id' => 1,
 180       )
 181     );
 182     $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution,true) . " in line " . __LINE__);
 183     //test id only format
 184     $contribution = $this->callAPISuccess('contribution', 'get', array
 185       ('version' => $this->_apiversion,
 186         'id' => $contribution2['id'],
 187         'format.only_id' => 1,
 188       )
 189     );
 190     $this->assertEquals($contribution2['id'], $contribution);
 191     $contribution = $this->callAPISuccess('contribution', 'get', array(
 192       'version' => $this->_apiversion,
 193         'id' => $this->_contribution['id'],
 194       ));
 195     //test id as field
 196
 197     $this->assertEquals(1, $contribution['count'], 'In line ' . __LINE__);
 198     // $this->assertEquals($this->_contribution['id'], $contribution['id'] )  ;
 199     //test get by contact id works
 200     $contribution = $this->callAPISuccess('contribution', 'get', array('version' => $this->_apiversion, 'contact_id' => $this->_individualId));
 201
 202     $this->assertEquals(2, $contribution['count'], 'In line ' . __LINE__);
 203     $this->callAPISuccess('Contribution', 'Delete', array(
 204       'id' => $this->_contribution['id'],
 205         'version' => $this->_apiversion,
 206       ));
 207     $this->callAPISuccess('Contribution', 'Delete', array(
 208       'id' => $contribution2['id'],
 209         'version' => $this->_apiversion,
 210       ));
 211   }
 212
 213 /**
 214  * We need to ensure previous tested behaviour still works as part of the api contract
 215  */
 216   function testGetContributionLegacyBehaviour() {
 217     $p = array(
 218       'contact_id' => $this->_individualId,
 219       'receive_date' => '2010-01-20',
 220       'total_amount' => 100.00,
 221       'contribution_type_id' => $this->_contributionTypeId,
 222       'non_deductible_amount' => 10.00,
 223       'fee_amount' => 5.00,
 224       'net_amount' => 95.00,
 225       'trxn_id' => 23456,
 226       'invoice_id' => 78910,
 227       'source' => 'SSF',
 228       'contribution_status_id' => 1,
 229       'version' => $this->_apiversion,
 230     );
 231     $this->_contribution = $this->callAPISuccess('contribution', 'create', $p);
 232
 233     $params = array(
 234       'contribution_id' => $this->_contribution['id'],
 235       'version' => $this->_apiversion,
 236     );
 237     $contribution = $this->callAPIAndDocument('contribution', 'get', $params, __FUNCTION__, __FILE__);
 238     $financialParams['id'] = $this->_contributionTypeId;
 239     $default = null;
 240     $financialType  =  CRM_Financial_BAO_FinancialType::retrieve($financialParams,$default);
 241
 242     $this->assertEquals(1,$contribution['count']);
 243     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 244     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], $this->_contributionTypeId);
 245     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_type_id'], $this->_contributionTypeId);
 246     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 247     $this->assertEquals($contribution['values'][$contribution['id']]['non_deductible_amount'], 10.00, 'In line ' . __LINE__);
 248     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 5.00, 'In line ' . __LINE__);
 249     $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 95.00, 'In line ' . __LINE__);
 250     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 23456, 'In line ' . __LINE__);
 251     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 78910, 'In line ' . __LINE__);
 252     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_source'], 'SSF', 'In line ' . __LINE__);
 253     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed', 'In line ' . __LINE__);
 254     //create a second contribution - we are testing that 'id' gets the right contribution id (not the contact id)
 255     $p['trxn_id'] = '3847';
 256     $p['invoice_id'] = '3847';
 257
 258     $contribution2 = $this->callAPISuccess('contribution', 'create', $p);
 259
 260     $params = array(
 261       'version' => $this->_apiversion,
 262     );
 263     // now we have 2 - test getcount
 264     $contribution = civicrm_api('contribution', 'getcount', array(
 265       'version' => $this->_apiversion,
 266     ));
 267     $this->assertEquals(2, $contribution);
 268     //test id only format
 269     $contribution = civicrm_api('contribution', 'get', array
 270       ('version' => $this->_apiversion,
 271         'id' => $this->_contribution['id'],
 272         'format.only_id' => 1,
 273       )
 274     );
 275     $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution,true) . " in line " . __LINE__);
 276     //test id only format
 277     $contribution = civicrm_api('contribution', 'get', array
 278       ('version' => $this->_apiversion,
 279         'id' => $contribution2['id'],
 280         'format.only_id' => 1,
 281       )
 282     );
 283     $this->assertEquals($contribution2['id'], $contribution);
 284     $contribution = $this->callAPISuccess('contribution', 'get', array(
 285       'version' => $this->_apiversion,
 286       'id' => $this->_contribution['id'],
 287     ));
 288     //test id as field
 289     $this->assertEquals(1, $contribution['count'], 'In line ' . __LINE__);
 290     // $this->assertEquals($this->_contribution['id'], $contribution['id'] )  ;
 291     //test get by contact id works
 292     $contribution = $this->callAPISuccess('contribution', 'get', array('version' => $this->_apiversion, 'contact_id' => $this->_individualId));
 293
 294     $this->assertEquals(2, $contribution['count'], 'In line ' . __LINE__);
 295     $this->callAPISuccess('Contribution', 'Delete', array(
 296     'id' => $this->_contribution['id'],
 297     'version' => $this->_apiversion,
 298     ));
 299     $this->callAPISuccess('Contribution', 'Delete', array(
 300     'id' => $contribution2['id'],
 301     'version' => $this->_apiversion,
 302     ));
 303   }
 304   ///////////////// civicrm_contribution_
 305   function testCreateEmptyContributionIDUseDonation() {
 306     $params = array(
 307       'contribution_id' => FALSE,
 308       'contact_id' => 1,
 309       'total_amount' => 1,
 310       'version' => 3,
 311       'check_permissions' => false,
 312       'financial_type_id' => 'Donation',
 313     );
 314     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 315  }
 316   /*
 317    * ensure we continue to support contribution_type_id as part of the api commitment to
 318    * stability
 319    *///////////////// civicrm_contribution_
 320
 321   function testCreateLegacyBehaviour() {
 322     $params = array(
 323       'contribution_id' => FALSE,
 324       'contact_id' => 1,
 325       'total_amount' => 1,
 326       'version' => 3,
 327       'check_permissions' => false,
 328       'contribution_type_id' => 3,
 329     );
 330     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 331     $contribution = civicrm_api('contribution', 'getsingle', array('version' => $this->_apiversion, 'id' => $contribution['id']));
 332     $this->assertEquals(3, $contribution['financial_type_id']);
 333   }
 334
 335   ///////////////// civicrm_contribution_
 336   function testCreateEmptyParamsContribution() {
 337     $params = array('version' => $this->_apiversion);
 338     $contribution = $this->callAPIFailure('contribution', 'create', $params);
 339     $this->assertEquals($contribution['error_message'], 'Mandatory key(s) missing from params array: financial_type_id, total_amount, contact_id', 'In line ' . __LINE__);
 340   }
 341
 342   function testCreateParamsWithoutRequiredKeys() {
 343     $params = array('version' => 3);
 344     $contribution = $this->callAPIFailure('contribution', 'create', $params);
 345     $this->assertEquals($contribution['error_message'], 'Mandatory key(s) missing from params array: financial_type_id, total_amount, contact_id');
 346   }
 347
 348   /**
 349    * check with complete array + custom field
 350    * Note that the test is written on purpose without any
 351    * variables specific to participant so it can be replicated into other entities
 352    * and / or moved to the automated test suite
 353    */
 354   function testCreateWithCustom() {
 355     $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 356
 357     $params = $this->_params;
 358     $params['custom_' . $ids['custom_field_id']] = "custom string";
 359
 360     $result = $this->callAPIAndDocument($this->_entity, 'create', $params,  __FUNCTION__, __FILE__);
 361     $this->assertEquals($result['id'], $result['values'][$result['id']]['id']);
 362     $check = $this->callAPISuccess($this->_entity, 'get', array(
 363         'return.custom_' . $ids['custom_field_id'] => 1,
 364         'version' => 3,
 365         'id' => $result['id'],
 366       )
 367     );
 368     $this->customFieldDelete($ids['custom_field_id']);
 369     $this->customGroupDelete($ids['custom_group_id']);
 370     $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__);
 371   }
 372
 373   /**
 374    * check with complete array + custom field
 375    * Note that the test is written on purpose without any
 376    * variables specific to participant so it can be replicated into other entities
 377    * and / or moved to the automated test suite
 378    */
 379   function testCreateGetFieldsWithCustom() {
 380     $ids        = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 381     $idsContact = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, 'ContactTest.php');
 382     $result     = $this->callAPISuccess('Contribution', 'getfields', array('version' => 3));
 383     $this->assertArrayHasKey('custom_' . $ids['custom_field_id'], $result['values']);
 384     $this->assertArrayNotHasKey('custom_' . $idsContact['custom_field_id'], $result['values']);
 385     $this->customFieldDelete($ids['custom_field_id']);
 386     $this->customGroupDelete($ids['custom_group_id']);
 387     $this->customFieldDelete($idsContact['custom_field_id']);
 388     $this->customGroupDelete($idsContact['custom_group_id']);
 389   }
 390
 391   function testCreateContributionNoLineItems() {
 392
 393     $params = array(
 394       'contact_id' => $this->_individualId,
 395       'receive_date' => '20120511',
 396       'total_amount' => 100.00,
 397       'financial_type_id'      => $this->_contributionTypeId,
 398       'payment_instrument_id' => 1,
 399       'non_deductible_amount' => 10.00,
 400       'fee_amount' => 50.00,
 401       'net_amount' => 90.00,
 402       'trxn_id' => 12345,
 403       'invoice_id' => 67890,
 404       'source' => 'SSF',
 405       'contribution_status_id' => 1,
 406       'version' => $this->_apiversion,
 407       'skipLineItem' => 1,
 408     );
 409
 410     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 411     $lineItems = $this->callAPISuccess('line_item','get',array(
 412       'version' => $this->_apiversion,
 413       'entity_id' => $contribution['id'],
 414       'entity_table' => 'civicrm_contribution',
 415       'sequential' => 1,
 416     ));
 417     $this->assertEquals(0, $lineItems['count']);
 418   }
 419   /*
 420    * Test checks that passing in line items suppresses the create mechanism
 421    */
 422   function testCreateContributionChainedLineItems() {
 423
 424     $params = array(
 425       'contact_id' => $this->_individualId,
 426       'receive_date' => '20120511',
 427       'total_amount' => 100.00,
 428       'financial_type_id' => $this->_contributionTypeId,
 429       'payment_instrument_id' => 1,
 430       'non_deductible_amount' => 10.00,
 431       'fee_amount' => 50.00,
 432       'net_amount' => 90.00,
 433       'trxn_id' => 12345,
 434       'invoice_id' => 67890,
 435       'source' => 'SSF',
 436       'contribution_status_id' => 1,
 437       'version' => $this->_apiversion,
 438       'skipLineItem' => 1,
 439       'api.line_item.create' => array(
 440         array(
 441           'price_field_id' => 1,
 442           'qty' => 2,
 443           'line_total' => '20',
 444           'unit_price' => '10',
 445         ),
 446         array(
 447           'price_field_id' => 1,
 448           'qty' => 1,
 449           'line_total' => '80',
 450           'unit_price' => '80',
 451         ),
 452       ),
 453     );
 454
 455     $description = "Create Contribution with Nested Line Items";
 456     $subfile = "CreateWithNestedLineItems";
 457     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__,__FILE__, $description, $subfile);
 458
 459     $lineItems = $this->callAPISuccess('line_item','get',array(
 460       'version' => $this->_apiversion,
 461       'entity_id' => $contribution['id'],
 462       'entity_table' => 'civicrm_contribution',
 463       'sequential' => 1,
 464     ));
 465     $this->assertEquals(2, $lineItems['count']);
 466   }
 467
 468   function testCreateContributionOffline() {
 469     $params = array(
 470       'contact_id' => $this->_individualId,
 471       'receive_date' => '20120511',
 472       'total_amount' => 100.00,
 473       'financial_type_id' => 1,
 474       'trxn_id' => 12345,
 475       'invoice_id' => 67890,
 476       'source' => 'SSF',
 477       'contribution_status_id' => 1,
 478       'version' => $this->_apiversion,
 479     );
 480
 481     $contribution = civicrm_api('contribution', 'create', $params);
 482     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 483     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 484     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 485     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1, 'In line ' . __LINE__ );
 486     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345, 'In line ' . __LINE__);
 487     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890, 'In line ' . __LINE__);
 488     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 489     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1, 'In line ' . __LINE__);
 490     $lineItems = civicrm_api('line_item','get',array(
 491       'version' => $this->_apiversion,
 492       'entity_id' => $contribution['id'],
 493       'entity_table' => 'civicrm_contribution',
 494       'sequential' => 1,
 495       ));
 496     $this->assertEquals(1, $lineItems['count']);
 497     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 498     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 499     $lineItems = civicrm_api('line_item','get',array(
 500         'version' => $this->_apiversion,
 501         'entity_id' => $contribution['id'],
 502         'entity_table' => 'civicrm_contribution',
 503         'sequential' => 1,
 504     ));
 505     $this->assertEquals(1, $lineItems['count']);
 506     $this->_checkFinancialRecords($contribution, 'offline');
 507     $this->contributionGetnCheck($params, $contribution['id']);
 508   }
 509   /*
 510    *
 511    */
 512   function testCreateContributionWithPaymentInstrument() {
 513     $params = $this->_params + array('payment_instrument' => 'EFT');
 514     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 515     $contribution = $this->callAPISuccess('contribution','get', array(
 516       'sequential' => 1,
 517       'id' => $contribution['id']
 518     ));
 519     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 520     $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
 521
 522     $this->callAPISuccess('contribution', 'create', array('id' => $contribution['id'], 'payment_instrument' => 'Credit Card'));
 523     $contribution = $this->callAPISuccess('contribution','get', array(
 524       'sequential' => 1,
 525       'id' => $contribution['id']
 526     ));
 527     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 528     $this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
 529   }
 530
 531   function testGetContributionByPaymentInstrument() {
 532     $params = $this->_params + array('payment_instrument' => 'EFT');
 533     $params2 = $this->_params + array('payment_instrument' => 'Cash');
 534     civicrm_api('contribution','create',$params);
 535     $contribution = civicrm_api('contribution','create',$params2);
 536     $this->assertAPISuccess($contribution);
 537     $contribution = civicrm_api('contribution','get',array('version'=> 3, 'sequential' => 1, 'contribution_payment_instrument_id' => 'Cash'));
 538     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 539     $this->assertEquals('Cash',$contribution['values'][0]['payment_instrument']);
 540     $this->assertEquals(1,$contribution['count']);
 541     $contribution = civicrm_api('contribution','get',array('version'=> 3, 'sequential' => 1, 'payment_instrument_id' => 'EFT'));
 542     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 543     $this->assertEquals('EFT',$contribution['values'][0]['payment_instrument']);
 544     $this->assertEquals(1, $contribution['count']);
 545     $contribution = civicrm_api('contribution','get',array('version'=> 3, 'sequential' => 1, 'payment_instrument_id' => 5));
 546     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 547     $this->assertEquals('EFT',$contribution['values'][0]['payment_instrument']);
 548     $this->assertEquals(1,$contribution['count']);
 549     $contribution = civicrm_api('contribution','get',array('version'=> 3, 'sequential' => 1, 'payment_instrument' => 'EFT'));
 550     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 551     $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
 552     $this->assertEquals(1, $contribution['count']);
 553     $contribution = civicrm_api('contribution', 'update', array('id' => $contribution['id'], 'version' => $this->_apiversion, 'payment_instrument' => 'Credit Card'));
 554     $this->assertAPISuccess($contribution);
 555     $contribution = civicrm_api('contribution','get',array('version'=> 3, 'sequential' => 1, 'id' => $contribution['id'], ));
 556     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 557     $this->assertEquals('Credit Card',$contribution['values'][0]['payment_instrument']);
 558     $this->assertEquals(1,$contribution['count']);
 559   }
 560
 561   /*
 562      * Create test with unique field name on source
 563      */
 564   function testCreateContributionSource() {
 565
 566     $params = array(
 567       'contact_id' => $this->_individualId,
 568       'receive_date' => date('Ymd'),
 569       'total_amount' => 100.00,
 570       'financial_type_id' => $this->_contributionTypeId,
 571       'payment_instrument_id' => 1,
 572       'non_deductible_amount' => 10.00,
 573       'fee_amount' => 50.00,
 574       'net_amount' => 90.00,
 575       'trxn_id' => 12345,
 576       'invoice_id' => 67890,
 577       'contribution_source' => 'SSF',
 578       'contribution_status_id' => 1,
 579       'version' => $this->_apiversion,
 580     );
 581
 582     $contribution = civicrm_api('contribution', 'create', $params);
 583
 584     $this->assertAPISuccess($contribution, 'In line ' . __LINE__);
 585     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 586     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 587   }
 588   /*
 589      * Create test with unique field name on source
 590      */
 591   function testCreateContributionSourceInvalidContac() {
 592
 593     $params = array(
 594       'contact_id' => 999,
 595       'receive_date' => date('Ymd'),
 596       'total_amount' => 100.00,
 597       'financial_type_id' => $this->_contributionTypeId,
 598       'payment_instrument_id' => 1,
 599       'non_deductible_amount' => 10.00,
 600       'fee_amount' => 50.00,
 601       'net_amount' => 90.00,
 602       'trxn_id' => 12345,
 603       'invoice_id' => 67890,
 604       'contribution_source' => 'SSF',
 605       'contribution_status_id' => 1,
 606       'version' => $this->_apiversion,
 607     );
 608
 609     $contribution = civicrm_api('contribution', 'create', $params);
 610     $this->assertEquals($contribution['error_message'], 'contact_id is not valid : 999', 'In line ' . __LINE__);
 611   }
 612
 613   function testCreateContributionSourceInvalidContContac() {
 614
 615     $params = array(
 616       'contribution_contact_id' => 999,
 617       'receive_date' => date('Ymd'),
 618       'total_amount' => 100.00,
 619       'financial_type_id' => $this->_contributionTypeId,
 620       'payment_instrument_id' => 1,
 621       'non_deductible_amount' => 10.00,
 622       'fee_amount' => 50.00,
 623       'net_amount' => 90.00,
 624       'trxn_id' => 12345,
 625       'invoice_id' => 67890,
 626       'contribution_source' => 'SSF',
 627       'contribution_status_id' => 1,
 628       'version' => $this->_apiversion,
 629     );
 630
 631     $contribution = civicrm_api('contribution', 'create', $params);
 632     $this->assertEquals($contribution['error_message'], 'contact_id is not valid : 999', 'In line ' . __LINE__);
 633   }
 634
 635   function testCreateContributionWithNote() {
 636     $description = "Demonstrates creating contribution with Note Entity";
 637     $subfile     = "ContributionCreateWithNote";
 638     $params      = array(
 639       'contact_id' => $this->_individualId,
 640       'receive_date' => '2012-01-01',
 641       'total_amount' => 100.00,
 642       'financial_type_id' => $this->_contributionTypeId,
 643       'payment_instrument_id' => 1,
 644       'non_deductible_amount' => 10.00,
 645       'fee_amount' => 50.00,
 646       'net_amount' => 90.00,
 647       'trxn_id' => 12345,
 648       'invoice_id' => 67890,
 649       'source' => 'SSF',
 650       'contribution_status_id' => 1,
 651       'version' => $this->_apiversion,
 652       'note' => 'my contribution note',
 653     );
 654
 655     $contribution = civicrm_api('contribution', 'create', $params);
 656     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__, $description, $subfile);
 657     $result = civicrm_api('note', 'get', array('version' => 3, 'entity_table' => 'civicrm_contribution', 'entity_id' => $contribution['id'], 'sequential' => 1));
 658     $this->assertAPISuccess($result);
 659     $this->assertEquals('my contribution note', $result['values'][0]['note']);
 660     civicrm_api('contribution', 'delete', array('version' => 3, 'id' => $contribution['id']));
 661   }
 662
 663   function testCreateContributionWithNoteUniqueNameAliases() {
 664     $params      = array(
 665       'contact_id' => $this->_individualId,
 666       'receive_date' => '2012-01-01',
 667       'total_amount' => 100.00,
 668       'financial_type_id' => $this->_contributionTypeId,
 669       'payment_instrument_id' => 1,
 670       'non_deductible_amount' => 10.00,
 671       'fee_amount' => 50.00,
 672       'net_amount' => 90.00,
 673       'trxn_id' => 12345,
 674       'invoice_id' => 67890,
 675       'source' => 'SSF',
 676       'contribution_status_id' => 1,
 677       'version' => $this->_apiversion,
 678       'contribution_note' => 'my contribution note',
 679     );
 680
 681     $contribution = civicrm_api('contribution', 'create', $params);
 682     $result = civicrm_api('note', 'get', array('version' => 3, 'entity_table' => 'civicrm_contribution', 'entity_id' => $contribution['id'], 'sequential' => 1));
 683     $this->assertAPISuccess($result);
 684     $this->assertEquals('my contribution note', $result['values'][0]['note']);
 685     civicrm_api('contribution', 'delete', array('version' => 3, 'id' => $contribution['id']));
 686   }
 687   /*
 688      * This is the test for creating soft credits - however a 'get' is not yet possible via API
 689      * as the current BAO functions are contact-centric (from what I can find)
 690      *
 691      */
 692   function testCreateContributionWithSoftCredt() {
 693     $description = "Demonstrates creating contribution with SoftCredit";
 694     $subfile     = "ContributionCreateWithSoftCredit";
 695     $contact2    = civicrm_api('Contact', 'create', array('version' => 3, 'display_name' => 'superman', 'version' => 3, 'contact_type' => 'Individual'));
 696     $params      = $this->_params + array(
 697       'soft_credit_to' => $contact2['id'],
 698
 699     );
 700
 701     $contribution = civicrm_api('contribution', 'create', $params);
 702     $this->assertAPISuccess($contribution);
 703     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__, $description, $subfile);
 704     //     $result = civicrm_api('contribution','get', array('version' => 3,'return'=> 'soft_credit_to', 'sequential' => 1));
 705     //     $this->assertAPISuccess($result);
 706     //     $this->assertEquals($contact2['id'], $result['values'][$result['id']]['soft_credit_to']) ;
 707     //    well - the above doesn't work yet so lets do SQL
 708     $query = "SELECT count(*) FROM civicrm_contribution_soft WHERE contact_id = " . $contact2['id'];
 709
 710     $count = CRM_Core_DAO::singleValueQuery($query);
 711     $this->assertEquals(1, $count);
 712
 713     civicrm_api('contribution', 'delete', array('version' => 3, 'id' => $contribution['id']));
 714     civicrm_api('contact', 'delete', array('version' => 3, 'id' => $contact2['id']));
 715   }
 716
 717   /**
 718    *  Test  using example code
 719    */
 720   function testContributionCreateExample() {
 721     //make sure at least on page exists since there is a truncate in tear down
 722     $page = civicrm_api('contribution_page', 'create', $this->_pageParams);
 723     $this->assertAPISuccess($page);
 724     require_once 'api/v3/examples/ContributionCreate.php';
 725     $result         = contribution_create_example();
 726     $this->assertAPISuccess($result);
 727     $contributionId = $result['id'];
 728     $expectedResult = contribution_create_expectedresult();
 729     $this->checkArrayEquals($result, $expectedResult);
 730     $this->contributionDelete($contributionId);
 731   }
 732
 733   /*
 734    * Function tests that additional financial records are created when fee amount is recorded
 735    */
 736   function testCreateContributionWithFee() {
 737     $params = array(
 738       'contact_id' => $this->_individualId,
 739       'receive_date' => '20120511',
 740       'total_amount' => 100.00,
 741       'fee_amount' => 50,
 742       'financial_type_id' => 1,
 743       'trxn_id' => 12345,
 744       'invoice_id' => 67890,
 745       'source' => 'SSF',
 746       'contribution_status_id' => 1,
 747       'version' => $this->_apiversion,
 748     );
 749
 750     $contribution = civicrm_api('contribution', 'create', $params);
 751     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 752     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 753     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 754     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1, 'In line ' . __LINE__ );
 755     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345, 'In line ' . __LINE__);
 756     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890, 'In line ' . __LINE__);
 757     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 758     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1, 'In line ' . __LINE__);
 759     $lineItems = civicrm_api('line_item','get',array(
 760       'version' => $this->_apiversion,
 761       'entity_id' => $contribution['id'],
 762       'entity_table' => 'civicrm_contribution',
 763       'sequential' => 1,
 764       ));
 765     $this->assertEquals(1, $lineItems['count']);
 766     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 767     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 768     $lineItems = civicrm_api('line_item','get',array(
 769         'version' => $this->_apiversion,
 770         'entity_id' => $contribution['id'],
 771         'entity_table' => 'civicrm_contribution',
 772         'sequential' => 1,
 773     ));
 774     $this->assertEquals(1, $lineItems['count']);
 775     $this->_checkFinancialRecords($contribution, 'feeAmount');
 776   }
 777
 778
 779   /*
 780    * Function tests that additional financial records are created when online contribution is created
 781    */
 782   function testCreateContributionOnline() {
 783     $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 784     $contributionPage = civicrm_api( 'contribution_page','create',  $this->_pageParams );
 785     $this->assertAPISuccess($contributionPage);
 786     $params = array(
 787       'contact_id' => $this->_individualId,
 788       'receive_date' => '20120511',
 789       'total_amount' => 100.00,
 790       'financial_type_id' => 1,
 791       'contribution_page_id' => $contributionPage['id'],
 792       'payment_processor' => 1,
 793       'trxn_id' => 12345,
 794       'invoice_id' => 67890,
 795       'source' => 'SSF',
 796       'contribution_status_id' => 1,
 797       'version' => $this->_apiversion,
 798     );
 799
 800     $contribution = civicrm_api('contribution', 'create', $params);
 801     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 802     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 803     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 804     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1, 'In line ' . __LINE__ );
 805     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345, 'In line ' . __LINE__);
 806     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890, 'In line ' . __LINE__);
 807     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 808     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1, 'In line ' . __LINE__);
 809     $this->_checkFinancialRecords($contribution, 'online');
 810   }
 811
 812   /*
 813    * Function tests that additional financial records are created when online contribution with pay later option
 814    * is created
 815    */
 816   function testCreateContributionPayLaterOnline() {
 817     $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 818     $this->_pageParams['is_pay_later'] = 1;
 819     $contributionPage = civicrm_api( 'contribution_page','create',$this->_pageParams );
 820     $this->assertAPISuccess($contributionPage);
 821     $params = array(
 822       'contact_id' => $this->_individualId,
 823       'receive_date' => '20120511',
 824       'total_amount' => 100.00,
 825       'financial_type_id' => 1,
 826       'contribution_page_id' => $contributionPage['id'],
 827       'trxn_id' => 12345,
 828       'is_pay_later' => 1,
 829       'invoice_id' => 67890,
 830       'source' => 'SSF',
 831       'contribution_status_id' => 2,
 832       'version' => $this->_apiversion,
 833     );
 834
 835     $contribution = civicrm_api('contribution', 'create', $params);
 836     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 837     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 838     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 839     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1, 'In line ' . __LINE__ );
 840     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345, 'In line ' . __LINE__);
 841     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890, 'In line ' . __LINE__);
 842     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 843     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 2, 'In line ' . __LINE__);
 844     $this->_checkFinancialRecords($contribution, 'payLater');
 845   }
 846
 847   /*
 848    * Function tests that additional financial records are created when online contribution with pending option
 849    * is created
 850    */
 851   function testCreateContributionPendingOnline() {
 852     $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 853     $contributionPage = civicrm_api( 'contribution_page', 'create', $this->_pageParams );
 854     $this->assertAPISuccess($contributionPage);
 855     $params = array(
 856       'contact_id' => $this->_individualId,
 857       'receive_date' => '20120511',
 858       'total_amount' => 100.00,
 859       'financial_type_id' => 1,
 860       'contribution_page_id' => $contributionPage['id'],
 861       'trxn_id' => 12345,
 862       'invoice_id' => 67890,
 863       'source' => 'SSF',
 864       'contribution_status_id' => 2,
 865       'version' => $this->_apiversion,
 866     );
 867
 868     $contribution = civicrm_api('contribution', 'create', $params);
 869     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 870     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 871     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 872     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1, 'In line ' . __LINE__ );
 873     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345, 'In line ' . __LINE__);
 874     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890, 'In line ' . __LINE__);
 875     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 876     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 2, 'In line ' . __LINE__);
 877     $this->_checkFinancialRecords($contribution, 'pending');
 878   }
 879
 880   /*
 881    * Function tests that line items, financial records are updated when contribution amount is changed
 882    */
 883   function testCreateUpdateContributionChangeTotal() {
 884     $contribution = civicrm_api('contribution', 'create', $this->_params);
 885     $lineItems = civicrm_api('line_item','getvalue', array(
 886       'version' => $this->_apiversion,
 887       'entity_id' => $contribution['id'],
 888       'entity_table' => 'civicrm_contribution',
 889       'sequential' => 1,
 890       'return' => 'line_total',
 891     ));
 892     $this->assertEquals('100.00', $lineItems);
 893     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
 894     // Financial trxn SUM = 100 + 5 (fee)
 895     $this->assertEquals('105.00', $trxnAmount);
 896     $newParams = array(
 897       'version' => $this->_apiversion,
 898       'id' => $contribution['id'],
 899       'total_amount' => '125');
 900     $contribution = civicrm_api('contribution', 'update', $newParams);
 901
 902     $lineItems = civicrm_api('line_item','getvalue',array(
 903         'version' => $this->_apiversion,
 904         'entity_id' => $contribution['id'],
 905         'entity_table' => 'civicrm_contribution',
 906         'sequential' => 1,
 907         'return' => 'line_total',
 908     ));
 909
 910     $this->assertEquals('125.00', $lineItems);
 911     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
 912     $fitemAmount = $this->_getFinancialItemAmount($contribution['id']);
 913     // Financial trxn SUM = 125 + 5 (fee)
 914     $this->assertEquals('130.00', $trxnAmount);
 915     $this->assertEquals('125.00', $fitemAmount);
 916   }
 917
 918   /*
 919    * Function tests that line items, financial records are updated when pay later contribution is received
 920    */
 921   function testCreateUpdateContributionPayLater() {
 922     $contribParams = array(
 923       'contact_id' => $this->_individualId,
 924       'receive_date' => '2012-01-01',
 925       'total_amount' => 100.00,
 926       'financial_type_id' => $this->_contributionTypeId,
 927       'payment_instrument_id' => 1,
 928       'contribution_status_id' => 2,
 929       'is_pay_later' => 1,
 930       'version' => $this->_apiversion,
 931     );
 932     $contribution = civicrm_api('contribution', 'create', $contribParams);
 933
 934     $newParams = array_merge($contribParams, array(
 935       'id' => $contribution['id'],
 936       'contribution_status_id' => 1,)
 937     );
 938     $contribution = civicrm_api('contribution', 'update', $newParams);
 939     $contribution = $contribution['values'][$contribution['id']];
 940     $this->assertEquals($contribution['contribution_status_id'],'1');
 941     $this->_checkFinancialItem($contribution['id'], 'paylater');
 942     $this->_checkFinancialTrxn($contribution, 'payLater');
 943   }
 944
 945   /*
 946    * Function tests that financial records are updated when Payment Instrument is changed
 947    */
 948   function testCreateUpdateContributionPaymentInstrument() {
 949     $instrumentId = $this->_addPaymentInstrument();
 950     $contribParams = array(
 951       'contact_id' => $this->_individualId,
 952       'total_amount' => 100.00,
 953       'financial_type_id' => $this->_contributionTypeId,
 954       'payment_instrument_id' => 4,
 955       'contribution_status_id' => 1,
 956       'version' => $this->_apiversion,
 957     );
 958     $contribution = civicrm_api('contribution', 'create', $contribParams);
 959
 960     $newParams = array_merge($contribParams, array(
 961      'id' => $contribution['id'],
 962      'payment_instrument_id' => $instrumentId,)
 963     );
 964     $contribution = civicrm_api('contribution', 'update', $newParams);
 965     $this->assertAPISuccess($contribution);
 966     $this->_checkFinancialTrxn($contribution, 'paymentInstrument');
 967   }
 968
 969   /*
 970    * Function tests that financial records are added when Contribution is Refunded
 971    */
 972   function testCreateUpdateContributionRefund() {
 973     $contribParams = array(
 974       'contact_id' => $this->_individualId,
 975       'receive_date' => '2012-01-01',
 976       'total_amount' => 100.00,
 977       'financial_type_id' => $this->_contributionTypeId,
 978       'payment_instrument_id' => 4,
 979       'contribution_status_id' => 1,
 980       'version' => $this->_apiversion,
 981     );
 982     $contribution = civicrm_api('contribution', 'create', $contribParams);
 983     $newParams = array_merge($contribParams, array(
 984      'id' => $contribution['id'],
 985      'contribution_status_id' => 7,
 986       )
 987     );
 988
 989     $contribution = civicrm_api('contribution', 'update', $newParams);
 990     $this->_checkFinancialTrxn($contribution, 'refund');
 991     $this->_checkFinancialItem($contribution['id'], 'refund');
 992   }
 993
 994   /*
 995    * Function tests invalid contribution status change
 996    */
 997   function testCreateUpdateContributionInValidStatusChange() {
 998     $contribParams = array(
 999       'contact_id' => 1,
1000       'receive_date' => '2012-01-01',
1001       'total_amount' => 100.00,
1002       'financial_type_id' => 1,
1003       'payment_instrument_id' => 1,
1004       'contribution_status_id' => 1,
1005       'version' => 3,
1006     );
1007     $contribution = civicrm_api('contribution', 'create', $contribParams);
1008     $newParams = array_merge($contribParams, array(
1009      'id' => $contribution['id'],
1010      'contribution_status_id' => 2,
1011       )
1012     );
1013     $contribution = $this->callAPIFailure('contribution', 'update', $newParams);
1014     $this->assertEquals($contribution['error_message'], ts('Cannot change contribution status from Completed to Pending.'), 'In line ' . __LINE__);
1015
1016   }
1017
1018   /*
1019    * Function tests that financial records are added when Pending Contribution is Canceled
1020    */
1021   function testCreateUpdateContributionCancelPending() {
1022     $contribParams = array(
1023       'contact_id' => $this->_individualId,
1024       'receive_date' => '2012-01-01',
1025       'total_amount' => 100.00,
1026       'financial_type_id' => $this->_contributionTypeId,
1027       'payment_instrument_id' => 1,
1028       'contribution_status_id' => 2,
1029       'is_pay_later' => 1,
1030       'version' => $this->_apiversion,
1031     );
1032     $contribution = civicrm_api('contribution', 'create', $contribParams);
1033     $newParams = array_merge($contribParams, array(
1034      'id' => $contribution['id'],
1035      'contribution_status_id' => 3,
1036       )
1037     );
1038     $contribution = civicrm_api('contribution', 'update', $newParams);
1039     $this->_checkFinancialTrxn($contribution, 'cancelPending');
1040     $this->_checkFinancialItem($contribution['id'], 'cancelPending');
1041   }
1042
1043   /*
1044    * Function tests that financial records are added when Financial Type is Changed
1045    */
1046   function testCreateUpdateContributionChangeFinancialType() {
1047     $contribParams = array(
1048       'contact_id' => $this->_individualId,
1049       'receive_date' => '2012-01-01',
1050       'total_amount' => 100.00,
1051       'financial_type_id' => 1,
1052       'payment_instrument_id' => 1,
1053       'contribution_status_id' => 1,
1054       'version' => $this->_apiversion,
1055     );
1056     $contribution = civicrm_api('contribution', 'create', $contribParams);
1057     $newParams = array_merge($contribParams, array(
1058      'id' => $contribution['id'],
1059      'financial_type_id' => 3,
1060       )
1061     );
1062     $contribution = civicrm_api('contribution', 'update', $newParams);
1063     $this->_checkFinancialTrxn($contribution, 'changeFinancial');
1064     $this->_checkFinancialItem($contribution['id'], 'changeFinancial');
1065   }
1066
1067   //To Update Contribution
1068   //CHANGE: we require the API to do an incremental update
1069   function testCreateUpdateContribution() {
1070
1071     $contributionID = $this->contributionCreate($this->_individualId, $this->_contributionTypeId, 'idofsh', 212355);
1072     $old_params = array(
1073       'contribution_id' => $contributionID,
1074       'version' => $this->_apiversion,
1075     );
1076     $original = civicrm_api('contribution', 'get', $old_params);
1077     //Make sure it came back
1078     $this->assertAPISuccess($original, 'In line ' . __LINE__);
1079     $this->assertEquals($original['id'], $contributionID, 'In line ' . __LINE__);
1080     //set up list of old params, verify
1081
1082     //This should not be required on update:
1083     $old_contact_id = $original['values'][$contributionID]['contact_id'];
1084     $old_payment_instrument = $original['values'][$contributionID]['instrument_id'];
1085     $old_fee_amount = $original['values'][$contributionID]['fee_amount'];
1086     $old_source = $original['values'][$contributionID]['contribution_source'];
1087
1088     //note: current behavior is to return ISO.  Is this
1089     //documented behavior?  Is this correct
1090     $old_receive_date = date('Ymd', strtotime($original['values'][$contributionID]['receive_date']));
1091
1092     $old_trxn_id = $original['values'][$contributionID]['trxn_id'];
1093     $old_invoice_id = $original['values'][$contributionID]['invoice_id'];
1094
1095     //check against values in CiviUnitTestCase::createContribution()
1096     $this->assertEquals($old_contact_id, $this->_individualId, 'In line ' . __LINE__);
1097     $this->assertEquals($old_fee_amount, 5.00, 'In line ' . __LINE__);
1098     $this->assertEquals($old_source, 'SSF', 'In line ' . __LINE__);
1099     $this->assertEquals($old_trxn_id, 212355, 'In line ' . __LINE__);
1100     $this->assertEquals($old_invoice_id, 'idofsh', 'In line ' . __LINE__);
1101     $params = array(
1102       'id' => $contributionID,
1103       'contact_id' => $this->_individualId,
1104       'total_amount' => 110.00,
1105       'financial_type_id' => $this->_contributionTypeId,
1106       'non_deductible_amount' => 10.00,
1107       'net_amount' => 100.00,
1108       'contribution_status_id' => 1,
1109       'note' => 'Donating for Nobel Cause',
1110       'version' => $this->_apiversion,
1111     );
1112
1113     $contribution = civicrm_api('contribution', 'create', $params);
1114
1115     $new_params = array(
1116       'contribution_id' => $contribution['id'],
1117       'version' => $this->_apiversion,
1118     );
1119     $contribution = civicrm_api('contribution', 'get', $new_params);
1120
1121     $this->assertEquals($contribution['values'][$contributionID]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
1122     $this->assertEquals($contribution['values'][$contributionID]['total_amount'], 110.00, 'In line ' . __LINE__);
1123         $this->assertEquals($contribution['values'][$contributionID]['financial_type_id'],$this->_contributionTypeId, 'In line ' . __LINE__ );
1124     $this->assertEquals($contribution['values'][$contributionID]['instrument_id'], $old_payment_instrument, 'In line ' . __LINE__);
1125     $this->assertEquals($contribution['values'][$contributionID]['non_deductible_amount'], 10.00, 'In line ' . __LINE__);
1126     $this->assertEquals($contribution['values'][$contributionID]['fee_amount'], $old_fee_amount, 'In line ' . __LINE__);
1127     $this->assertEquals($contribution['values'][$contributionID]['net_amount'], 100.00, 'In line ' . __LINE__);
1128     $this->assertEquals($contribution['values'][$contributionID]['trxn_id'], $old_trxn_id, 'In line ' . __LINE__);
1129     $this->assertEquals($contribution['values'][$contributionID]['invoice_id'], $old_invoice_id, 'In line ' . __LINE__);
1130     $this->assertEquals($contribution['values'][$contributionID]['contribution_source'], $old_source, 'In line ' . __LINE__);
1131     $this->assertEquals($contribution['values'][$contributionID]['contribution_status'], 'Completed', 'In line ' . __LINE__);
1132     $params = array(
1133       'contribution_id' => $contributionID,
1134       'version' => $this->_apiversion,
1135     );
1136     $result = civicrm_api('contribution', 'delete', $params);
1137     $this->assertAPISuccess($result, 'in line' . __LINE__);
1138   }
1139
1140   ///////////////// civicrm_contribution_delete methods
1141   function testDeleteEmptyParamsContribution() {
1142     $params = array('version' => $this->_apiversion);
1143     $contribution = $this->callAPIFailure('contribution', 'delete', $params);
1144   }
1145
1146   function testDeleteParamsNotArrayContribution() {
1147     $params = 'contribution_id= 1';
1148     $contribution = $this->callAPIFailure('contribution', 'delete', $params);
1149     $this->assertEquals($contribution['error_message'], 'Input variable `params` is not an array');
1150   }
1151
1152   function testDeleteWrongParamContribution() {
1153     $params = array(
1154       'contribution_source' => 'SSF',
1155       'version' => $this->_apiversion,
1156     );
1157     $contribution = $this->callAPIFailure('contribution', 'delete', $params);
1158   }
1159
1160   function testDeleteContribution() {
1161
1162     $contributionID = $this->contributionCreate($this->_individualId, $this->_contributionTypeId, 'dfsdf', 12389);
1163     $params = array(
1164       'id' => $contributionID,
1165       'version' => $this->_apiversion,
1166     );
1167     $result = civicrm_api('contribution', 'delete', $params);
1168     $this->documentMe($params, $result, __FUNCTION__, __FILE__);
1169     $this->assertAPISuccess($result, 0, 'In line ' . __LINE__);
1170   }
1171
1172   /**
1173    *  Test civicrm_contribution_search with empty params.
1174    *  All available contributions expected.
1175    */
1176   function testSearchEmptyParams() {
1177     $params = array('version' => $this->_apiversion);
1178
1179     $p = array(
1180       'contact_id' => $this->_individualId,
1181       'receive_date' => date('Ymd'),
1182       'total_amount' => 100.00,
1183       'financial_type_id' => $this->_contributionTypeId,
1184       'non_deductible_amount' => 10.00,
1185       'fee_amount' => 5.00,
1186       'net_amount' => 95.00,
1187       'trxn_id' => 23456,
1188       'invoice_id' => 78910,
1189       'source' => 'SSF',
1190       'contribution_status_id' => 1,
1191       'version' => $this->_apiversion,
1192     );
1193     $contribution = civicrm_api('contribution', 'create', $p);
1194
1195     $result = civicrm_api('contribution', 'get', $params);
1196     // We're taking the first element.
1197     $res = $result['values'][$contribution['id']];
1198
1199     $this->assertEquals($p['contact_id'], $res['contact_id'], 'In line ' . __LINE__);
1200     $this->assertEquals($p['total_amount'], $res['total_amount'], 'In line ' . __LINE__);
1201     $this->assertEquals($p['financial_type_id'], $res['financial_type_id'], 'In line ' . __LINE__ );
1202     $this->assertEquals($p['net_amount'], $res['net_amount'], 'In line ' . __LINE__);
1203     $this->assertEquals($p['non_deductible_amount'], $res['non_deductible_amount'], 'In line ' . __LINE__);
1204     $this->assertEquals($p['fee_amount'], $res['fee_amount'], 'In line ' . __LINE__);
1205     $this->assertEquals($p['trxn_id'], $res['trxn_id'], 'In line ' . __LINE__);
1206     $this->assertEquals($p['invoice_id'], $res['invoice_id'], 'In line ' . __LINE__);
1207     $this->assertEquals($p['source'], $res['contribution_source'], 'In line ' . __LINE__);
1208     // contribution_status_id = 1 => Completed
1209     $this->assertEquals('Completed', $res['contribution_status'], 'In line ' . __LINE__);
1210
1211     $this->contributionDelete($contribution['id']);
1212   }
1213
1214   /**
1215    *  Test civicrm_contribution_search. Success expected.
1216    */
1217   function testSearch() {
1218     $p1 = array(
1219       'contact_id' => $this->_individualId,
1220       'receive_date' => date('Ymd'),
1221       'total_amount' => 100.00,
1222       'financial_type_id' => $this->_contributionTypeId,
1223       'non_deductible_amount' => 10.00,
1224       'contribution_status_id' => 1,
1225       'version' => $this->_apiversion,
1226     );
1227     $contribution1 = civicrm_api('contribution', 'create', $p1);
1228
1229     $p2 = array(
1230       'contact_id' => $this->_individualId,
1231       'receive_date' => date('Ymd'),
1232       'total_amount' => 200.00,
1233       'financial_type_id' => $this->_contributionTypeId,
1234       'non_deductible_amount' => 20.00,
1235       'trxn_id' => 5454565,
1236       'invoice_id' => 1212124,
1237       'fee_amount' => 50.00,
1238       'net_amount' => 60.00,
1239       'contribution_status_id' => 2,
1240       'version' => $this->_apiversion,
1241     );
1242     $contribution2 = $this->callAPISuccess('contribution', 'create', $p2);
1243
1244     $params = array(
1245       'contribution_id' => $contribution2['id'],
1246       'version' => $this->_apiversion,
1247     );
1248     $result = $this->callAPISuccess('contribution', 'get', $params);
1249     $res = $result['values'][$contribution2['id']];
1250
1251     $this->assertEquals($p2['contact_id'], $res['contact_id'], 'In line ' . __LINE__);
1252     $this->assertEquals($p2['total_amount'], $res['total_amount'], 'In line ' . __LINE__);
1253     $this->assertEquals($p2['financial_type_id'], $res['financial_type_id'], 'In line ' . __LINE__ );
1254     $this->assertEquals($p2['net_amount'], $res['net_amount'], 'In line ' . __LINE__);
1255     $this->assertEquals($p2['non_deductible_amount'], $res['non_deductible_amount'], 'In line ' . __LINE__);
1256     $this->assertEquals($p2['fee_amount'], $res['fee_amount'], 'In line ' . __LINE__);
1257     $this->assertEquals($p2['trxn_id'], $res['trxn_id'], 'In line ' . __LINE__);
1258     $this->assertEquals($p2['invoice_id'], $res['invoice_id'], 'In line ' . __LINE__);
1259     // contribution_status_id = 2 => Pending
1260     $this->assertEquals('Pending', $res['contribution_status'], 'In line ' . __LINE__);
1261
1262     $this->contributionDelete($contribution1['id']);
1263     $this->contributionDelete($contribution2['id']);
1264   }
1265
1266   /**
1267    * Test sending a mail via the API
1268    */
1269   function testSendMail() {
1270     $mut = new CiviMailUtils( $this, true );
1271     $contribution = $this->callAPISuccess('contribution','create',$this->_params);
1272     $apiResult = $this->callAPISuccess('contribution', 'sendconfirmation', array(
1273       'version' => $this->_apiversion,
1274       'id' => $contribution['id'],
1275       'receipt_from_email' => 'api@civicrm.org',
1276       )
1277     );
1278     $mut->checkMailLog(array(
1279         '$ 100.00',
1280         'Contribution Information',
1281         'Please print this confirmation for your records',
1282       ), array(
1283         'Event'
1284       )
1285     );
1286     $mut->stop();
1287   }
1288
1289   /**
1290    * Test sending a mail via the API
1291    */
1292   function testSendMailEvent() {
1293     $mut = new CiviMailUtils( $this, true );
1294     $contribution = $this->callAPISuccess('contribution','create',$this->_params);
1295     $event = $this->eventCreate(array(
1296       'is_email_confirm' => 1,
1297       'confirm_from_email' => 'test@civicrm.org',
1298     ));
1299     $this->_eventID = $event['id'];
1300     $participantParams = array(
1301       'contact_id' => $this->_individualId,
1302       'event_id' => $this->_eventID,
1303       'status_id' => 1,
1304       'role_id' => 1,
1305       // to ensure it matches later on
1306       'register_date' => '2007-07-21 00:00:00',
1307       'source' => 'Online Event Registration: API Testing',
1308       'version' => $this->_apiversion,
1309     );
1310     $participant = $this->callAPISuccess('participant', 'create', $participantParams);
1311     $this->callAPISuccess('participant_payment', 'create', array(
1312       'version' => 3,
1313       'participant_id' => $participant['id'],
1314       'contribution_id' => $contribution['id'],
1315     ));
1316     $apiResult = $this->callAPISuccess('contribution', 'sendconfirmation', array(
1317       'version' => $this->_apiversion,
1318       'id' => $contribution['id'],
1319       'receipt_from_email' => 'api@civicrm.org',
1320       )
1321     );
1322
1323     $mut->checkMailLog(array(
1324         'Annual CiviCRM meet',
1325         'Event',
1326         'To: "Mr. Anthony Anderson II" <anthony_anderson@civicrm.org>',
1327       ), array(
1328
1329       )
1330     );
1331     $mut->stop();
1332   }
1333
1334   ///////////////  _civicrm_contribute_format_params for $create
1335   function testFormatParams() {
1336     $params = array(
1337       'contact_id' => $this->_individualId,
1338       'receive_date' => date('Ymd'),
1339       'total_amount' => 100.00,
1340       'financial_type_id' => $this->_contributionTypeId,
1341       'contribution_status_id' => 1,
1342       'financial_type' => null,
1343       'note' => 'note',
1344       'contribution_source' => 'test',
1345     );
1346
1347     $values = array();
1348     $result = _civicrm_api3_contribute_format_params($params, $values, TRUE);
1349     $this->assertEquals($values['total_amount'], 100.00, 'In line ' . __LINE__);
1350     $this->assertEquals($values['contribution_status_id'], 1, 'In line ' . __LINE__);
1351   }
1352   /*
1353      * This function does a GET & compares the result against the $params
1354      * Use as a double check on Creates
1355      */
1356   function contributionGetnCheck($params, $id, $delete = 1) {
1357
1358     $contribution = civicrm_api('Contribution', 'Get', array(
1359       'id' => $id,
1360         'version' => $this->_apiversion,
1361       ));
1362
1363     if ($delete) {
1364       civicrm_api('contribution', 'delete', array(
1365         'id' => $id,
1366           'version' => $this->_apiversion,
1367         ));
1368     }
1369     $this->assertAPISuccess($contribution, 0, 'In line ' . __LINE__);
1370     $values = $contribution['values'][$contribution['id']];
1371     $params['receive_date'] = date('Y-m-d H:i:s', strtotime($params['receive_date']));
1372     // this is not returned in id format
1373     unset($params['payment_instrument_id']);
1374     $params['contribution_source'] = $params['source'];
1375     unset($params['source']);
1376     foreach ($params as $key => $value) {
1377       if ($key == 'version') {
1378         continue;
1379       }
1380       $this->assertEquals($value, $values[$key], $key . " value: $value doesn't match " . print_r($values, TRUE) . 'in line' . __LINE__);
1381     }
1382   }
1383
1384  function _getFinancialTrxnAmount($contId) {
1385    $query = "SELECT
1386      SUM( ft.total_amount ) AS total
1387      FROM civicrm_financial_trxn AS ft
1388      LEFT JOIN civicrm_entity_financial_trxn AS ceft ON ft.id = ceft.financial_trxn_id
1389      WHERE ceft.entity_table = 'civicrm_contribution'
1390      AND ceft.entity_id = {$contId}";
1391
1392    $result = CRM_Core_DAO::singleValueQuery($query);
1393    return $result;
1394  }
1395
1396  function _getFinancialItemAmount($contId) {
1397    $lineItem = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
1398    $query = "SELECT
1399      SUM(amount)
1400      FROM civicrm_financial_item
1401      WHERE entity_table = 'civicrm_line_item'
1402      AND entity_id = {$lineItem}";
1403    $result = CRM_Core_DAO::singleValueQuery($query);
1404    return $result;
1405  }
1406
1407  function _checkFinancialItem($contId, $context) {
1408    if ($context != 'paylater') {
1409      $params = array (
1410        'entity_id' =>   $contId,
1411        'entity_table' => 'civicrm_contribution',
1412      );
1413      $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($params, TRUE));
1414      $entityParams = array(
1415         'financial_trxn_id' => $trxn['financial_trxn_id'],
1416         'entity_table' => 'civicrm_financial_item',
1417      );
1418      $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1419      $params = array(
1420         'id' => $entityTrxn['entity_id'],
1421      );
1422    }
1423    if ($context == 'paylater') {
1424      $lineItems = CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution');
1425      foreach ($lineItems as $key=>$item) {
1426        $params = array(
1427          'entity_id' => $key,
1428          'entity_table' => 'civicrm_line_item',
1429        );
1430        $compareParams = array ('status_id' => 1);
1431        $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
1432      }
1433    }
1434    elseif ($context == 'refund') {
1435      $compareParams = array(
1436        'status_id' => 1,
1437        'financial_account_id' => 1,
1438        'amount' => -100,
1439      );
1440    }
1441    elseif ($context == 'cancelPending') {
1442      $compareParams = array(
1443        'status_id' => 3,
1444        'financial_account_id' => 1,
1445        'amount' => -100,
1446      );
1447    }
1448    elseif ($context == 'changeFinancial') {
1449      $lineKey = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
1450      $params = array(
1451        'entity_id' => $lineKey,
1452        'amount' => -100,
1453      );
1454      $compareParams = array(
1455        'financial_account_id' => 1,
1456      );
1457      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
1458      $params = array(
1459        'financial_account_id' => 3,
1460        'entity_id' => $lineKey,
1461      );
1462      $compareParams = array(
1463        'amount' => 100,
1464      );
1465    }
1466    if ($context != 'paylater') {
1467      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
1468    }
1469  }
1470
1471  function _checkFinancialTrxn($contribution, $context) {
1472    $trxnParams = array(
1473      'entity_id' =>   $contribution['id'],
1474      'entity_table' => 'civicrm_contribution',
1475    );
1476    $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($trxnParams, TRUE));
1477    $params = array(
1478      'id' => $trxn['financial_trxn_id'],
1479    );
1480    if ($context == 'payLater') {
1481      $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
1482      $compareParams = array(
1483        'status_id' => 1,
1484        'from_financial_account_id' => CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId),
1485      );
1486    }
1487    elseif ($context == 'paymentInstrument') {
1488      $compareParams = array(
1489        'from_financial_account_id' => 6,
1490        'to_financial_account_id'  =>  7,
1491      );
1492    }
1493    elseif ($context == 'refund') {
1494      $compareParams = array(
1495        'to_financial_account_id' => 6,
1496        'total_amount' => -100,
1497        'status_id' => 7,
1498      );
1499    }
1500    elseif ($context == 'cancelPending') {
1501      $compareParams = array(
1502        'from_financial_account_id' => 7,
1503        'total_amount' => -100,
1504        'status_id' => 3,
1505      );
1506    }
1507    elseif ($context == 'changeFinancial') {
1508      $entityParams = array(
1509        'entity_id' =>   $contribution['id'],
1510        'entity_table' => 'civicrm_contribution',
1511        'amount' => -100,
1512      );
1513      $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1514      $trxnParams1 = array(
1515         'id' => $trxn['financial_trxn_id'],
1516      );
1517      $compareParams = array(
1518        'to_financial_account_id' => 12,
1519        'total_amount' => -100,
1520        'status_id' => 1,
1521      );
1522      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams1, $compareParams);
1523      $compareParams = array(
1524        'to_financial_account_id' => 12,
1525        'total_amount' => 100,
1526        'status_id' => 1,
1527      );
1528    }
1529
1530    $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $params, $compareParams);
1531  }
1532
1533  function _addPaymentInstrument () {
1534    $gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'payment_instrument', 'id', 'name');
1535    $optionParams = array(
1536      'option_group_id' => $gId,
1537      'label' => 'Test Card',
1538      'name' => 'Test Card',
1539      'value' => '6',
1540      'weight' => '6',
1541      'is_active' => 1,
1542      'version' => 3,
1543 );
1544    $optionValue = civicrm_api('option_value', 'create', $optionParams);
1545    $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
1546    $financialParams = array(
1547      'entity_table' => 'civicrm_option_value',
1548      'entity_id' => $optionValue['id'],
1549      'account_relationship' => $relationTypeId,
1550      'financial_account_id' => 7,
1551    );
1552    $financialType = CRM_Financial_BAO_FinancialTypeAccount::add($financialParams, CRM_Core_DAO::$_nullArray);
1553    $this->assertNotEmpty($optionValue['values'][$optionValue['id']]['value']);
1554    return $optionValue['values'][$optionValue['id']]['value'];
1555  }
1556
1557  function _checkFinancialRecords($params,$context) {
1558    $entityParams = array(
1559      'entity_id' => $params['id'],
1560      'entity_table' => 'civicrm_contribution',
1561    );
1562    if ($context == 'pending') {
1563      $trxn = CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams);
1564      $this->assertNull($trxn, 'No Trxn to be created until IPN callback');
1565      return;
1566    }
1567    $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1568    $trxnParams = array(
1569      'id' => $trxn['financial_trxn_id'],
1570    );
1571    if ($context != 'online' && $context != 'payLater') {
1572      $compareParams = array(
1573        'to_financial_account_id' => 6,
1574        'total_amount' => 100,
1575        'status_id' => 1,
1576      );
1577    }
1578    if ($context == 'feeAmount') {
1579      $compareParams['fee_amount'] = 50;
1580    }
1581    elseif ($context == 'online') {
1582      $compareParams = array(
1583        'to_financial_account_id' => 12,
1584        'total_amount' => 100,
1585        'status_id' => 1,
1586      );
1587    }
1588    elseif ($context == 'payLater') {
1589      $compareParams = array(
1590        'to_financial_account_id' => 7,
1591        'total_amount' => 100,
1592        'status_id' => 2,
1593      );
1594    }
1595    $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn',$trxnParams,$compareParams);
1596    $entityParams = array(
1597      'financial_trxn_id' => $trxn['financial_trxn_id'],
1598      'entity_table' => 'civicrm_financial_item',
1599    );
1600    $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1601    $fitemParams = array(
1602      'id' => $entityTrxn['entity_id'],
1603    );
1604    $compareParams = array(
1605      'amount' => 100,
1606      'status_id' => 1,
1607      'financial_account_id' => 1,
1608    );
1609    if ($context == 'payLater') {
1610      $compareParams = array(
1611        'amount' => 100,
1612        'status_id' => 3,
1613        'financial_account_id' => 1,
1614      );
1615    }
1616    $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
1617    if ($context == 'feeAmount') {
1618      $maxParams = array(
1619        'entity_id' => $params['id'],
1620        'entity_table' => 'civicrm_contribution',
1621      );
1622      $maxTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($maxParams, TRUE));
1623      $trxnParams = array(
1624        'id' => $maxTrxn['financial_trxn_id'],
1625      );
1626      $compareParams = array(
1627        'to_financial_account_id' => 5,
1628        'from_financial_account_id' => 6,
1629        'total_amount' => 50,
1630        'status_id' => 1,
1631      );
1632      $trxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['id'], 'DESC');
1633      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
1634      $fitemParams = array(
1635        'entity_id' => $trxnId['financialTrxnId'],
1636        'entity_table' => 'civicrm_financial_trxn',
1637      );
1638      $compareParams = array(
1639        'amount' => 50,
1640        'status_id' => 1,
1641        'financial_account_id' => 5,
1642      );
1643      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
1644    }
1645  }
1646 }
1647