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