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