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    * test create with valid payment instument
 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    * in the interests of removing financial type / contribution type checks from
 814    * legacy format function lets test that the api is doing this for us
 815    */
 816   function testCreateInvalidFinancialType() {
 817     $params = $this->_params;
 818     $params['financial_type_id'] = 99999;
 819     $result = $this->callAPIFailure($this->_entity, 'create', $params, "'99999' is not a valid option for field financial_type_id");
 820   }
 821
 822   /**
 823    * in the interests of removing financial type / contribution type checks from
 824    * legacy format function lets test that the api is doing this for us
 825    */
 826   function testValidNamedFinancialType() {
 827     $params = $this->_params;
 828     $params['financial_type_id'] = 'Donation';
 829     $result = $this->callAPISuccess($this->_entity, 'create', $params);
 830   }
 831
 832   /**
 833    * Function tests that additional financial records are created when online contribution with pay later option
 834    * is created
 835    */
 836   function testCreateContributionPayLaterOnline() {
 837     $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 838     $this->_pageParams['is_pay_later'] = 1;
 839     $contributionPage = civicrm_api( 'contribution_page','create',$this->_pageParams );
 840     $this->assertAPISuccess($contributionPage);
 841     $params = array(
 842       'contact_id' => $this->_individualId,
 843       'receive_date' => '20120511',
 844       'total_amount' => 100.00,
 845       'financial_type_id' => 1,
 846       'contribution_page_id' => $contributionPage['id'],
 847       'trxn_id' => 12345,
 848       'is_pay_later' => 1,
 849       'invoice_id' => 67890,
 850       'source' => 'SSF',
 851       'contribution_status_id' => 2,
 852       'version' => $this->_apiversion,
 853     );
 854
 855     $contribution = civicrm_api('contribution', 'create', $params);
 856     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 857     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 858     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 859     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1, 'In line ' . __LINE__ );
 860     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345, 'In line ' . __LINE__);
 861     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890, 'In line ' . __LINE__);
 862     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 863     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 2, 'In line ' . __LINE__);
 864     $this->_checkFinancialRecords($contribution, 'payLater');
 865   }
 866
 867   /*
 868    * Function tests that additional financial records are created when online contribution with pending option
 869    * is created
 870    */
 871   function testCreateContributionPendingOnline() {
 872     $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 873     $contributionPage = civicrm_api( '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       'invoice_id' => 67890,
 883       'source' => 'SSF',
 884       'contribution_status_id' => 2,
 885       'version' => $this->_apiversion,
 886     );
 887
 888     $contribution = civicrm_api('contribution', 'create', $params);
 889     $this->documentMe($params, $contribution, __FUNCTION__, __FILE__);
 890     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
 891     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00, 'In line ' . __LINE__);
 892     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'],1, 'In line ' . __LINE__ );
 893     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345, 'In line ' . __LINE__);
 894     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890, 'In line ' . __LINE__);
 895     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF', 'In line ' . __LINE__);
 896     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 2, 'In line ' . __LINE__);
 897     $this->_checkFinancialRecords($contribution, 'pending');
 898   }
 899
 900   /*
 901    * Function tests that line items, financial records are updated when contribution amount is changed
 902    */
 903   function testCreateUpdateContributionChangeTotal() {
 904     $contribution = civicrm_api('contribution', 'create', $this->_params);
 905     $lineItems = civicrm_api('line_item','getvalue', array(
 906       'version' => $this->_apiversion,
 907       'entity_id' => $contribution['id'],
 908       'entity_table' => 'civicrm_contribution',
 909       'sequential' => 1,
 910       'return' => 'line_total',
 911     ));
 912     $this->assertEquals('100.00', $lineItems);
 913     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
 914     // Financial trxn SUM = 100 + 5 (fee)
 915     $this->assertEquals('105.00', $trxnAmount);
 916     $newParams = array(
 917       'version' => $this->_apiversion,
 918       'id' => $contribution['id'],
 919       'total_amount' => '125');
 920     $contribution = civicrm_api('contribution', 'update', $newParams);
 921
 922     $lineItems = civicrm_api('line_item','getvalue',array(
 923         'version' => $this->_apiversion,
 924         'entity_id' => $contribution['id'],
 925         'entity_table' => 'civicrm_contribution',
 926         'sequential' => 1,
 927         'return' => 'line_total',
 928     ));
 929
 930     $this->assertEquals('125.00', $lineItems);
 931     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
 932     $fitemAmount = $this->_getFinancialItemAmount($contribution['id']);
 933     // Financial trxn SUM = 125 + 5 (fee)
 934     $this->assertEquals('130.00', $trxnAmount);
 935     $this->assertEquals('125.00', $fitemAmount);
 936   }
 937
 938   /*
 939    * Function tests that line items, financial records are updated when pay later contribution is received
 940    */
 941   function testCreateUpdateContributionPayLater() {
 942     $contribParams = array(
 943       'contact_id' => $this->_individualId,
 944       'receive_date' => '2012-01-01',
 945       'total_amount' => 100.00,
 946       'financial_type_id' => $this->_contributionTypeId,
 947       'payment_instrument_id' => 1,
 948       'contribution_status_id' => 2,
 949       'is_pay_later' => 1,
 950       'version' => $this->_apiversion,
 951     );
 952     $contribution = civicrm_api('contribution', 'create', $contribParams);
 953
 954     $newParams = array_merge($contribParams, array(
 955       'id' => $contribution['id'],
 956       'contribution_status_id' => 1,)
 957     );
 958     $contribution = civicrm_api('contribution', 'update', $newParams);
 959     $contribution = $contribution['values'][$contribution['id']];
 960     $this->assertEquals($contribution['contribution_status_id'],'1');
 961     $this->_checkFinancialItem($contribution['id'], 'paylater');
 962     $this->_checkFinancialTrxn($contribution, 'payLater');
 963   }
 964
 965   /*
 966    * Function tests that financial records are updated when Payment Instrument is changed
 967    */
 968   function testCreateUpdateContributionPaymentInstrument() {
 969     $instrumentId = $this->_addPaymentInstrument();
 970     $contribParams = array(
 971       'contact_id' => $this->_individualId,
 972       'total_amount' => 100.00,
 973       'financial_type_id' => $this->_contributionTypeId,
 974       'payment_instrument_id' => 4,
 975       'contribution_status_id' => 1,
 976       'version' => $this->_apiversion,
 977     );
 978     $contribution = civicrm_api('contribution', 'create', $contribParams);
 979
 980     $newParams = array_merge($contribParams, array(
 981      'id' => $contribution['id'],
 982      'payment_instrument_id' => $instrumentId,)
 983     );
 984     $contribution = civicrm_api('contribution', 'update', $newParams);
 985     $this->assertAPISuccess($contribution);
 986     $this->_checkFinancialTrxn($contribution, 'paymentInstrument');
 987   }
 988
 989   /*
 990    * Function tests that financial records are added when Contribution is Refunded
 991    */
 992   function testCreateUpdateContributionRefund() {
 993     $contribParams = array(
 994       'contact_id' => $this->_individualId,
 995       'receive_date' => '2012-01-01',
 996       'total_amount' => 100.00,
 997       'financial_type_id' => $this->_contributionTypeId,
 998       'payment_instrument_id' => 4,
 999       'contribution_status_id' => 1,
1000       'version' => $this->_apiversion,
1001     );
1002     $contribution = civicrm_api('contribution', 'create', $contribParams);
1003     $newParams = array_merge($contribParams, array(
1004      'id' => $contribution['id'],
1005      'contribution_status_id' => 7,
1006       )
1007     );
1008
1009     $contribution = civicrm_api('contribution', 'update', $newParams);
1010     $this->_checkFinancialTrxn($contribution, 'refund');
1011     $this->_checkFinancialItem($contribution['id'], 'refund');
1012   }
1013
1014   /*
1015    * Function tests invalid contribution status change
1016    */
1017   function testCreateUpdateContributionInValidStatusChange() {
1018     $contribParams = array(
1019       'contact_id' => 1,
1020       'receive_date' => '2012-01-01',
1021       'total_amount' => 100.00,
1022       'financial_type_id' => 1,
1023       'payment_instrument_id' => 1,
1024       'contribution_status_id' => 1,
1025       'version' => 3,
1026     );
1027     $contribution = civicrm_api('contribution', 'create', $contribParams);
1028     $newParams = array_merge($contribParams, array(
1029      'id' => $contribution['id'],
1030      'contribution_status_id' => 2,
1031       )
1032     );
1033     $contribution = $this->callAPIFailure('contribution', 'update', $newParams);
1034     $this->assertEquals($contribution['error_message'], ts('Cannot change contribution status from Completed to Pending.'), 'In line ' . __LINE__);
1035
1036   }
1037
1038   /*
1039    * Function tests that financial records are added when Pending Contribution is Canceled
1040    */
1041   function testCreateUpdateContributionCancelPending() {
1042     $contribParams = array(
1043       'contact_id' => $this->_individualId,
1044       'receive_date' => '2012-01-01',
1045       'total_amount' => 100.00,
1046       'financial_type_id' => $this->_contributionTypeId,
1047       'payment_instrument_id' => 1,
1048       'contribution_status_id' => 2,
1049       'is_pay_later' => 1,
1050       'version' => $this->_apiversion,
1051     );
1052     $contribution = civicrm_api('contribution', 'create', $contribParams);
1053     $newParams = array_merge($contribParams, array(
1054      'id' => $contribution['id'],
1055      'contribution_status_id' => 3,
1056       )
1057     );
1058     $contribution = civicrm_api('contribution', 'update', $newParams);
1059     $this->_checkFinancialTrxn($contribution, 'cancelPending');
1060     $this->_checkFinancialItem($contribution['id'], 'cancelPending');
1061   }
1062
1063   /*
1064    * Function tests that financial records are added when Financial Type is Changed
1065    */
1066   function testCreateUpdateContributionChangeFinancialType() {
1067     $contribParams = array(
1068       'contact_id' => $this->_individualId,
1069       'receive_date' => '2012-01-01',
1070       'total_amount' => 100.00,
1071       'financial_type_id' => 1,
1072       'payment_instrument_id' => 1,
1073       'contribution_status_id' => 1,
1074       'version' => $this->_apiversion,
1075     );
1076     $contribution = civicrm_api('contribution', 'create', $contribParams);
1077     $newParams = array_merge($contribParams, array(
1078      'id' => $contribution['id'],
1079      'financial_type_id' => 3,
1080       )
1081     );
1082     $contribution = civicrm_api('contribution', 'update', $newParams);
1083     $this->_checkFinancialTrxn($contribution, 'changeFinancial');
1084     $this->_checkFinancialItem($contribution['id'], 'changeFinancial');
1085   }
1086
1087   //To Update Contribution
1088   //CHANGE: we require the API to do an incremental update
1089   function testCreateUpdateContribution() {
1090
1091     $contributionID = $this->contributionCreate($this->_individualId, $this->_contributionTypeId, 'idofsh', 212355);
1092     $old_params = array(
1093       'contribution_id' => $contributionID,
1094       'version' => $this->_apiversion,
1095     );
1096     $original = civicrm_api('contribution', 'get', $old_params);
1097     //Make sure it came back
1098     $this->assertAPISuccess($original, 'In line ' . __LINE__);
1099     $this->assertEquals($original['id'], $contributionID, 'In line ' . __LINE__);
1100     //set up list of old params, verify
1101
1102     //This should not be required on update:
1103     $old_contact_id = $original['values'][$contributionID]['contact_id'];
1104     $old_payment_instrument = $original['values'][$contributionID]['instrument_id'];
1105     $old_fee_amount = $original['values'][$contributionID]['fee_amount'];
1106     $old_source = $original['values'][$contributionID]['contribution_source'];
1107
1108     //note: current behavior is to return ISO.  Is this
1109     //documented behavior?  Is this correct
1110     $old_receive_date = date('Ymd', strtotime($original['values'][$contributionID]['receive_date']));
1111
1112     $old_trxn_id = $original['values'][$contributionID]['trxn_id'];
1113     $old_invoice_id = $original['values'][$contributionID]['invoice_id'];
1114
1115     //check against values in CiviUnitTestCase::createContribution()
1116     $this->assertEquals($old_contact_id, $this->_individualId, 'In line ' . __LINE__);
1117     $this->assertEquals($old_fee_amount, 5.00, 'In line ' . __LINE__);
1118     $this->assertEquals($old_source, 'SSF', 'In line ' . __LINE__);
1119     $this->assertEquals($old_trxn_id, 212355, 'In line ' . __LINE__);
1120     $this->assertEquals($old_invoice_id, 'idofsh', 'In line ' . __LINE__);
1121     $params = array(
1122       'id' => $contributionID,
1123       'contact_id' => $this->_individualId,
1124       'total_amount' => 110.00,
1125       'financial_type_id' => $this->_contributionTypeId,
1126       'non_deductible_amount' => 10.00,
1127       'net_amount' => 100.00,
1128       'contribution_status_id' => 1,
1129       'note' => 'Donating for Nobel Cause',
1130       'version' => $this->_apiversion,
1131     );
1132
1133     $contribution = civicrm_api('contribution', 'create', $params);
1134
1135     $new_params = array(
1136       'contribution_id' => $contribution['id'],
1137       'version' => $this->_apiversion,
1138     );
1139     $contribution = civicrm_api('contribution', 'get', $new_params);
1140
1141     $this->assertEquals($contribution['values'][$contributionID]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
1142     $this->assertEquals($contribution['values'][$contributionID]['total_amount'], 110.00, 'In line ' . __LINE__);
1143         $this->assertEquals($contribution['values'][$contributionID]['financial_type_id'],$this->_contributionTypeId, 'In line ' . __LINE__ );
1144     $this->assertEquals($contribution['values'][$contributionID]['instrument_id'], $old_payment_instrument, 'In line ' . __LINE__);
1145     $this->assertEquals($contribution['values'][$contributionID]['non_deductible_amount'], 10.00, 'In line ' . __LINE__);
1146     $this->assertEquals($contribution['values'][$contributionID]['fee_amount'], $old_fee_amount, 'In line ' . __LINE__);
1147     $this->assertEquals($contribution['values'][$contributionID]['net_amount'], 100.00, 'In line ' . __LINE__);
1148     $this->assertEquals($contribution['values'][$contributionID]['trxn_id'], $old_trxn_id, 'In line ' . __LINE__);
1149     $this->assertEquals($contribution['values'][$contributionID]['invoice_id'], $old_invoice_id, 'In line ' . __LINE__);
1150     $this->assertEquals($contribution['values'][$contributionID]['contribution_source'], $old_source, 'In line ' . __LINE__);
1151     $this->assertEquals($contribution['values'][$contributionID]['contribution_status'], 'Completed', 'In line ' . __LINE__);
1152     $params = array(
1153       'contribution_id' => $contributionID,
1154       'version' => $this->_apiversion,
1155     );
1156     $result = civicrm_api('contribution', 'delete', $params);
1157     $this->assertAPISuccess($result, 'in line' . __LINE__);
1158   }
1159
1160   ///////////////// civicrm_contribution_delete methods
1161   function testDeleteEmptyParamsContribution() {
1162     $params = array('version' => $this->_apiversion);
1163     $contribution = $this->callAPIFailure('contribution', 'delete', $params);
1164   }
1165
1166   function testDeleteParamsNotArrayContribution() {
1167     $params = 'contribution_id= 1';
1168     $contribution = $this->callAPIFailure('contribution', 'delete', $params);
1169     $this->assertEquals($contribution['error_message'], 'Input variable `params` is not an array');
1170   }
1171
1172   function testDeleteWrongParamContribution() {
1173     $params = array(
1174       'contribution_source' => 'SSF',
1175       'version' => $this->_apiversion,
1176     );
1177     $contribution = $this->callAPIFailure('contribution', 'delete', $params);
1178   }
1179
1180   function testDeleteContribution() {
1181
1182     $contributionID = $this->contributionCreate($this->_individualId, $this->_contributionTypeId, 'dfsdf', 12389);
1183     $params = array(
1184       'id' => $contributionID,
1185       'version' => $this->_apiversion,
1186     );
1187     $result = civicrm_api('contribution', 'delete', $params);
1188     $this->documentMe($params, $result, __FUNCTION__, __FILE__);
1189     $this->assertAPISuccess($result, 0, 'In line ' . __LINE__);
1190   }
1191
1192   /**
1193    *  Test civicrm_contribution_search with empty params.
1194    *  All available contributions expected.
1195    */
1196   function testSearchEmptyParams() {
1197     $params = array('version' => $this->_apiversion);
1198
1199     $p = array(
1200       'contact_id' => $this->_individualId,
1201       'receive_date' => date('Ymd'),
1202       'total_amount' => 100.00,
1203       'financial_type_id' => $this->_contributionTypeId,
1204       'non_deductible_amount' => 10.00,
1205       'fee_amount' => 5.00,
1206       'net_amount' => 95.00,
1207       'trxn_id' => 23456,
1208       'invoice_id' => 78910,
1209       'source' => 'SSF',
1210       'contribution_status_id' => 1,
1211       'version' => $this->_apiversion,
1212     );
1213     $contribution = civicrm_api('contribution', 'create', $p);
1214
1215     $result = civicrm_api('contribution', 'get', $params);
1216     // We're taking the first element.
1217     $res = $result['values'][$contribution['id']];
1218
1219     $this->assertEquals($p['contact_id'], $res['contact_id'], 'In line ' . __LINE__);
1220     $this->assertEquals($p['total_amount'], $res['total_amount'], 'In line ' . __LINE__);
1221     $this->assertEquals($p['financial_type_id'], $res['financial_type_id'], 'In line ' . __LINE__ );
1222     $this->assertEquals($p['net_amount'], $res['net_amount'], 'In line ' . __LINE__);
1223     $this->assertEquals($p['non_deductible_amount'], $res['non_deductible_amount'], 'In line ' . __LINE__);
1224     $this->assertEquals($p['fee_amount'], $res['fee_amount'], 'In line ' . __LINE__);
1225     $this->assertEquals($p['trxn_id'], $res['trxn_id'], 'In line ' . __LINE__);
1226     $this->assertEquals($p['invoice_id'], $res['invoice_id'], 'In line ' . __LINE__);
1227     $this->assertEquals($p['source'], $res['contribution_source'], 'In line ' . __LINE__);
1228     // contribution_status_id = 1 => Completed
1229     $this->assertEquals('Completed', $res['contribution_status'], 'In line ' . __LINE__);
1230
1231     $this->contributionDelete($contribution['id']);
1232   }
1233
1234   /**
1235    *  Test civicrm_contribution_search. Success expected.
1236    */
1237   function testSearch() {
1238     $p1 = array(
1239       'contact_id' => $this->_individualId,
1240       'receive_date' => date('Ymd'),
1241       'total_amount' => 100.00,
1242       'financial_type_id' => $this->_contributionTypeId,
1243       'non_deductible_amount' => 10.00,
1244       'contribution_status_id' => 1,
1245       'version' => $this->_apiversion,
1246     );
1247     $contribution1 = civicrm_api('contribution', 'create', $p1);
1248
1249     $p2 = array(
1250       'contact_id' => $this->_individualId,
1251       'receive_date' => date('Ymd'),
1252       'total_amount' => 200.00,
1253       'financial_type_id' => $this->_contributionTypeId,
1254       'non_deductible_amount' => 20.00,
1255       'trxn_id' => 5454565,
1256       'invoice_id' => 1212124,
1257       'fee_amount' => 50.00,
1258       'net_amount' => 60.00,
1259       'contribution_status_id' => 2,
1260       'version' => $this->_apiversion,
1261     );
1262     $contribution2 = $this->callAPISuccess('contribution', 'create', $p2);
1263
1264     $params = array(
1265       'contribution_id' => $contribution2['id'],
1266       'version' => $this->_apiversion,
1267     );
1268     $result = $this->callAPISuccess('contribution', 'get', $params);
1269     $res = $result['values'][$contribution2['id']];
1270
1271     $this->assertEquals($p2['contact_id'], $res['contact_id'], 'In line ' . __LINE__);
1272     $this->assertEquals($p2['total_amount'], $res['total_amount'], 'In line ' . __LINE__);
1273     $this->assertEquals($p2['financial_type_id'], $res['financial_type_id'], 'In line ' . __LINE__ );
1274     $this->assertEquals($p2['net_amount'], $res['net_amount'], 'In line ' . __LINE__);
1275     $this->assertEquals($p2['non_deductible_amount'], $res['non_deductible_amount'], 'In line ' . __LINE__);
1276     $this->assertEquals($p2['fee_amount'], $res['fee_amount'], 'In line ' . __LINE__);
1277     $this->assertEquals($p2['trxn_id'], $res['trxn_id'], 'In line ' . __LINE__);
1278     $this->assertEquals($p2['invoice_id'], $res['invoice_id'], 'In line ' . __LINE__);
1279     // contribution_status_id = 2 => Pending
1280     $this->assertEquals('Pending', $res['contribution_status'], 'In line ' . __LINE__);
1281
1282     $this->contributionDelete($contribution1['id']);
1283     $this->contributionDelete($contribution2['id']);
1284   }
1285
1286   /**
1287    * Test completing a transaction via the API
1288    *
1289    * Note that we are creating a logged in user because email goes out from
1290    * that person
1291    */
1292   function testCompleteTransaction() {
1293     $mut = new CiviMailUtils( $this, true );
1294     $this->createLoggedInUser();
1295     $params = array_merge($this->_params, array('contribution_status_id' => 1,));
1296     $contribution = $this->callAPISuccess('contribution','create', $params);
1297     $apiResult = $this->callAPISuccess('contribution', 'completetransaction', array(
1298       'id' => $contribution['id'],
1299     )
1300     );
1301     $contribution = $this->callAPISuccess('contribution', 'get', array('id' => $contribution['id'], 'sequential' => 1,));
1302     $this->assertEquals('Completed', $contribution['values'][0]['contribution_status']);
1303     $mut->checkMailLog(array(
1304       'Receipt - Contribution',
1305       'Please print this confirmation for your records.',
1306     ));
1307     $mut->stop();
1308   }
1309
1310   /**
1311    * Test completing a transaction with an event via the API
1312    *
1313    * Note that we are creating a logged in user because email goes out from
1314    * that person
1315    */
1316   function testCompleteTransactionWithParticipantRecord() {
1317     $mut = new CiviMailUtils( $this, true );
1318     $mut->clearMessages();
1319     $this->createLoggedInUser();
1320     $contributionID = $this->createPendingParticipantContribution();
1321     $apiResult = $this->callAPISuccess('contribution', 'completetransaction', array(
1322       'id' => $contributionID,
1323     )
1324     );
1325     $participantStatus = $this->callAPISuccessGetValue('participant', array('id' => $this->ids['participant'], 'return' => 'participant_status_id'));
1326     $this->assertEquals(1, $participantStatus);
1327     $mut->checkMailLog(array(
1328       'Annual CiviCRM meet',
1329       'Event',
1330       'This letter is a confirmation that your registration has been received and your status has been updated to registered for the following',
1331     ));
1332   $mut->stop();
1333
1334   }
1335
1336   /**
1337    * Test sending a mail via the API
1338    */
1339   function testSendMail() {
1340     $mut = new CiviMailUtils( $this, true );
1341     $contribution = $this->callAPISuccess('contribution','create',$this->_params);
1342     $apiResult = $this->callAPISuccess('contribution', 'sendconfirmation', array(
1343       'version' => $this->_apiversion,
1344       'id' => $contribution['id'],
1345       'receipt_from_email' => 'api@civicrm.org',
1346       )
1347     );
1348     $mut->checkMailLog(array(
1349         '$ 100.00',
1350         'Contribution Information',
1351         'Please print this confirmation for your records',
1352       ), array(
1353         'Event'
1354       )
1355     );
1356     $mut->stop();
1357   }
1358
1359   /**
1360    * Test sending a mail via the API
1361    */
1362   function testSendMailEvent() {
1363     $mut = new CiviMailUtils( $this, true );
1364     $contribution = $this->callAPISuccess('contribution','create',$this->_params);
1365     $event = $this->eventCreate(array(
1366       'is_email_confirm' => 1,
1367       'confirm_from_email' => 'test@civicrm.org',
1368     ));
1369     $this->_eventID = $event['id'];
1370     $participantParams = array(
1371       'contact_id' => $this->_individualId,
1372       'event_id' => $this->_eventID,
1373       'status_id' => 1,
1374       'role_id' => 1,
1375       // to ensure it matches later on
1376       'register_date' => '2007-07-21 00:00:00',
1377       'source' => 'Online Event Registration: API Testing',
1378       'version' => $this->_apiversion,
1379     );
1380     $participant = $this->callAPISuccess('participant', 'create', $participantParams);
1381     $this->callAPISuccess('participant_payment', 'create', array(
1382       'version' => 3,
1383       'participant_id' => $participant['id'],
1384       'contribution_id' => $contribution['id'],
1385     ));
1386     $apiResult = $this->callAPISuccess('contribution', 'sendconfirmation', array(
1387       'version' => $this->_apiversion,
1388       'id' => $contribution['id'],
1389       'receipt_from_email' => 'api@civicrm.org',
1390       )
1391     );
1392
1393     $mut->checkMailLog(array(
1394         'Annual CiviCRM meet',
1395         'Event',
1396         'To: "Mr. Anthony Anderson II" <anthony_anderson@civicrm.org>',
1397       ), array(
1398
1399       )
1400     );
1401     $mut->stop();
1402   }
1403
1404   /**
1405   * This function does a GET & compares the result against the $params
1406   * Use as a double check on Creates
1407   */
1408   function contributionGetnCheck($params, $id, $delete = 1) {
1409
1410     $contribution = civicrm_api('Contribution', 'Get', array(
1411       'id' => $id,
1412         'version' => $this->_apiversion,
1413       ));
1414
1415     if ($delete) {
1416       civicrm_api('contribution', 'delete', array(
1417         'id' => $id,
1418           'version' => $this->_apiversion,
1419         ));
1420     }
1421     $this->assertAPISuccess($contribution, 0, 'In line ' . __LINE__);
1422     $values = $contribution['values'][$contribution['id']];
1423     $params['receive_date'] = date('Y-m-d H:i:s', strtotime($params['receive_date']));
1424     // this is not returned in id format
1425     unset($params['payment_instrument_id']);
1426     $params['contribution_source'] = $params['source'];
1427     unset($params['source']);
1428     foreach ($params as $key => $value) {
1429       if ($key == 'version') {
1430         continue;
1431       }
1432       $this->assertEquals($value, $values[$key], $key . " value: $value doesn't match " . print_r($values, TRUE) . 'in line' . __LINE__);
1433     }
1434   }
1435
1436   /**
1437    * Create a pending contribution & linked pending participant record
1438    * (along with an event)
1439    */
1440   function createPendingParticipantContribution(){
1441     $event = $this->eventCreate(array('is_email_confirm' => 1, 'confirm_from_email' => 'test@civicrm.org',));
1442     $participantID = $this->participantCreate(array('event_id' => $event['id'], 'status_id' => 6));
1443     $this->ids['participant']  = $participantID;
1444     $params = array_merge($this->_params, array('contribution_status_id' => 2, 'financial_type_id' => 'Event Fee'));
1445     $contribution = $this->callAPISuccess('contribution','create', $params);
1446     $this->callAPISuccess('participant_payment', 'create', array('contribution_id' => $contribution['id'], 'participant_id' => $participantID));
1447     $lineItem = $this->callAPISuccess('line_item', 'get', array(
1448       'entity_id' => $contribution['id'],
1449       'entity_table' => 'civicrm_contribution',
1450       'api.line_item.create' => array(
1451         'entity_id' => $participantID,
1452         'entity_table' => 'civicrm_participant',
1453       ),
1454     ));
1455     return $contribution['id'];
1456   }
1457
1458  function _getFinancialTrxnAmount($contId) {
1459    $query = "SELECT
1460      SUM( ft.total_amount ) AS total
1461      FROM civicrm_financial_trxn AS ft
1462      LEFT JOIN civicrm_entity_financial_trxn AS ceft ON ft.id = ceft.financial_trxn_id
1463      WHERE ceft.entity_table = 'civicrm_contribution'
1464      AND ceft.entity_id = {$contId}";
1465
1466    $result = CRM_Core_DAO::singleValueQuery($query);
1467    return $result;
1468  }
1469
1470  function _getFinancialItemAmount($contId) {
1471    $lineItem = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
1472    $query = "SELECT
1473      SUM(amount)
1474      FROM civicrm_financial_item
1475      WHERE entity_table = 'civicrm_line_item'
1476      AND entity_id = {$lineItem}";
1477    $result = CRM_Core_DAO::singleValueQuery($query);
1478    return $result;
1479  }
1480
1481  function _checkFinancialItem($contId, $context) {
1482    if ($context != 'paylater') {
1483      $params = array (
1484        'entity_id' =>   $contId,
1485        'entity_table' => 'civicrm_contribution',
1486      );
1487      $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($params, TRUE));
1488      $entityParams = array(
1489         'financial_trxn_id' => $trxn['financial_trxn_id'],
1490         'entity_table' => 'civicrm_financial_item',
1491      );
1492      $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1493      $params = array(
1494         'id' => $entityTrxn['entity_id'],
1495      );
1496    }
1497    if ($context == 'paylater') {
1498      $lineItems = CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution');
1499      foreach ($lineItems as $key=>$item) {
1500        $params = array(
1501          'entity_id' => $key,
1502          'entity_table' => 'civicrm_line_item',
1503        );
1504        $compareParams = array ('status_id' => 1);
1505        $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
1506      }
1507    }
1508    elseif ($context == 'refund') {
1509      $compareParams = array(
1510        'status_id' => 1,
1511        'financial_account_id' => 1,
1512        'amount' => -100,
1513      );
1514    }
1515    elseif ($context == 'cancelPending') {
1516      $compareParams = array(
1517        'status_id' => 3,
1518        'financial_account_id' => 1,
1519        'amount' => -100,
1520      );
1521    }
1522    elseif ($context == 'changeFinancial') {
1523      $lineKey = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
1524      $params = array(
1525        'entity_id' => $lineKey,
1526        'amount' => -100,
1527      );
1528      $compareParams = array(
1529        'financial_account_id' => 1,
1530      );
1531      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
1532      $params = array(
1533        'financial_account_id' => 3,
1534        'entity_id' => $lineKey,
1535      );
1536      $compareParams = array(
1537        'amount' => 100,
1538      );
1539    }
1540    if ($context != 'paylater') {
1541      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
1542    }
1543  }
1544
1545  function _checkFinancialTrxn($contribution, $context) {
1546    $trxnParams = array(
1547      'entity_id' =>   $contribution['id'],
1548      'entity_table' => 'civicrm_contribution',
1549    );
1550    $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($trxnParams, TRUE));
1551    $params = array(
1552      'id' => $trxn['financial_trxn_id'],
1553    );
1554    if ($context == 'payLater') {
1555      $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
1556      $compareParams = array(
1557        'status_id' => 1,
1558        'from_financial_account_id' => CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId),
1559      );
1560    }
1561    elseif ($context == 'paymentInstrument') {
1562      $compareParams = array(
1563        'from_financial_account_id' => 6,
1564        'to_financial_account_id'  =>  7,
1565      );
1566    }
1567    elseif ($context == 'refund') {
1568      $compareParams = array(
1569        'to_financial_account_id' => 6,
1570        'total_amount' => -100,
1571        'status_id' => 7,
1572      );
1573    }
1574    elseif ($context == 'cancelPending') {
1575      $compareParams = array(
1576        'from_financial_account_id' => 7,
1577        'total_amount' => -100,
1578        'status_id' => 3,
1579      );
1580    }
1581    elseif ($context == 'changeFinancial') {
1582      $entityParams = array(
1583        'entity_id' =>   $contribution['id'],
1584        'entity_table' => 'civicrm_contribution',
1585        'amount' => -100,
1586      );
1587      $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1588      $trxnParams1 = array(
1589         'id' => $trxn['financial_trxn_id'],
1590      );
1591      $compareParams = array(
1592        'to_financial_account_id' => 12,
1593        'total_amount' => -100,
1594        'status_id' => 1,
1595      );
1596      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams1, $compareParams);
1597      $compareParams = array(
1598        'to_financial_account_id' => 12,
1599        'total_amount' => 100,
1600        'status_id' => 1,
1601      );
1602    }
1603
1604    $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $params, $compareParams);
1605  }
1606
1607  function _addPaymentInstrument () {
1608    $gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'payment_instrument', 'id', 'name');
1609    $optionParams = array(
1610      'option_group_id' => $gId,
1611      'label' => 'Test Card',
1612      'name' => 'Test Card',
1613      'value' => '6',
1614      'weight' => '6',
1615      'is_active' => 1,
1616      'version' => 3,
1617 );
1618    $optionValue = civicrm_api('option_value', 'create', $optionParams);
1619    $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
1620    $financialParams = array(
1621      'entity_table' => 'civicrm_option_value',
1622      'entity_id' => $optionValue['id'],
1623      'account_relationship' => $relationTypeId,
1624      'financial_account_id' => 7,
1625    );
1626    $financialType = CRM_Financial_BAO_FinancialTypeAccount::add($financialParams, CRM_Core_DAO::$_nullArray);
1627    $this->assertNotEmpty($optionValue['values'][$optionValue['id']]['value']);
1628    return $optionValue['values'][$optionValue['id']]['value'];
1629  }
1630
1631  function _checkFinancialRecords($params,$context) {
1632    $entityParams = array(
1633      'entity_id' => $params['id'],
1634      'entity_table' => 'civicrm_contribution',
1635    );
1636    if ($context == 'pending') {
1637      $trxn = CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams);
1638      $this->assertNull($trxn, 'No Trxn to be created until IPN callback');
1639      return;
1640    }
1641    $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1642    $trxnParams = array(
1643      'id' => $trxn['financial_trxn_id'],
1644    );
1645    if ($context != 'online' && $context != 'payLater') {
1646      $compareParams = array(
1647        'to_financial_account_id' => 6,
1648        'total_amount' => 100,
1649        'status_id' => 1,
1650      );
1651    }
1652    if ($context == 'feeAmount') {
1653      $compareParams['fee_amount'] = 50;
1654    }
1655    elseif ($context == 'online') {
1656      $compareParams = array(
1657        'to_financial_account_id' => 12,
1658        'total_amount' => 100,
1659        'status_id' => 1,
1660      );
1661    }
1662    elseif ($context == 'payLater') {
1663      $compareParams = array(
1664        'to_financial_account_id' => 7,
1665        'total_amount' => 100,
1666        'status_id' => 2,
1667      );
1668    }
1669    $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn',$trxnParams,$compareParams);
1670    $entityParams = array(
1671      'financial_trxn_id' => $trxn['financial_trxn_id'],
1672      'entity_table' => 'civicrm_financial_item',
1673    );
1674    $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
1675    $fitemParams = array(
1676      'id' => $entityTrxn['entity_id'],
1677    );
1678    $compareParams = array(
1679      'amount' => 100,
1680      'status_id' => 1,
1681      'financial_account_id' => 1,
1682    );
1683    if ($context == 'payLater') {
1684      $compareParams = array(
1685        'amount' => 100,
1686        'status_id' => 3,
1687        'financial_account_id' => 1,
1688      );
1689    }
1690    $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
1691    if ($context == 'feeAmount') {
1692      $maxParams = array(
1693        'entity_id' => $params['id'],
1694        'entity_table' => 'civicrm_contribution',
1695      );
1696      $maxTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($maxParams, TRUE));
1697      $trxnParams = array(
1698        'id' => $maxTrxn['financial_trxn_id'],
1699      );
1700      $compareParams = array(
1701        'to_financial_account_id' => 5,
1702        'from_financial_account_id' => 6,
1703        'total_amount' => 50,
1704        'status_id' => 1,
1705      );
1706      $trxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['id'], 'DESC');
1707      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
1708      $fitemParams = array(
1709        'entity_id' => $trxnId['financialTrxnId'],
1710        'entity_table' => 'civicrm_financial_trxn',
1711      );
1712      $compareParams = array(
1713        'amount' => 50,
1714        'status_id' => 1,
1715        'financial_account_id' => 5,
1716      );
1717      $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
1718    }
1719  }
1720 }
1721