tests/phpunit/api/v3/ContributionTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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 /**
  29  *  Test APIv3 civicrm_contribute_* functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Contribution
  33  * @group headless
  34  */
  35 class api_v3_ContributionTest extends CiviUnitTestCase {
  36
  37   /**
  38    * Assume empty database with just civicrm_data.
  39    */
  40   protected $_individualId;
  41   protected $_contribution;
  42   protected $_financialTypeId = 1;
  43   protected $_apiversion;
  44   protected $_entity = 'Contribution';
  45   public $debug = 0;
  46   protected $_params;
  47   protected $_ids = array();
  48   protected $_pageParams = array();
  49   /**
  50    * Payment processor ID (dummy processor).
  51    *
  52    * @var int
  53    */
  54   protected $paymentProcessorID;
  55
  56   /**
  57    * Parameters to create payment processor.
  58    *
  59    * @var array
  60    */
  61   protected $_processorParams = array();
  62
  63   /**
  64    * ID of created event.
  65    *
  66    * @var int
  67    */
  68   protected $_eventID;
  69
  70   /**
  71    * @var CiviMailUtils
  72    */
  73   protected $mut;
  74
  75   /**
  76    * Setup function.
  77    */
  78   public function setUp() {
  79     parent::setUp();
  80
  81     $this->_apiversion = 3;
  82     $this->_individualId = $this->individualCreate();
  83     $this->_params = array(
  84       'contact_id' => $this->_individualId,
  85       'receive_date' => '20120511',
  86       'total_amount' => 100.00,
  87       'financial_type_id' => $this->_financialTypeId,
  88       'non_deductible_amount' => 10.00,
  89       'fee_amount' => 5.00,
  90       'net_amount' => 95.00,
  91       'source' => 'SSF',
  92       'contribution_status_id' => 1,
  93     );
  94     $this->_processorParams = array(
  95       'domain_id' => 1,
  96       'name' => 'Dummy',
  97       'payment_processor_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Financial_BAO_PaymentProcessor', 'payment_processor_type_id', 'Dummy'),
  98       'financial_account_id' => 12,
  99       'is_active' => 1,
 100       'user_name' => '',
 101       'url_site' => 'http://dummy.com',
 102       'url_recur' => 'http://dummy.com',
 103       'billing_mode' => 1,
 104     );
 105     $this->paymentProcessorID = $this->processorCreate();
 106     $this->_pageParams = array(
 107       'title' => 'Test Contribution Page',
 108       'financial_type_id' => 1,
 109       'currency' => 'USD',
 110       'financial_account_id' => 1,
 111       'payment_processor' => $this->paymentProcessorID,
 112       'is_active' => 1,
 113       'is_allow_other_amount' => 1,
 114       'min_amount' => 10,
 115       'max_amount' => 1000,
 116     );
 117   }
 118
 119   /**
 120    * Clean up after each test.
 121    */
 122   public function tearDown() {
 123     $this->quickCleanUpFinancialEntities();
 124     $this->quickCleanup(array('civicrm_uf_match'));
 125   }
 126
 127   /**
 128    * Test Get.
 129    */
 130   public function testGetContribution() {
 131     $p = array(
 132       'contact_id' => $this->_individualId,
 133       'receive_date' => '2010-01-20',
 134       'total_amount' => 100.00,
 135       'financial_type_id' => $this->_financialTypeId,
 136       'non_deductible_amount' => 10.00,
 137       'fee_amount' => 5.00,
 138       'net_amount' => 95.00,
 139       'trxn_id' => 23456,
 140       'invoice_id' => 78910,
 141       'source' => 'SSF',
 142       'contribution_status_id' => 1,
 143     );
 144     $this->_contribution = $this->callAPISuccess('contribution', 'create', $p);
 145
 146     $params = array(
 147       'contribution_id' => $this->_contribution['id'],
 148     );
 149
 150     $contribution = $this->callAPIAndDocument('contribution', 'get', $params, __FUNCTION__, __FILE__);
 151     $financialParams['id'] = $this->_financialTypeId;
 152     $default = NULL;
 153     CRM_Financial_BAO_FinancialType::retrieve($financialParams, $default);
 154
 155     $this->assertEquals(1, $contribution['count']);
 156     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 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.
 159     // If it is to be introduced we should discuss.
 160     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 161     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 162     $this->assertEquals($contribution['values'][$contribution['id']]['non_deductible_amount'], 10.00);
 163     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 5.00);
 164     $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 95.00);
 165     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 23456);
 166     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 78910);
 167     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_source'], 'SSF');
 168     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed');
 169     // Create a second contribution - we are testing that 'id' gets the right contribution id (not the contact id).
 170     $p['trxn_id'] = '3847';
 171     $p['invoice_id'] = '3847';
 172
 173     $contribution2 = $this->callAPISuccess('contribution', 'create', $p);
 174
 175     // Now we have 2 - test getcount.
 176     $contribution = $this->callAPISuccess('contribution', 'getcount', array());
 177     $this->assertEquals(2, $contribution);
 178     // Test id only format.
 179     $contribution = $this->callAPISuccess('contribution', 'get', array(
 180       'id' => $this->_contribution['id'],
 181       'format.only_id' => 1,
 182     ));
 183     $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution, TRUE));
 184     // Test id only format.
 185     $contribution = $this->callAPISuccess('contribution', 'get', array(
 186       'id' => $contribution2['id'],
 187       'format.only_id' => 1,
 188     ));
 189     $this->assertEquals($contribution2['id'], $contribution);
 190     // Test id as field.
 191     $contribution = $this->callAPISuccess('contribution', 'get', array(
 192       'id' => $this->_contribution['id'],
 193     ));
 194     $this->assertEquals(1, $contribution['count']);
 195
 196     // Test get by contact id works.
 197     $contribution = $this->callAPISuccess('contribution', 'get', array('contact_id' => $this->_individualId));
 198
 199     $this->assertEquals(2, $contribution['count']);
 200     $this->callAPISuccess('Contribution', 'Delete', array(
 201       'id' => $this->_contribution['id'],
 202     ));
 203     $this->callAPISuccess('Contribution', 'Delete', array(
 204       'id' => $contribution2['id'],
 205     ));
 206   }
 207
 208   /**
 209    * Test that test contributions can be retrieved.
 210    */
 211   public function testGetTestContribution() {
 212     $this->callAPISuccess('Contribution', 'create', array_merge($this->_params, array('is_test' => 1)));
 213     $this->callAPISuccessGetSingle('Contribution', array('is_test' => 1));
 214   }
 215
 216   /**
 217    * We need to ensure previous tested behaviour still works as part of the api contract.
 218    */
 219   public 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->_financialTypeId,
 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     );
 233     $this->_contribution = $this->callAPISuccess('Contribution', 'create', $p);
 234
 235     $params = array(
 236       'contribution_id' => $this->_contribution['id'],
 237     );
 238     $contribution = $this->callAPIAndDocument('contribution', 'get', $params, __FUNCTION__, __FILE__);
 239     $financialParams['id'] = $this->_financialTypeId;
 240     $default = NULL;
 241     CRM_Financial_BAO_FinancialType::retrieve($financialParams, $default);
 242
 243     $this->assertEquals(1, $contribution['count']);
 244     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 245     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], $this->_financialTypeId);
 246     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_type_id'], $this->_financialTypeId);
 247     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 248     $this->assertEquals($contribution['values'][$contribution['id']]['non_deductible_amount'], 10.00);
 249     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 5.00);
 250     $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 95.00);
 251     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 23456);
 252     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 78910);
 253     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_source'], 'SSF');
 254     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status'], 'Completed');
 255
 256     // Create a second contribution - we are testing that 'id' gets the right contribution id (not the contact id).
 257     $p['trxn_id'] = '3847';
 258     $p['invoice_id'] = '3847';
 259
 260     $contribution2 = $this->callAPISuccess('contribution', 'create', $p);
 261
 262     // now we have 2 - test getcount
 263     $contribution = $this->callAPISuccess('contribution', 'getcount', array());
 264     $this->assertEquals(2, $contribution);
 265     //test id only format
 266     $contribution = $this->callAPISuccess('contribution', 'get', array(
 267       'id' => $this->_contribution['id'],
 268       'format.only_id' => 1,
 269     ));
 270     $this->assertEquals($this->_contribution['id'], $contribution, print_r($contribution, TRUE));
 271     //test id only format
 272     $contribution = $this->callAPISuccess('contribution', 'get', array(
 273       'id' => $contribution2['id'],
 274       'format.only_id' => 1,
 275     ));
 276     $this->assertEquals($contribution2['id'], $contribution);
 277     $contribution = $this->callAPISuccess('contribution', 'get', array(
 278       'id' => $this->_contribution['id'],
 279     ));
 280     //test id as field
 281     $this->assertEquals(1, $contribution['count']);
 282     // $this->assertEquals($this->_contribution['id'], $contribution['id'] )  ;
 283     //test get by contact id works
 284     $contribution = $this->callAPISuccess('contribution', 'get', array('contact_id' => $this->_individualId));
 285
 286     $this->assertEquals(2, $contribution['count']);
 287     $this->callAPISuccess('Contribution', 'Delete', array(
 288       'id' => $this->_contribution['id'],
 289     ));
 290     $this->callAPISuccess('Contribution', 'Delete', array(
 291       'id' => $contribution2['id'],
 292     ));
 293   }
 294
 295   /**
 296    * Create an contribution_id=FALSE and financial_type_id=Donation.
 297    */
 298   public function testCreateEmptyContributionIDUseDonation() {
 299     $params = array(
 300       'contribution_id' => FALSE,
 301       'contact_id' => 1,
 302       'total_amount' => 1,
 303       'check_permissions' => FALSE,
 304       'financial_type_id' => 'Donation',
 305     );
 306     $this->callAPISuccess('contribution', 'create', $params);
 307   }
 308
 309   /**
 310    * Check with complete array + custom field.
 311    *
 312    * Note that the test is written on purpose without any
 313    * variables specific to participant so it can be replicated into other entities
 314    * and / or moved to the automated test suite
 315    */
 316   public function testCreateWithCustom() {
 317     $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 318
 319     $params = $this->_params;
 320     $params['custom_' . $ids['custom_field_id']] = "custom string";
 321
 322     $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);
 323     $this->assertEquals($result['id'], $result['values'][$result['id']]['id']);
 324     $check = $this->callAPISuccess($this->_entity, 'get', array(
 325       'return.custom_' . $ids['custom_field_id'] => 1,
 326       'id' => $result['id'],
 327     ));
 328     $this->customFieldDelete($ids['custom_field_id']);
 329     $this->customGroupDelete($ids['custom_group_id']);
 330     $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']]);
 331   }
 332
 333   /**
 334    * Check with complete array + custom field.
 335    *
 336    * Note that the test is written on purpose without any
 337    * variables specific to participant so it can be replicated into other entities
 338    * and / or moved to the automated test suite
 339    */
 340   public function testCreateGetFieldsWithCustom() {
 341     $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 342     $idsContact = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, 'ContactTest.php');
 343     $result = $this->callAPISuccess('Contribution', 'getfields', array());
 344     $this->assertArrayHasKey('custom_' . $ids['custom_field_id'], $result['values']);
 345     $this->assertArrayNotHasKey('custom_' . $idsContact['custom_field_id'], $result['values']);
 346     $this->customFieldDelete($ids['custom_field_id']);
 347     $this->customGroupDelete($ids['custom_group_id']);
 348     $this->customFieldDelete($idsContact['custom_field_id']);
 349     $this->customGroupDelete($idsContact['custom_group_id']);
 350   }
 351
 352   public function testCreateContributionNoLineItems() {
 353
 354     $params = array(
 355       'contact_id' => $this->_individualId,
 356       'receive_date' => '20120511',
 357       'total_amount' => 100.00,
 358       'financial_type_id' => $this->_financialTypeId,
 359       'payment_instrument_id' => 1,
 360       'non_deductible_amount' => 10.00,
 361       'fee_amount' => 50.00,
 362       'net_amount' => 90.00,
 363       'trxn_id' => 12345,
 364       'invoice_id' => 67890,
 365       'source' => 'SSF',
 366       'contribution_status_id' => 1,
 367       'skipLineItem' => 1,
 368     );
 369
 370     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 371     $lineItems = $this->callAPISuccess('line_item', 'get', array(
 372       'entity_id' => $contribution['id'],
 373       'entity_table' => 'civicrm_contribution',
 374       'sequential' => 1,
 375     ));
 376     $this->assertEquals(0, $lineItems['count']);
 377   }
 378
 379   /**
 380    * Test checks that passing in line items suppresses the create mechanism.
 381    */
 382   public function testCreateContributionChainedLineItems() {
 383     $params = array(
 384       'contact_id' => $this->_individualId,
 385       'receive_date' => '20120511',
 386       'total_amount' => 100.00,
 387       'financial_type_id' => $this->_financialTypeId,
 388       'payment_instrument_id' => 1,
 389       'non_deductible_amount' => 10.00,
 390       'fee_amount' => 50.00,
 391       'net_amount' => 90.00,
 392       'trxn_id' => 12345,
 393       'invoice_id' => 67890,
 394       'source' => 'SSF',
 395       'contribution_status_id' => 1,
 396       'skipLineItem' => 1,
 397       'api.line_item.create' => array(
 398         array(
 399           'price_field_id' => 1,
 400           'qty' => 2,
 401           'line_total' => '20',
 402           'unit_price' => '10',
 403         ),
 404         array(
 405           'price_field_id' => 1,
 406           'qty' => 1,
 407           'line_total' => '80',
 408           'unit_price' => '80',
 409         ),
 410       ),
 411     );
 412
 413     $description = "Create Contribution with Nested Line Items.";
 414     $subfile = "CreateWithNestedLineItems";
 415     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 416
 417     $lineItems = $this->callAPISuccess('line_item', 'get', array(
 418       'entity_id' => $contribution['id'],
 419       'contribution_id' => $contribution['id'],
 420       'entity_table' => 'civicrm_contribution',
 421       'sequential' => 1,
 422     ));
 423     $this->assertEquals(2, $lineItems['count']);
 424   }
 425
 426   public function testCreateContributionOffline() {
 427     $params = array(
 428       'contact_id' => $this->_individualId,
 429       'receive_date' => '20120511',
 430       'total_amount' => 100.00,
 431       'financial_type_id' => 1,
 432       'trxn_id' => 12345,
 433       'invoice_id' => 67890,
 434       'source' => 'SSF',
 435       'contribution_status_id' => 1,
 436     );
 437
 438     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
 439     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 440     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 441     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 442     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
 443     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
 444     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 445     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
 446     $lineItems = $this->callAPISuccess('line_item', 'get', array(
 447       'entity_id' => $contribution['id'],
 448       'contribution_id' => $contribution['id'],
 449       'entity_table' => 'civicrm_contribution',
 450       'sequential' => 1,
 451     ));
 452     $this->assertEquals(1, $lineItems['count']);
 453     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 454     $this->assertEquals($contribution['id'], $lineItems['values'][0]['contribution_id']);
 455     $this->_checkFinancialRecords($contribution, 'offline');
 456     $this->contributionGetnCheck($params, $contribution['id']);
 457   }
 458
 459   /**
 460    * Test create with valid payment instrument.
 461    */
 462   public function testCreateContributionWithPaymentInstrument() {
 463     $params = $this->_params + array('payment_instrument' => 'EFT');
 464     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 465     $contribution = $this->callAPISuccess('contribution', 'get', array(
 466       'sequential' => 1,
 467       'id' => $contribution['id'],
 468     ));
 469     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 470     $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
 471
 472     $this->callAPISuccess('contribution', 'create', array(
 473       'id' => $contribution['id'],
 474       'payment_instrument' => 'Credit Card',
 475     ));
 476     $contribution = $this->callAPISuccess('contribution', 'get', array(
 477       'sequential' => 1,
 478       'id' => $contribution['id'],
 479     ));
 480     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 481     $this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
 482   }
 483
 484   public function testGetContributionByPaymentInstrument() {
 485     $params = $this->_params + array('payment_instrument' => 'EFT');
 486     $params2 = $this->_params + array('payment_instrument' => 'Cash');
 487     $this->callAPISuccess('contribution', 'create', $params);
 488     $this->callAPISuccess('contribution', 'create', $params2);
 489     $contribution = $this->callAPISuccess('contribution', 'get', array(
 490       'sequential' => 1,
 491       'contribution_payment_instrument' => 'Cash',
 492     ));
 493     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 494     $this->assertEquals('Cash', $contribution['values'][0]['payment_instrument']);
 495     $this->assertEquals(1, $contribution['count']);
 496     $contribution = $this->callAPISuccess('contribution', 'get', array('sequential' => 1, 'payment_instrument' => 'Cash'));
 497     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 498     $this->assertEquals('Cash', $contribution['values'][0]['payment_instrument']);
 499     $this->assertEquals(1, $contribution['count']);
 500     $contribution = $this->callAPISuccess('contribution', 'get', array(
 501       'sequential' => 1,
 502       'payment_instrument_id' => 5,
 503     ));
 504     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 505     $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
 506     $this->assertEquals(1, $contribution['count']);
 507     $contribution = $this->callAPISuccess('contribution', 'get', array(
 508       'sequential' => 1,
 509       'payment_instrument' => 'EFT',
 510     ));
 511     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 512     $this->assertEquals('EFT', $contribution['values'][0]['payment_instrument']);
 513     $this->assertEquals(1, $contribution['count']);
 514     $contribution = $this->callAPISuccess('contribution', 'create', array(
 515       'id' => $contribution['id'],
 516       'payment_instrument' => 'Credit Card',
 517     ));
 518     $contribution = $this->callAPISuccess('contribution', 'get', array('sequential' => 1, 'id' => $contribution['id']));
 519     $this->assertArrayHasKey('payment_instrument', $contribution['values'][0]);
 520     $this->assertEquals('Credit Card', $contribution['values'][0]['payment_instrument']);
 521     $this->assertEquals(1, $contribution['count']);
 522   }
 523
 524   /**
 525    * CRM-16227 introduces invoice_id as a parameter.
 526    */
 527   public function testGetContributionByInvoice() {
 528     $this->callAPISuccess('Contribution', 'create', array_merge($this->_params, array('invoice_id' => 'curly')));
 529     $this->callAPISuccess('Contribution', 'create', array_merge($this->_params), array('invoice_id' => 'churlish'));
 530     $this->callAPISuccessGetCount('Contribution', array(), 2);
 531     $this->callAPISuccessGetSingle('Contribution', array('invoice_id' => 'curly'));
 532     // The following don't work. They are the format we are trying to introduce but although the form uses this format
 533     // CRM_Contact_BAO_Query::convertFormValues puts them into the other format & the where only supports that.
 534     // ideally the where clause would support this format (as it does on contact_BAO_Query) and those lines would
 535     // come out of convertFormValues
 536     // $this->callAPISuccessGetSingle('Contribution', array('invoice_id' => array('LIKE' => '%ish%')));
 537     // $this->callAPISuccessGetSingle('Contribution', array('invoice_id' => array('NOT IN' => array('curly'))));
 538     // $this->callAPISuccessGetCount('Contribution', array('invoice_id' => array('LIKE' => '%ly%')), 2);
 539     // $this->callAPISuccessGetCount('Contribution', array('invoice_id' => array('IN' => array('curly', 'churlish'))),
 540     // 2);
 541   }
 542
 543   /**
 544    * Create test with unique field name on source.
 545    */
 546   public function testCreateContributionSource() {
 547
 548     $params = array(
 549       'contact_id' => $this->_individualId,
 550       'receive_date' => date('Ymd'),
 551       'total_amount' => 100.00,
 552       'financial_type_id' => $this->_financialTypeId,
 553       'payment_instrument_id' => 1,
 554       'non_deductible_amount' => 10.00,
 555       'fee_amount' => 50.00,
 556       'net_amount' => 90.00,
 557       'trxn_id' => 12345,
 558       'invoice_id' => 67890,
 559       'contribution_source' => 'SSF',
 560       'contribution_status_id' => 1,
 561     );
 562
 563     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 564     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 565     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 566   }
 567
 568   /**
 569    * Create test with unique field name on source.
 570    */
 571   public function testCreateDefaultNow() {
 572
 573     $params = $this->_params;
 574     unset($params['receive_date']);
 575
 576     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 577     $contribution = $this->callAPISuccessGetSingle('contribution', array('id' => $contribution['id']));
 578     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receive_date'])));
 579   }
 580
 581   /**
 582    * Create test with unique field name on source.
 583    */
 584   public function testCreateContributionSourceInvalidContact() {
 585
 586     $params = array(
 587       'contact_id' => 999,
 588       'receive_date' => date('Ymd'),
 589       'total_amount' => 100.00,
 590       'financial_type_id' => $this->_financialTypeId,
 591       'payment_instrument_id' => 1,
 592       'non_deductible_amount' => 10.00,
 593       'fee_amount' => 50.00,
 594       'net_amount' => 90.00,
 595       'trxn_id' => 12345,
 596       'invoice_id' => 67890,
 597       'contribution_source' => 'SSF',
 598       'contribution_status_id' => 1,
 599     );
 600
 601     $this->callAPIFailure('contribution', 'create', $params, 'contact_id is not valid : 999');
 602   }
 603
 604   public function testCreateContributionSourceInvalidContContact() {
 605
 606     $params = array(
 607       'contribution_contact_id' => 999,
 608       'receive_date' => date('Ymd'),
 609       'total_amount' => 100.00,
 610       'financial_type_id' => $this->_financialTypeId,
 611       'payment_instrument_id' => 1,
 612       'non_deductible_amount' => 10.00,
 613       'fee_amount' => 50.00,
 614       'net_amount' => 90.00,
 615       'trxn_id' => 12345,
 616       'invoice_id' => 67890,
 617       'contribution_source' => 'SSF',
 618       'contribution_status_id' => 1,
 619     );
 620
 621     $this->callAPIFailure('contribution', 'create', $params, 'contact_id is not valid : 999');
 622   }
 623
 624   /**
 625    * Test note created correctly.
 626    */
 627   public function testCreateContributionWithNote() {
 628     $description = "Demonstrates creating contribution with Note Entity.";
 629     $subfile = "ContributionCreateWithNote";
 630     $params = array(
 631       'contact_id' => $this->_individualId,
 632       'receive_date' => '2012-01-01',
 633       'total_amount' => 100.00,
 634       'financial_type_id' => $this->_financialTypeId,
 635       'payment_instrument_id' => 1,
 636       'non_deductible_amount' => 10.00,
 637       'fee_amount' => 50.00,
 638       'net_amount' => 90.00,
 639       'trxn_id' => 12345,
 640       'invoice_id' => 67890,
 641       'source' => 'SSF',
 642       'contribution_status_id' => 1,
 643       'note' => 'my contribution note',
 644     );
 645
 646     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 647     $result = $this->callAPISuccess('note', 'get', array(
 648       'entity_table' => 'civicrm_contribution',
 649       'entity_id' => $contribution['id'],
 650       'sequential' => 1,
 651     ));
 652     $this->assertEquals('my contribution note', $result['values'][0]['note']);
 653     $this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id']));
 654   }
 655
 656   public function testCreateContributionWithNoteUniqueNameAliases() {
 657     $params = array(
 658       'contact_id' => $this->_individualId,
 659       'receive_date' => '2012-01-01',
 660       'total_amount' => 100.00,
 661       'financial_type_id' => $this->_financialTypeId,
 662       'payment_instrument_id' => 1,
 663       'non_deductible_amount' => 10.00,
 664       'fee_amount' => 50.00,
 665       'net_amount' => 90.00,
 666       'trxn_id' => 12345,
 667       'invoice_id' => 67890,
 668       'source' => 'SSF',
 669       'contribution_status_id' => 1,
 670       'contribution_note' => 'my contribution note',
 671     );
 672
 673     $contribution = $this->callAPISuccess('contribution', 'create', $params);
 674     $result = $this->callAPISuccess('note', 'get', array(
 675       'entity_table' => 'civicrm_contribution',
 676       'entity_id' => $contribution['id'],
 677       'sequential' => 1,
 678     ));
 679     $this->assertEquals('my contribution note', $result['values'][0]['note']);
 680     $this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id']));
 681   }
 682
 683   /**
 684    * This is the test for creating soft credits.
 685    */
 686   public function testCreateContributionWithSoftCredit() {
 687     $description = "Demonstrates creating contribution with SoftCredit.";
 688     $subfile = "ContributionCreateWithSoftCredit";
 689     $contact2 = $this->callAPISuccess('Contact', 'create', array(
 690       'display_name' => 'superman',
 691       'contact_type' => 'Individual',
 692     ));
 693     $softParams = array(
 694       'contact_id' => $contact2['id'],
 695       'amount' => 50,
 696       'soft_credit_type_id' => 3,
 697     );
 698
 699     $params = $this->_params + array('soft_credit' => array(1 => $softParams));
 700     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 701     $result = $this->callAPISuccess('contribution', 'get', array('return' => 'soft_credit', 'sequential' => 1));
 702
 703     $this->assertEquals($softParams['contact_id'], $result['values'][0]['soft_credit'][1]['contact_id']);
 704     $this->assertEquals($softParams['amount'], $result['values'][0]['soft_credit'][1]['amount']);
 705     $this->assertEquals($softParams['soft_credit_type_id'], $result['values'][0]['soft_credit'][1]['soft_credit_type']);
 706
 707     $this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id']));
 708     $this->callAPISuccess('contact', 'delete', array('id' => $contact2['id']));
 709   }
 710
 711   public function testCreateContributionWithSoftCreditDefaults() {
 712     $description = "Demonstrates creating contribution with Soft Credit defaults for amount and type.";
 713     $subfile = "ContributionCreateWithSoftCreditDefaults";
 714     $contact2 = $this->callAPISuccess('Contact', 'create', array(
 715       'display_name' => 'superman',
 716       'contact_type' => 'Individual',
 717     ));
 718     $params = $this->_params + array(
 719       'soft_credit_to' => $contact2['id'],
 720     );
 721     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 722     $result = $this->callAPISuccess('contribution', 'get', array('return' => 'soft_credit', 'sequential' => 1));
 723
 724     $this->assertEquals($contact2['id'], $result['values'][0]['soft_credit'][1]['contact_id']);
 725     // Default soft credit amount = contribution.total_amount
 726     $this->assertEquals($this->_params['total_amount'], $result['values'][0]['soft_credit'][1]['amount']);
 727     $this->assertEquals(CRM_Core_OptionGroup::getDefaultValue("soft_credit_type"), $result['values'][0]['soft_credit'][1]['soft_credit_type']);
 728
 729     $this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id']));
 730     $this->callAPISuccess('contact', 'delete', array('id' => $contact2['id']));
 731   }
 732
 733   public function testCreateContributionWithHonoreeContact() {
 734     $description = "Demonstrates creating contribution with Soft Credit by passing in honor_contact_id.";
 735     $subfile = "ContributionCreateWithHonoreeContact";
 736     $contact2 = $this->callAPISuccess('Contact', 'create', array(
 737       'display_name' => 'superman',
 738       'contact_type' => 'Individual',
 739     ));
 740     $params = $this->_params + array(
 741       'honor_contact_id' => $contact2['id'],
 742     );
 743     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
 744     $result = $this->callAPISuccess('contribution', 'get', array('return' => 'soft_credit', 'sequential' => 1));
 745
 746     $this->assertEquals($contact2['id'], $result['values'][0]['soft_credit'][1]['contact_id']);
 747     // Default soft credit amount = contribution.total_amount
 748     // Legacy mode in create api (honor_contact_id param) uses the standard "In Honor of" soft credit type
 749     $this->assertEquals($this->_params['total_amount'], $result['values'][0]['soft_credit'][1]['amount']);
 750     $this->assertEquals(CRM_Core_OptionGroup::getValue('soft_credit_type', 'in_honor_of', 'name'), $result['values'][0]['soft_credit'][1]['soft_credit_type']);
 751
 752     $this->callAPISuccess('contribution', 'delete', array('id' => $contribution['id']));
 753     $this->callAPISuccess('contact', 'delete', array('id' => $contact2['id']));
 754   }
 755
 756   /**
 757    * Test using example code.
 758    */
 759   public function testContributionCreateExample() {
 760     //make sure at least on page exists since there is a truncate in tear down
 761     $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
 762     require_once 'api/v3/examples/Contribution/Create.php';
 763     $result = contribution_create_example();
 764     $id = $result['id'];
 765     $expectedResult = contribution_create_expectedresult();
 766     $this->checkArrayEquals($expectedResult, $result);
 767     $this->contributionDelete($id);
 768   }
 769
 770   /**
 771    * Function tests that additional financial records are created when fee amount is recorded.
 772    */
 773   public function testCreateContributionWithFee() {
 774     $params = array(
 775       'contact_id' => $this->_individualId,
 776       'receive_date' => '20120511',
 777       'total_amount' => 100.00,
 778       'fee_amount' => 50,
 779       'financial_type_id' => 1,
 780       'trxn_id' => 12345,
 781       'invoice_id' => 67890,
 782       'source' => 'SSF',
 783       'contribution_status_id' => 1,
 784     );
 785
 786     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
 787     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 788     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 789     $this->assertEquals($contribution['values'][$contribution['id']]['fee_amount'], 50.00);
 790     $this->assertEquals($contribution['values'][$contribution['id']]['net_amount'], 50.00);
 791     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 792     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
 793     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
 794     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 795     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
 796
 797     $lineItems = $this->callAPISuccess('line_item', 'get', array(
 798
 799       'entity_id' => $contribution['id'],
 800       'entity_table' => 'civicrm_contribution',
 801       'sequential' => 1,
 802     ));
 803     $this->assertEquals(1, $lineItems['count']);
 804     $this->assertEquals($contribution['id'], $lineItems['values'][0]['entity_id']);
 805     $this->assertEquals($contribution['id'], $lineItems['values'][0]['contribution_id']);
 806     $lineItems = $this->callAPISuccess('line_item', 'get', array(
 807
 808       'entity_id' => $contribution['id'],
 809       'contribution_id' => $contribution['id'],
 810       'entity_table' => 'civicrm_contribution',
 811       'sequential' => 1,
 812     ));
 813     $this->assertEquals(1, $lineItems['count']);
 814     $this->_checkFinancialRecords($contribution, 'feeAmount');
 815   }
 816
 817
 818   /**
 819    * Function tests that additional financial records are created when online contribution is created.
 820    */
 821   public function testCreateContributionOnline() {
 822     CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 823     $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
 824     $this->assertAPISuccess($contributionPage);
 825     $params = array(
 826       'contact_id' => $this->_individualId,
 827       'receive_date' => '20120511',
 828       'total_amount' => 100.00,
 829       'financial_type_id' => 1,
 830       'contribution_page_id' => $contributionPage['id'],
 831       'payment_processor' => 1,
 832       'trxn_id' => 12345,
 833       'invoice_id' => 67890,
 834       'source' => 'SSF',
 835       'contribution_status_id' => 1,
 836
 837     );
 838
 839     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
 840     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 841     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 842     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 843     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
 844     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
 845     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 846     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 1);
 847     $this->_checkFinancialRecords($contribution, 'online');
 848   }
 849
 850   /**
 851    * Check handling of financial type.
 852    *
 853    * In the interests of removing financial type / contribution type checks from
 854    * legacy format function lets test that the api is doing this for us
 855    */
 856   public function testCreateInvalidFinancialType() {
 857     $params = $this->_params;
 858     $params['financial_type_id'] = 99999;
 859     $this->callAPIFailure($this->_entity, 'create', $params, "'99999' is not a valid option for field financial_type_id");
 860   }
 861
 862   /**
 863    * Check handling of financial type.
 864    *
 865    * In the interests of removing financial type / contribution type checks from
 866    * legacy format function lets test that the api is doing this for us
 867    */
 868   public function testValidNamedFinancialType() {
 869     $params = $this->_params;
 870     $params['financial_type_id'] = 'Donation';
 871     $this->callAPISuccess($this->_entity, 'create', $params);
 872   }
 873
 874   /**
 875    * Tests that additional financial records are created.
 876    *
 877    * Checks when online contribution with pay later option is created
 878    */
 879   public function testCreateContributionPayLaterOnline() {
 880     CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 881     $this->_pageParams['is_pay_later'] = 1;
 882     $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
 883     $this->assertAPISuccess($contributionPage);
 884     $params = array(
 885       'contact_id' => $this->_individualId,
 886       'receive_date' => '20120511',
 887       'total_amount' => 100.00,
 888       'financial_type_id' => 1,
 889       'contribution_page_id' => $contributionPage['id'],
 890       'trxn_id' => 12345,
 891       'is_pay_later' => 1,
 892       'invoice_id' => 67890,
 893       'source' => 'SSF',
 894       'contribution_status_id' => 2,
 895
 896     );
 897
 898     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
 899     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 900     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 901     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 902     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
 903     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
 904     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 905     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 2);
 906     $this->_checkFinancialRecords($contribution, 'payLater');
 907   }
 908
 909   /**
 910    * Function tests that additional financial records are created for online contribution with pending option.
 911    */
 912   public function testCreateContributionPendingOnline() {
 913     $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::create($this->_processorParams);
 914     $contributionPage = $this->callAPISuccess('contribution_page', 'create', $this->_pageParams);
 915     $this->assertAPISuccess($contributionPage);
 916     $params = array(
 917       'contact_id' => $this->_individualId,
 918       'receive_date' => '20120511',
 919       'total_amount' => 100.00,
 920       'financial_type_id' => 1,
 921       'contribution_page_id' => $contributionPage['id'],
 922       'trxn_id' => 12345,
 923       'invoice_id' => 67890,
 924       'source' => 'SSF',
 925       'contribution_status_id' => 2,
 926     );
 927
 928     $contribution = $this->callAPIAndDocument('contribution', 'create', $params, __FUNCTION__, __FILE__);
 929     $this->assertEquals($contribution['values'][$contribution['id']]['contact_id'], $this->_individualId);
 930     $this->assertEquals($contribution['values'][$contribution['id']]['total_amount'], 100.00);
 931     $this->assertEquals($contribution['values'][$contribution['id']]['financial_type_id'], 1);
 932     $this->assertEquals($contribution['values'][$contribution['id']]['trxn_id'], 12345);
 933     $this->assertEquals($contribution['values'][$contribution['id']]['invoice_id'], 67890);
 934     $this->assertEquals($contribution['values'][$contribution['id']]['source'], 'SSF');
 935     $this->assertEquals($contribution['values'][$contribution['id']]['contribution_status_id'], 2);
 936     $this->_checkFinancialRecords($contribution, 'pending');
 937   }
 938
 939   /**
 940    * Test that BAO defaults work.
 941    */
 942   public function testCreateBAODefaults() {
 943     unset($this->_params['contribution_source_id'], $this->_params['payment_instrument_id']);
 944     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
 945     $contribution = $this->callAPISuccess('contribution', 'getsingle', array(
 946       'id' => $contribution['id'],
 947       'api.contribution.delete' => 1,
 948     ));
 949     $this->assertEquals(1, $contribution['contribution_status_id']);
 950     $this->assertEquals('Check', $contribution['payment_instrument']);
 951   }
 952
 953   /**
 954    * Function tests that line items, financial records are updated when contribution amount is changed.
 955    */
 956   public function testCreateUpdateContributionChangeTotal() {
 957     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
 958     $lineItems = $this->callAPISuccess('line_item', 'getvalue', array(
 959
 960       'entity_id' => $contribution['id'],
 961       'entity_table' => 'civicrm_contribution',
 962       'sequential' => 1,
 963       'return' => 'line_total',
 964     ));
 965     $this->assertEquals('100.00', $lineItems);
 966     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
 967     // Financial trxn SUM = 100 + 5 (fee)
 968     $this->assertEquals('105.00', $trxnAmount);
 969     $newParams = array(
 970
 971       'id' => $contribution['id'],
 972       'total_amount' => '125',
 973     );
 974     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
 975
 976     $lineItems = $this->callAPISuccess('line_item', 'getvalue', array(
 977
 978       'entity_id' => $contribution['id'],
 979       'entity_table' => 'civicrm_contribution',
 980       'sequential' => 1,
 981       'return' => 'line_total',
 982     ));
 983
 984     $this->assertEquals('125.00', $lineItems);
 985     $trxnAmount = $this->_getFinancialTrxnAmount($contribution['id']);
 986
 987     // Financial trxn SUM = 125 + 5 (fee).
 988     $this->assertEquals('130.00', $trxnAmount);
 989     $this->assertEquals('125.00', $this->_getFinancialItemAmount($contribution['id']));
 990   }
 991
 992   /**
 993    * Function tests that line items, financial records are updated when pay later contribution is received.
 994    */
 995   public function testCreateUpdateContributionPayLater() {
 996     $contribParams = array(
 997       'contact_id' => $this->_individualId,
 998       'receive_date' => '2012-01-01',
 999       'total_amount' => 100.00,
1000       'financial_type_id' => $this->_financialTypeId,
1001       'payment_instrument_id' => 1,
1002       'contribution_status_id' => 2,
1003       'is_pay_later' => 1,
1004
1005     );
1006     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1007
1008     $newParams = array_merge($contribParams, array(
1009         'id' => $contribution['id'],
1010         'contribution_status_id' => 1,
1011       )
1012     );
1013     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1014     $contribution = $contribution['values'][$contribution['id']];
1015     $this->assertEquals($contribution['contribution_status_id'], '1');
1016     $this->_checkFinancialItem($contribution['id'], 'paylater');
1017     $this->_checkFinancialTrxn($contribution, 'payLater');
1018   }
1019
1020   /**
1021    * Function tests that financial records are updated when Payment Instrument is changed.
1022    */
1023   public function testCreateUpdateContributionPaymentInstrument() {
1024     $instrumentId = $this->_addPaymentInstrument();
1025     $contribParams = array(
1026       'contact_id' => $this->_individualId,
1027       'total_amount' => 100.00,
1028       'financial_type_id' => $this->_financialTypeId,
1029       'payment_instrument_id' => 4,
1030       'contribution_status_id' => 1,
1031
1032     );
1033     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1034
1035     $newParams = array_merge($contribParams, array(
1036         'id' => $contribution['id'],
1037         'payment_instrument_id' => $instrumentId,
1038       )
1039     );
1040     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1041     $this->assertAPISuccess($contribution);
1042     $this->_checkFinancialTrxn($contribution, 'paymentInstrument', $instrumentId);
1043   }
1044
1045   /**
1046    * Function tests that financial records are added when Contribution is Refunded.
1047    */
1048   public function testCreateUpdateContributionRefund() {
1049     $contributionParams = array(
1050       'contact_id' => $this->_individualId,
1051       'receive_date' => '2012-01-01',
1052       'total_amount' => 100.00,
1053       'financial_type_id' => $this->_financialTypeId,
1054       'payment_instrument_id' => 4,
1055       'contribution_status_id' => 1,
1056       'trxn_id' => 'original_payment',
1057     );
1058     $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
1059     $newParams = array_merge($contributionParams, array(
1060         'id' => $contribution['id'],
1061         'contribution_status_id' => 'Refunded',
1062         'cancel_date' => '2015-01-01 09:00',
1063         'refund_trxn_id' => 'the refund',
1064       )
1065     );
1066
1067     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1068     $this->_checkFinancialTrxn($contribution, 'refund');
1069     $this->_checkFinancialItem($contribution['id'], 'refund');
1070     $this->assertEquals('original_payment', $this->callAPISuccessGetValue('Contribution', array(
1071       'id' => $contribution['id'],
1072       'return' => 'trxn_id',
1073     )));
1074   }
1075
1076   /**
1077    * Refund a contribution for a financial type with a contra account.
1078    *
1079    * CRM-17951 the contra account is a financial account with a relationship to a
1080    * financial type. It is not always configured but should be reflected
1081    * in the financial_trxn & financial_item table if it is.
1082    */
1083   public function testCreateUpdateChargebackContributionDefaultAccount() {
1084     $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params);
1085     $this->callAPISuccess('Contribution', 'create', array(
1086       'id' => $contribution['id'],
1087       'contribution_status_id' => 'Chargeback',
1088     ));
1089     $this->callAPISuccessGetSingle('Contribution', array('contribution_status_id' => 'Chargeback'));
1090
1091     $lineItems = $this->callAPISuccessGetSingle('LineItem', array(
1092       'contribution_id' => $contribution['id'],
1093       'api.FinancialItem.getsingle' => array('amount' => array('<' => 0)),
1094     ));
1095     $this->assertEquals(1, $lineItems['api.FinancialItem.getsingle']['financial_account_id']);
1096     $this->callAPISuccessGetSingle('FinancialTrxn', array(
1097       'total_amount' => -100,
1098       'status_id' => 'Chargeback',
1099       'to_financial_account_id' => 6,
1100     ));
1101   }
1102
1103   /**
1104    * Refund a contribution for a financial type with a contra account.
1105    *
1106    * CRM-17951 the contra account is a financial account with a relationship to a
1107    * financial type. It is not always configured but should be reflected
1108    * in the financial_trxn & financial_item table if it is.
1109    */
1110   public function testCreateUpdateChargebackContributionCustomAccount() {
1111     $financialAccount = $this->callAPISuccess('FinancialAccount', 'create', array(
1112       'name' => 'Chargeback Account',
1113       'is_active' => TRUE,
1114     ));
1115
1116     $entityFinancialAccount = $this->callAPISuccess('EntityFinancialAccount', 'create', array(
1117       'entity_id' => $this->_financialTypeId,
1118       'entity_table' => 'civicrm_financial_type',
1119       'account_relationship' => 'Chargeback Account is',
1120       'financial_account_id' => 'Chargeback Account',
1121     ));
1122
1123     $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params);
1124     $this->callAPISuccess('Contribution', 'create', array(
1125       'id' => $contribution['id'],
1126       'contribution_status_id' => 'Chargeback',
1127     ));
1128     $this->callAPISuccessGetSingle('Contribution', array('contribution_status_id' => 'Chargeback'));
1129
1130     $lineItems = $this->callAPISuccessGetSingle('LineItem', array(
1131       'contribution_id' => $contribution['id'],
1132       'api.FinancialItem.getsingle' => array('amount' => array('<' => 0)),
1133     ));
1134     $this->assertEquals($financialAccount['id'], $lineItems['api.FinancialItem.getsingle']['financial_account_id']);
1135
1136     $this->callAPISuccess('Contribution', 'delete', array('id' => $contribution['id']));
1137     $this->callAPISuccess('EntityFinancialAccount', 'delete', array('id' => $entityFinancialAccount['id']));
1138     $this->callAPISuccess('FinancialAccount', 'delete', array('id' => $financialAccount['id']));
1139   }
1140
1141   /**
1142    * Refund a contribution for a financial type with a contra account.
1143    *
1144    * CRM-17951 the contra account is a financial account with a relationship to a
1145    * financial type. It is not always configured but should be reflected
1146    * in the financial_trxn & financial_item table if it is.
1147    */
1148   public function testCreateUpdateRefundContributionConfiguredContraAccount() {
1149     $financialAccount = $this->callAPISuccess('FinancialAccount', 'create', array(
1150       'name' => 'Refund Account',
1151       'is_active' => TRUE,
1152     ));
1153
1154     $entityFinancialAccount = $this->callAPISuccess('EntityFinancialAccount', 'create', array(
1155       'entity_id' => $this->_financialTypeId,
1156       'entity_table' => 'civicrm_financial_type',
1157       'account_relationship' => 'Credit/Contra Revenue Account is',
1158       'financial_account_id' => 'Refund Account',
1159     ));
1160
1161     $contribution = $this->callAPISuccess('Contribution', 'create', $this->_params);
1162     $this->callAPISuccess('Contribution', 'create', array(
1163       'id' => $contribution['id'],
1164       'contribution_status_id' => 'Refunded',
1165     ));
1166
1167     $lineItems = $this->callAPISuccessGetSingle('LineItem', array(
1168       'contribution_id' => $contribution['id'],
1169       'api.FinancialItem.getsingle' => array('amount' => array('<' => 0)),
1170     ));
1171     $this->assertEquals($financialAccount['id'], $lineItems['api.FinancialItem.getsingle']['financial_account_id']);
1172
1173     $this->callAPISuccess('Contribution', 'delete', array('id' => $contribution['id']));
1174     $this->callAPISuccess('EntityFinancialAccount', 'delete', array('id' => $entityFinancialAccount['id']));
1175     $this->callAPISuccess('FinancialAccount', 'delete', array('id' => $financialAccount['id']));
1176   }
1177
1178   /**
1179    * Function tests that trxn_id is set when passed in.
1180    *
1181    * Here we ensure that the civicrm_financial_trxn.trxn_id & the civicrm_contribution.trxn_id are set
1182    * when trxn_id is passed in.
1183    */
1184   public function testCreateUpdateContributionRefundTrxnIDPassedIn() {
1185     $contributionParams = array(
1186       'contact_id' => $this->_individualId,
1187       'receive_date' => '2012-01-01',
1188       'total_amount' => 100.00,
1189       'financial_type_id' => $this->_financialTypeId,
1190       'payment_instrument_id' => 4,
1191       'contribution_status_id' => 1,
1192       'trxn_id' => 'original_payment',
1193     );
1194     $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
1195     $newParams = array_merge($contributionParams, array(
1196         'id' => $contribution['id'],
1197         'contribution_status_id' => 'Refunded',
1198         'cancel_date' => '2015-01-01 09:00',
1199         'trxn_id' => 'the refund',
1200       )
1201     );
1202
1203     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1204     $this->_checkFinancialTrxn($contribution, 'refund');
1205     $this->_checkFinancialItem($contribution['id'], 'refund');
1206     $this->assertEquals('the refund', $this->callAPISuccessGetValue('Contribution', array(
1207       'id' => $contribution['id'],
1208       'return' => 'trxn_id',
1209     )));
1210   }
1211
1212   /**
1213    * Function tests that trxn_id is set when passed in.
1214    *
1215    * Here we ensure that the civicrm_contribution.trxn_id is set
1216    * when trxn_id is passed in but if refund_trxn_id is different then that
1217    * is kept for the refund transaction.
1218    */
1219   public function testCreateUpdateContributionRefundRefundAndTrxnIDPassedIn() {
1220     $contributionParams = array(
1221       'contact_id' => $this->_individualId,
1222       'receive_date' => '2012-01-01',
1223       'total_amount' => 100.00,
1224       'financial_type_id' => $this->_financialTypeId,
1225       'payment_instrument_id' => 4,
1226       'contribution_status_id' => 1,
1227       'trxn_id' => 'original_payment',
1228     );
1229     $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
1230     $newParams = array_merge($contributionParams, array(
1231         'id' => $contribution['id'],
1232         'contribution_status_id' => 'Refunded',
1233         'cancel_date' => '2015-01-01 09:00',
1234         'trxn_id' => 'cont id',
1235         'refund_trxn_id' => 'the refund',
1236       )
1237     );
1238
1239     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1240     $this->_checkFinancialTrxn($contribution, 'refund');
1241     $this->_checkFinancialItem($contribution['id'], 'refund');
1242     $this->assertEquals('cont id', $this->callAPISuccessGetValue('Contribution', array(
1243       'id' => $contribution['id'],
1244       'return' => 'trxn_id',
1245     )));
1246   }
1247
1248   /**
1249    * Function tests that refund_trxn_id is set when passed in empty.
1250    *
1251    * Here we ensure that the civicrm_contribution.trxn_id is set
1252    * when trxn_id is passed in but if refund_trxn_id isset but empty then that
1253    * is kept for the refund transaction.
1254    */
1255   public function testCreateUpdateContributionRefundRefundNullTrxnIDPassedIn() {
1256     $contributionParams = array(
1257       'contact_id' => $this->_individualId,
1258       'receive_date' => '2012-01-01',
1259       'total_amount' => 100.00,
1260       'financial_type_id' => $this->_financialTypeId,
1261       'payment_instrument_id' => 4,
1262       'contribution_status_id' => 1,
1263       'trxn_id' => 'original_payment',
1264     );
1265     $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
1266     $newParams = array_merge($contributionParams, array(
1267         'id' => $contribution['id'],
1268         'contribution_status_id' => 'Refunded',
1269         'cancel_date' => '2015-01-01 09:00',
1270         'trxn_id' => 'cont id',
1271         'refund_trxn_id' => '',
1272       )
1273     );
1274
1275     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1276     $this->_checkFinancialTrxn($contribution, 'refund', NULL, array('trxn_id' => NULL));
1277     $this->_checkFinancialItem($contribution['id'], 'refund');
1278     $this->assertEquals('cont id', $this->callAPISuccessGetValue('Contribution', array(
1279       'id' => $contribution['id'],
1280       'return' => 'trxn_id',
1281     )));
1282   }
1283
1284   /**
1285    * Function tests invalid contribution status change.
1286    */
1287   public function testCreateUpdateContributionInValidStatusChange() {
1288     $contribParams = array(
1289       'contact_id' => 1,
1290       'receive_date' => '2012-01-01',
1291       'total_amount' => 100.00,
1292       'financial_type_id' => 1,
1293       'payment_instrument_id' => 1,
1294       'contribution_status_id' => 1,
1295     );
1296     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1297     $newParams = array_merge($contribParams, array(
1298         'id' => $contribution['id'],
1299         'contribution_status_id' => 2,
1300       )
1301     );
1302     $this->callAPIFailure('contribution', 'create', $newParams, ts('Cannot change contribution status from Completed to Pending.'));
1303
1304   }
1305
1306   /**
1307    * Function tests that financial records are added when Pending Contribution is Canceled.
1308    */
1309   public function testCreateUpdateContributionCancelPending() {
1310     $contribParams = array(
1311       'contact_id' => $this->_individualId,
1312       'receive_date' => '2012-01-01',
1313       'total_amount' => 100.00,
1314       'financial_type_id' => $this->_financialTypeId,
1315       'payment_instrument_id' => 1,
1316       'contribution_status_id' => 2,
1317       'is_pay_later' => 1,
1318
1319     );
1320     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1321     $newParams = array_merge($contribParams, array(
1322         'id' => $contribution['id'],
1323         'contribution_status_id' => 3,
1324       )
1325     );
1326     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1327     $this->_checkFinancialTrxn($contribution, 'cancelPending');
1328     $this->_checkFinancialItem($contribution['id'], 'cancelPending');
1329   }
1330
1331   /**
1332    * Function tests that financial records are added when Financial Type is Changed.
1333    */
1334   public function testCreateUpdateContributionChangeFinancialType() {
1335     $contribParams = array(
1336       'contact_id' => $this->_individualId,
1337       'receive_date' => '2012-01-01',
1338       'total_amount' => 100.00,
1339       'financial_type_id' => 1,
1340       'payment_instrument_id' => 1,
1341       'contribution_status_id' => 1,
1342
1343     );
1344     $contribution = $this->callAPISuccess('contribution', 'create', $contribParams);
1345     $newParams = array_merge($contribParams, array(
1346         'id' => $contribution['id'],
1347         'financial_type_id' => 3,
1348       )
1349     );
1350     $contribution = $this->callAPISuccess('contribution', 'create', $newParams);
1351     $this->_checkFinancialTrxn($contribution, 'changeFinancial');
1352     $this->_checkFinancialItem($contribution['id'], 'changeFinancial');
1353   }
1354
1355   /**
1356    * Test that update does not change status id CRM-15105.
1357    */
1358   public function testCreateUpdateWithoutChangingPendingStatus() {
1359     $contribution = $this->callAPISuccess('contribution', 'create', array_merge($this->_params, array('contribution_status_id' => 2)));
1360     $this->callAPISuccess('contribution', 'create', array('id' => $contribution['id'], 'source' => 'new source'));
1361     $contribution = $this->callAPISuccess('contribution', 'getsingle', array(
1362       'id' => $contribution['id'],
1363       'api.contribution.delete' => 1,
1364     ));
1365     $this->assertEquals(2, $contribution['contribution_status_id']);
1366   }
1367
1368   /**
1369    * Test Updating a Contribution.
1370    *
1371    * CHANGE: we require the API to do an incremental update
1372    */
1373   public function testCreateUpdateContribution() {
1374
1375     $contributionID = $this->contributionCreate(array(
1376       'contact_id' => $this->_individualId,
1377       'trxn_id' => 212355,
1378       'financial_type_id' => $this->_financialTypeId,
1379       'invoice_id' => 'old_invoice',
1380     ));
1381     $old_params = array(
1382       'contribution_id' => $contributionID,
1383     );
1384     $original = $this->callAPISuccess('contribution', 'get', $old_params);
1385     $this->assertEquals($original['id'], $contributionID);
1386     //set up list of old params, verify
1387
1388     //This should not be required on update:
1389     $old_contact_id = $original['values'][$contributionID]['contact_id'];
1390     $old_payment_instrument = $original['values'][$contributionID]['instrument_id'];
1391     $old_fee_amount = $original['values'][$contributionID]['fee_amount'];
1392     $old_source = $original['values'][$contributionID]['contribution_source'];
1393
1394     $old_trxn_id = $original['values'][$contributionID]['trxn_id'];
1395     $old_invoice_id = $original['values'][$contributionID]['invoice_id'];
1396
1397     //check against values in CiviUnitTestCase::createContribution()
1398     $this->assertEquals($old_contact_id, $this->_individualId);
1399     $this->assertEquals($old_fee_amount, 5.00);
1400     $this->assertEquals($old_source, 'SSF');
1401     $this->assertEquals($old_trxn_id, 212355);
1402     $this->assertEquals($old_invoice_id, 'old_invoice');
1403     $params = array(
1404       'id' => $contributionID,
1405       'contact_id' => $this->_individualId,
1406       'total_amount' => 110.00,
1407       'financial_type_id' => $this->_financialTypeId,
1408       'non_deductible_amount' => 10.00,
1409       'net_amount' => 100.00,
1410       'contribution_status_id' => 1,
1411       'note' => 'Donating for Nobel Cause',
1412
1413     );
1414
1415     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1416
1417     $new_params = array(
1418       'contribution_id' => $contribution['id'],
1419
1420     );
1421     $contribution = $this->callAPISuccess('contribution', 'get', $new_params);
1422
1423     $this->assertEquals($contribution['values'][$contributionID]['contact_id'], $this->_individualId);
1424     $this->assertEquals($contribution['values'][$contributionID]['total_amount'], 110.00);
1425     $this->assertEquals($contribution['values'][$contributionID]['financial_type_id'], $this->_financialTypeId);
1426     $this->assertEquals($contribution['values'][$contributionID]['instrument_id'], $old_payment_instrument);
1427     $this->assertEquals($contribution['values'][$contributionID]['non_deductible_amount'], 10.00);
1428     $this->assertEquals($contribution['values'][$contributionID]['fee_amount'], $old_fee_amount);
1429     $this->assertEquals($contribution['values'][$contributionID]['net_amount'], 100.00);
1430     $this->assertEquals($contribution['values'][$contributionID]['trxn_id'], $old_trxn_id);
1431     $this->assertEquals($contribution['values'][$contributionID]['invoice_id'], $old_invoice_id);
1432     $this->assertEquals($contribution['values'][$contributionID]['contribution_source'], $old_source);
1433     $this->assertEquals($contribution['values'][$contributionID]['contribution_status'], 'Completed');
1434     $params = array(
1435       'contribution_id' => $contributionID,
1436
1437     );
1438     $result = $this->callAPISuccess('contribution', 'delete', $params);
1439     $this->assertAPISuccess($result);
1440   }
1441
1442   ///////////////// civicrm_contribution_delete methods
1443
1444   /**
1445    * Attempt (but fail) to delete a contribution without parameters.
1446    */
1447   public function testDeleteEmptyParamsContribution() {
1448     $params = array();
1449     $this->callAPIFailure('contribution', 'delete', $params);
1450   }
1451
1452   public function testDeleteParamsNotArrayContribution() {
1453     $params = 'contribution_id= 1';
1454     $contribution = $this->callAPIFailure('contribution', 'delete', $params);
1455     $this->assertEquals($contribution['error_message'], 'Input variable `params` is not an array');
1456   }
1457
1458   public function testDeleteWrongParamContribution() {
1459     $params = array(
1460       'contribution_source' => 'SSF',
1461
1462     );
1463     $this->callAPIFailure('contribution', 'delete', $params);
1464   }
1465
1466   public function testDeleteContribution() {
1467     $contributionID = $this->contributionCreate(array(
1468       'contact_id' => $this->_individualId,
1469       'financial_type_id' => $this->_financialTypeId,
1470     ));
1471     $params = array(
1472       'id' => $contributionID,
1473     );
1474     $this->callAPIAndDocument('contribution', 'delete', $params, __FUNCTION__, __FILE__);
1475   }
1476
1477   /**
1478    * Test civicrm_contribution_search with empty params.
1479    *
1480    * All available contributions expected.
1481    */
1482   public function testSearchEmptyParams() {
1483     $params = array();
1484
1485     $p = array(
1486       'contact_id' => $this->_individualId,
1487       'receive_date' => date('Ymd'),
1488       'total_amount' => 100.00,
1489       'financial_type_id' => $this->_financialTypeId,
1490       'non_deductible_amount' => 10.00,
1491       'fee_amount' => 5.00,
1492       'net_amount' => 95.00,
1493       'trxn_id' => 23456,
1494       'invoice_id' => 78910,
1495       'source' => 'SSF',
1496       'contribution_status_id' => 1,
1497
1498     );
1499     $contribution = $this->callAPISuccess('contribution', 'create', $p);
1500
1501     $result = $this->callAPISuccess('contribution', 'get', $params);
1502     // We're taking the first element.
1503     $res = $result['values'][$contribution['id']];
1504
1505     $this->assertEquals($p['contact_id'], $res['contact_id']);
1506     $this->assertEquals($p['total_amount'], $res['total_amount']);
1507     $this->assertEquals($p['financial_type_id'], $res['financial_type_id']);
1508     $this->assertEquals($p['net_amount'], $res['net_amount']);
1509     $this->assertEquals($p['non_deductible_amount'], $res['non_deductible_amount']);
1510     $this->assertEquals($p['fee_amount'], $res['fee_amount']);
1511     $this->assertEquals($p['trxn_id'], $res['trxn_id']);
1512     $this->assertEquals($p['invoice_id'], $res['invoice_id']);
1513     $this->assertEquals($p['source'], $res['contribution_source']);
1514     // contribution_status_id = 1 => Completed
1515     $this->assertEquals('Completed', $res['contribution_status']);
1516
1517     $this->contributionDelete($contribution['id']);
1518   }
1519
1520   /**
1521    * Test civicrm_contribution_search. Success expected.
1522    */
1523   public function testSearch() {
1524     $p1 = array(
1525       'contact_id' => $this->_individualId,
1526       'receive_date' => date('Ymd'),
1527       'total_amount' => 100.00,
1528       'financial_type_id' => $this->_financialTypeId,
1529       'non_deductible_amount' => 10.00,
1530       'contribution_status_id' => 1,
1531
1532     );
1533     $contribution1 = $this->callAPISuccess('contribution', 'create', $p1);
1534
1535     $p2 = array(
1536       'contact_id' => $this->_individualId,
1537       'receive_date' => date('Ymd'),
1538       'total_amount' => 200.00,
1539       'financial_type_id' => $this->_financialTypeId,
1540       'non_deductible_amount' => 20.00,
1541       'trxn_id' => 5454565,
1542       'invoice_id' => 1212124,
1543       'fee_amount' => 50.00,
1544       'net_amount' => 60.00,
1545       'contribution_status_id' => 2,
1546
1547     );
1548     $contribution2 = $this->callAPISuccess('contribution', 'create', $p2);
1549
1550     $params = array(
1551       'contribution_id' => $contribution2['id'],
1552
1553     );
1554     $result = $this->callAPISuccess('contribution', 'get', $params);
1555     $res = $result['values'][$contribution2['id']];
1556
1557     $this->assertEquals($p2['contact_id'], $res['contact_id']);
1558     $this->assertEquals($p2['total_amount'], $res['total_amount']);
1559     $this->assertEquals($p2['financial_type_id'], $res['financial_type_id']);
1560     $this->assertEquals($p2['net_amount'], $res['net_amount']);
1561     $this->assertEquals($p2['non_deductible_amount'], $res['non_deductible_amount']);
1562     $this->assertEquals($p2['fee_amount'], $res['fee_amount']);
1563     $this->assertEquals($p2['trxn_id'], $res['trxn_id']);
1564     $this->assertEquals($p2['invoice_id'], $res['invoice_id']);
1565     // contribution_status_id = 2 => Pending
1566     $this->assertEquals('Pending', $res['contribution_status']);
1567
1568     $this->contributionDelete($contribution1['id']);
1569     $this->contributionDelete($contribution2['id']);
1570   }
1571
1572   /**
1573    * Test completing a transaction via the API.
1574    *
1575    * Note that we are creating a logged in user because email goes out from
1576    * that person
1577    */
1578   public function testCompleteTransaction() {
1579     $mut = new CiviMailUtils($this, TRUE);
1580     $this->swapMessageTemplateForTestTemplate();
1581     $this->createLoggedInUser();
1582     $params = array_merge($this->_params, array('contribution_status_id' => 2));
1583     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1584     $this->callAPISuccess('contribution', 'completetransaction', array(
1585       'id' => $contribution['id'],
1586     ));
1587     $contribution = $this->callAPISuccess('contribution', 'getsingle', array('id' => $contribution['id']));
1588     $this->assertEquals('SSF', $contribution['contribution_source']);
1589     $this->assertEquals('Completed', $contribution['contribution_status']);
1590     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['receipt_date'])));
1591     $mut->checkMailLog(array(
1592       'email:::anthony_anderson@civicrm.org',
1593       'is_monetary:::1',
1594       'amount:::100.00',
1595       'currency:::USD',
1596       'receive_date:::' . date('Ymd', strtotime($contribution['receive_date'])),
1597       'receipt_date:::' . date('Ymd'),
1598       'contributeMode:::notify',
1599       'title:::Contribution',
1600       'displayName:::Mr. Anthony Anderson II',
1601     ));
1602     $mut->stop();
1603     $this->revertTemplateToReservedTemplate();
1604   }
1605
1606   /**
1607    * Test completing a transaction via the API.
1608    *
1609    * Note that we are creating a logged in user because email goes out from
1610    * that person
1611    */
1612   public function testCompleteTransactionFeeAmount() {
1613     $this->createLoggedInUser();
1614     $params = array_merge($this->_params, array('contribution_status_id' => 2));
1615     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1616     $this->callAPISuccess('contribution', 'completetransaction', array(
1617       'id' => $contribution['id'],
1618       'fee_amount' => '.56',
1619       'trxn_id' => '7778888',
1620     ));
1621     $contribution = $this->callAPISuccess('contribution', 'getsingle', array('id' => $contribution['id'], 'sequential' => 1));
1622     $this->assertEquals('Completed', $contribution['contribution_status']);
1623     $this->assertEquals('7778888', $contribution['trxn_id']);
1624     $this->assertEquals('.56', $contribution['fee_amount']);
1625     $this->assertEquals('99.44', $contribution['net_amount']);
1626   }
1627
1628   /**
1629    * Test repeat contribution successfully creates line items.
1630    */
1631   public function testRepeatTransaction() {
1632     $originalContribution = $this->setUpRepeatTransaction();
1633
1634     $this->callAPISuccess('contribution', 'repeattransaction', array(
1635       'original_contribution_id' => $originalContribution['id'],
1636       'contribution_status_id' => 'Completed',
1637       'trxn_id' => uniqid(),
1638     ));
1639     $lineItemParams = array(
1640       'entity_id' => $originalContribution['id'],
1641       'sequential' => 1,
1642       'return' => array(
1643         'entity_table',
1644         'qty',
1645         'unit_price',
1646         'line_total',
1647         'label',
1648         'financial_type_id',
1649         'deductible_amount',
1650         'price_field_value_id',
1651         'price_field_id',
1652       ),
1653     );
1654     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, array(
1655       'entity_id' => $originalContribution['id'],
1656     )));
1657     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, array(
1658       'entity_id' => $originalContribution['id'] + 1,
1659     )));
1660     unset($lineItem1['values'][0]['id'], $lineItem1['values'][0]['entity_id']);
1661     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
1662     $this->assertEquals($lineItem1['values'][0], $lineItem2['values'][0]);
1663
1664     $this->quickCleanUpFinancialEntities();
1665   }
1666
1667   /**
1668    * Test repeat contribution successfully creates line items.
1669    */
1670   public function testRepeatTransactionIsTest() {
1671     $this->_params['is_test'] = 1;
1672     $originalContribution = $this->setUpRepeatTransaction(array('is_test' => 1));
1673
1674     $this->callAPISuccess('contribution', 'repeattransaction', array(
1675       'original_contribution_id' => $originalContribution['id'],
1676       'contribution_status_id' => 'Completed',
1677       'trxn_id' => uniqid(),
1678     ));
1679     $this->callAPISuccessGetCount('Contribution', array('contribution_test' => 1), 2);
1680   }
1681
1682   /**
1683    * Test repeat contribution passed in status.
1684    */
1685   public function testRepeatTransactionPassedInStatus() {
1686     $originalContribution = $this->setUpRepeatTransaction();
1687
1688     $this->callAPISuccess('contribution', 'repeattransaction', array(
1689       'original_contribution_id' => $originalContribution['id'],
1690       'contribution_status_id' => 'Pending',
1691       'trxn_id' => uniqid(),
1692     ));
1693     $this->callAPISuccessGetCount('Contribution', array('contribution_status_id' => 2), 1);
1694   }
1695
1696   /**
1697    * Test repeat contribution accepts recur_id instead of original_contribution_id.
1698    */
1699   public function testRepeatTransactionAcceptRecurID() {
1700     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
1701       'contact_id' => $this->_individualId,
1702       'installments' => '12',
1703       'frequency_interval' => '1',
1704       'amount' => '100',
1705       'contribution_status_id' => 1,
1706       'start_date' => '2012-01-01 00:00:00',
1707       'currency' => 'USD',
1708       'frequency_unit' => 'month',
1709       'payment_processor_id' => $this->paymentProcessorID,
1710     ));
1711     $this->callAPISuccess('contribution', 'create', array_merge(
1712         $this->_params,
1713         array('contribution_recur_id' => $contributionRecur['id']))
1714     );
1715
1716     $this->callAPISuccess('contribution', 'repeattransaction', array(
1717       'contribution_recur_id' => $contributionRecur['id'],
1718       'contribution_status_id' => 'Completed',
1719       'trxn_id' => uniqid(),
1720     ));
1721
1722     $this->quickCleanUpFinancialEntities();
1723   }
1724
1725   /**
1726    * CRM-16397 test appropriate action if total amount has changed for single line items.
1727    */
1728   public function testRepeatTransactionAlteredAmount() {
1729     $paymentProcessorID = $this->paymentProcessorCreate();
1730     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
1731       'contact_id' => $this->_individualId,
1732       'installments' => '12',
1733       'frequency_interval' => '1',
1734       'amount' => '500',
1735       'contribution_status_id' => 1,
1736       'start_date' => '2012-01-01 00:00:00',
1737       'currency' => 'USD',
1738       'frequency_unit' => 'month',
1739       'payment_processor_id' => $paymentProcessorID,
1740     ));
1741     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
1742         $this->_params,
1743         array(
1744           'contribution_recur_id' => $contributionRecur['id'],
1745         ))
1746     );
1747
1748     $this->callAPISuccess('contribution', 'repeattransaction', array(
1749       'original_contribution_id' => $originalContribution['id'],
1750       'contribution_status_id' => 'Completed',
1751       'trxn_id' => uniqid(),
1752       'total_amount' => '400',
1753       'fee_amount' => 50,
1754     ));
1755     $lineItemParams = array(
1756       'entity_id' => $originalContribution['id'],
1757       'sequential' => 1,
1758       'return' => array(
1759         'entity_table',
1760         'qty',
1761         'unit_price',
1762         'line_total',
1763         'label',
1764         'financial_type_id',
1765         'deductible_amount',
1766         'price_field_value_id',
1767         'price_field_id',
1768       ),
1769     );
1770     $this->callAPISuccessGetSingle('contribution', array(
1771       'total_amount' => 400,
1772       'fee_amount' => 50,
1773       'net_amount' => 350,
1774     ));
1775     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, array(
1776       'entity_id' => $originalContribution['id'],
1777     )));
1778     $expectedLineItem = array_merge(
1779       $lineItem1['values'][0], array(
1780         'line_total' => '400.00',
1781         'unit_price' => '400.00',
1782       )
1783     );
1784
1785     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, array(
1786       'entity_id' => $originalContribution['id'] + 1,
1787     )));
1788     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
1789     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
1790     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
1791   }
1792
1793   /**
1794    * CRM-17718 test appropriate action if financial type has changed for single line items.
1795    */
1796   public function testRepeatTransactionPassedInFinancialType() {
1797     $originalContribution = $this->setUpRecurringContribution();
1798
1799     $this->callAPISuccess('contribution', 'repeattransaction', array(
1800       'original_contribution_id' => $originalContribution['id'],
1801       'contribution_status_id' => 'Completed',
1802       'trxn_id' => uniqid(),
1803       'financial_type_id' => 2,
1804     ));
1805     $lineItemParams = array(
1806       'entity_id' => $originalContribution['id'],
1807       'sequential' => 1,
1808       'return' => array(
1809         'entity_table',
1810         'qty',
1811         'unit_price',
1812         'line_total',
1813         'label',
1814         'financial_type_id',
1815         'deductible_amount',
1816         'price_field_value_id',
1817         'price_field_id',
1818       ),
1819     );
1820
1821     $this->callAPISuccessGetSingle('contribution', array(
1822       'total_amount' => 100,
1823       'financial_type_id' => 2,
1824     ));
1825     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, array(
1826       'entity_id' => $originalContribution['id'],
1827     )));
1828     $expectedLineItem = array_merge(
1829       $lineItem1['values'][0], array(
1830         'line_total' => '100.00',
1831         'unit_price' => '100.00',
1832         'financial_type_id' => 2,
1833       )
1834     );
1835
1836     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, array(
1837       'entity_id' => $originalContribution['id'] + 1,
1838     )));
1839     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
1840     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
1841     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
1842   }
1843
1844   /**
1845    * CRM-17718 test appropriate action if financial type has changed for single line items.
1846    */
1847   public function testRepeatTransactionUpdatedFinancialType() {
1848     $originalContribution = $this->setUpRecurringContribution(array(), array('financial_type_id' => 2));
1849
1850     $this->callAPISuccess('contribution', 'repeattransaction', array(
1851       'contribution_recur_id' => $originalContribution['id'],
1852       'contribution_status_id' => 'Completed',
1853       'trxn_id' => uniqid(),
1854     ));
1855     $lineItemParams = array(
1856       'entity_id' => $originalContribution['id'],
1857       'sequential' => 1,
1858       'return' => array(
1859         'entity_table',
1860         'qty',
1861         'unit_price',
1862         'line_total',
1863         'label',
1864         'financial_type_id',
1865         'deductible_amount',
1866         'price_field_value_id',
1867         'price_field_id',
1868       ),
1869     );
1870
1871     $this->callAPISuccessGetSingle('contribution', array(
1872       'total_amount' => 100,
1873       'financial_type_id' => 2,
1874     ));
1875     $lineItem1 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, array(
1876       'entity_id' => $originalContribution['id'],
1877     )));
1878     $expectedLineItem = array_merge(
1879       $lineItem1['values'][0], array(
1880         'line_total' => '100.00',
1881         'unit_price' => '100.00',
1882         'financial_type_id' => 2,
1883       )
1884     );
1885
1886     $lineItem2 = $this->callAPISuccess('line_item', 'get', array_merge($lineItemParams, array(
1887       'entity_id' => $originalContribution['id'] + 1,
1888     )));
1889     unset($expectedLineItem['id'], $expectedLineItem['entity_id']);
1890     unset($lineItem2['values'][0]['id'], $lineItem2['values'][0]['entity_id']);
1891     $this->assertEquals($expectedLineItem, $lineItem2['values'][0]);
1892   }
1893
1894   /**
1895    * CRM-16397 test appropriate action if campaign has been passed in.
1896    */
1897   public function testRepeatTransactionPassedInCampaign() {
1898     $paymentProcessorID = $this->paymentProcessorCreate();
1899     $campaignID = $this->campaignCreate();
1900     $campaignID2 = $this->campaignCreate();
1901     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
1902       'contact_id' => $this->_individualId,
1903       'installments' => '12',
1904       'frequency_interval' => '1',
1905       'amount' => '100',
1906       'contribution_status_id' => 1,
1907       'start_date' => '2012-01-01 00:00:00',
1908       'currency' => 'USD',
1909       'frequency_unit' => 'month',
1910       'payment_processor_id' => $paymentProcessorID,
1911     ));
1912     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
1913       $this->_params,
1914       array(
1915         'contribution_recur_id' => $contributionRecur['id'],
1916         'campaign_id' => $campaignID,
1917       ))
1918     );
1919
1920     $this->callAPISuccess('contribution', 'repeattransaction', array(
1921       'original_contribution_id' => $originalContribution['id'],
1922       'contribution_status_id' => 'Completed',
1923       'trxn_id' => uniqid(),
1924       'campaign_id' => $campaignID2,
1925     ));
1926
1927     $this->callAPISuccessGetSingle('contribution', array(
1928       'total_amount' => 100,
1929       'campaign_id' => $campaignID2,
1930     ));
1931   }
1932
1933   /**
1934    * CRM-17718 campaign stored on contribution recur gets priority.
1935    *
1936    * This reflects the fact we permit people to update them.
1937    */
1938   public function testRepeatTransactionUpdatedCampaign() {
1939     $paymentProcessorID = $this->paymentProcessorCreate();
1940     $campaignID = $this->campaignCreate();
1941     $campaignID2 = $this->campaignCreate();
1942     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
1943       'contact_id' => $this->_individualId,
1944       'installments' => '12',
1945       'frequency_interval' => '1',
1946       'amount' => '100',
1947       'contribution_status_id' => 1,
1948       'start_date' => '2012-01-01 00:00:00',
1949       'currency' => 'USD',
1950       'frequency_unit' => 'month',
1951       'payment_processor_id' => $paymentProcessorID,
1952       'campaign_id' => $campaignID,
1953     ));
1954     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
1955       $this->_params,
1956       array(
1957         'contribution_recur_id' => $contributionRecur['id'],
1958         'campaign_id' => $campaignID2,
1959       ))
1960     );
1961
1962     $this->callAPISuccess('contribution', 'repeattransaction', array(
1963       'original_contribution_id' => $originalContribution['id'],
1964       'contribution_status_id' => 'Completed',
1965       'trxn_id' => uniqid(),
1966     ));
1967
1968     $this->callAPISuccessGetSingle('contribution', array(
1969       'total_amount' => 100,
1970       'campaign_id' => $campaignID,
1971     ));
1972   }
1973
1974   /**
1975    * Test completing a transaction does not 'mess' with net amount (CRM-15960).
1976    */
1977   public function testCompleteTransactionNetAmountOK() {
1978     $this->createLoggedInUser();
1979     $params = array_merge($this->_params, array('contribution_status_id' => 2));
1980     unset($params['net_amount']);
1981     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1982     $this->callAPISuccess('contribution', 'completetransaction', array(
1983       'id' => $contribution['id'],
1984     ));
1985     $contribution = $this->callAPISuccess('contribution', 'getsingle', array('id' => $contribution['id']));
1986     $this->assertEquals('Completed', $contribution['contribution_status']);
1987     $this->assertTrue(($contribution['total_amount'] - $contribution['net_amount']) == $contribution['fee_amount']);
1988   }
1989
1990   /**
1991    * CRM-14151 - Test completing a transaction via the API.
1992    */
1993   public function testCompleteTransactionWithReceiptDateSet() {
1994     $mut = new CiviMailUtils($this, TRUE);
1995     $this->createLoggedInUser();
1996     $params = array_merge($this->_params, array('contribution_status_id' => 2, 'receipt_date' => 'now'));
1997     $contribution = $this->callAPISuccess('contribution', 'create', $params);
1998     $this->callAPISuccess('contribution', 'completetransaction', array('id' => $contribution['id'], 'trxn_date' => date('Y-m-d')));
1999     $contribution = $this->callAPISuccess('contribution', 'get', array('id' => $contribution['id'], 'sequential' => 1));
2000     $this->assertEquals('Completed', $contribution['values'][0]['contribution_status']);
2001     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($contribution['values'][0]['receive_date'])));
2002     $mut->checkMailLog(array(
2003       'Receipt - Contribution',
2004       'Please print this confirmation for your records.',
2005     ));
2006     $mut->stop();
2007   }
2008
2009
2010   /**
2011    * Complete the transaction using the template with all the possible.
2012    */
2013   public function testCompleteTransactionWithTestTemplate() {
2014     $this->swapMessageTemplateForTestTemplate();
2015     $contribution = $this->setUpForCompleteTransaction();
2016     $this->callAPISuccess('contribution', 'completetransaction', array(
2017       'id' => $contribution['id'],
2018       'trxn_date' => date('2011-04-09'),
2019       'trxn_id' => 'kazam',
2020     ));
2021     $receive_date = $this->callAPISuccess('Contribution', 'getvalue', array('id' => $contribution['id'], 'return' => 'receive_date'));
2022     $this->mut->checkMailLog(array(
2023       'email:::anthony_anderson@civicrm.org',
2024       'is_monetary:::1',
2025       'amount:::100.00',
2026       'currency:::USD',
2027       'receive_date:::' . date('Ymd', strtotime($receive_date)),
2028       'receipt_date:::' . date('Ymd'),
2029       'contributeMode:::notify',
2030       'title:::Contribution',
2031       'displayName:::Mr. Anthony Anderson II',
2032       'trxn_id:::kazam',
2033       'contactID:::' . $this->_params['contact_id'],
2034       'contributionID:::' . $contribution['id'],
2035       'financialTypeId:::1',
2036       'financialTypeName:::Donation',
2037     ));
2038     $this->mut->stop();
2039     $this->revertTemplateToReservedTemplate();
2040   }
2041
2042   /**
2043    * Complete the transaction using the template with all the possible.
2044    */
2045   public function testCompleteTransactionContributionPageFromAddress() {
2046     $contributionPage = $this->callAPISuccess('ContributionPage', 'create', array(
2047       'receipt_from_name' => 'Mickey Mouse',
2048       'receipt_from_email' => 'mickey@mouse.com',
2049       'title' => "Test Contribution Page",
2050       'financial_type_id' => 1,
2051       'currency' => 'NZD',
2052       'goal_amount' => 50,
2053       'is_pay_later' => 1,
2054       'is_monetary' => TRUE,
2055       'is_email_receipt' => TRUE,
2056     ));
2057     $this->_params['contribution_page_id'] = $contributionPage['id'];
2058     $contribution = $this->setUpForCompleteTransaction();
2059     $this->callAPISuccess('contribution', 'completetransaction', array('id' => $contribution['id']));
2060     $this->mut->checkMailLog(array(
2061       'mickey@mouse.com',
2062       'Mickey Mouse <',
2063     ));
2064     $this->mut->stop();
2065   }
2066
2067   /**
2068    * Test completing first transaction in a recurring series.
2069    *
2070    * The status should be set to 'in progress' and the next scheduled payment date calculated.
2071    */
2072   public function testCompleteTransactionSetStatusToInProgress() {
2073     $paymentProcessorID = $this->paymentProcessorCreate();
2074     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
2075       'contact_id' => $this->_individualId,
2076       'installments' => '12',
2077       'frequency_interval' => '1',
2078       'amount' => '500',
2079       'contribution_status_id' => 'Pending',
2080       'start_date' => '2012-01-01 00:00:00',
2081       'currency' => 'USD',
2082       'frequency_unit' => 'month',
2083       'payment_processor_id' => $paymentProcessorID,
2084     ));
2085     $contribution = $this->callAPISuccess('contribution', 'create', array_merge(
2086       $this->_params,
2087       array(
2088         'contribution_recur_id' => $contributionRecur['id'],
2089         'contribution_status_id' => 'Pending',
2090       ))
2091     );
2092     $this->callAPISuccess('Contribution', 'completetransaction', array('id' => $contribution));
2093     $contributionRecur = $this->callAPISuccessGetSingle('ContributionRecur', array(
2094       'id' => $contributionRecur['id'],
2095       'return' => array('next_sched_contribution_date', 'contribution_status_id'),
2096     ));
2097     $this->assertEquals(5, $contributionRecur['contribution_status_id']);
2098     $this->assertEquals(date('Y-m-d 00:00:00', strtotime('+1 month')), $contributionRecur['next_sched_contribution_date']);
2099   }
2100
2101   /**
2102    * Test completing a pledge with the completeTransaction api..
2103    *
2104    * Note that we are creating a logged in user because email goes out from
2105    * that person.
2106    */
2107   public function testCompleteTransactionUpdatePledgePayment() {
2108     $mut = new CiviMailUtils($this, TRUE);
2109     $mut->clearMessages();
2110     $this->createLoggedInUser();
2111     $contributionID = $this->createPendingPledgeContribution();
2112     $this->callAPISuccess('contribution', 'completetransaction', array(
2113       'id' => $contributionID,
2114       'trxn_date' => '1 Feb 2013',
2115     ));
2116     $pledge = $this->callAPISuccessGetSingle('Pledge', array(
2117       'id' => $this->_ids['pledge'],
2118     ));
2119     $this->assertEquals('Completed', $pledge['pledge_status']);
2120
2121     $status = $this->callAPISuccessGetValue('PledgePayment', array(
2122       'pledge_id' => $this->_ids['pledge'],
2123       'return' => 'status_id',
2124     ));
2125     $this->assertEquals(1, $status);
2126     $mut->checkMailLog(array(
2127       '$ 500.00',
2128       'May 11th, 2012 12:00 AM',
2129     ));
2130     $mut->stop();
2131   }
2132
2133   /**
2134    * Test completing a transaction with an event via the API.
2135    *
2136    * Note that we are creating a logged in user because email goes out from
2137    * that person
2138    */
2139   public function testCompleteTransactionWithParticipantRecord() {
2140     $mut = new CiviMailUtils($this, TRUE);
2141     $mut->clearMessages();
2142     $this->createLoggedInUser();
2143     $contributionID = $this->createPendingParticipantContribution();
2144     $this->callAPISuccess('contribution', 'completetransaction', array(
2145         'id' => $contributionID,
2146       )
2147     );
2148     $participantStatus = $this->callAPISuccessGetValue('participant', array(
2149       'id' => $this->_ids['participant'],
2150       'return' => 'participant_status_id',
2151     ));
2152     $this->assertEquals(1, $participantStatus);
2153     $mut->checkMailLog(array(
2154       'Annual CiviCRM meet',
2155       'Event',
2156       'This letter is a confirmation that your registration has been received and your status has been updated to Registered.',
2157     ));
2158     $mut->stop();
2159   }
2160
2161   /**
2162    * Test membership is renewed when transaction completed.
2163    */
2164   public function testCompleteTransactionMembershipPriceSet() {
2165     $this->createPriceSetWithPage('membership');
2166     $stateOfGrace = $this->callAPISuccess('MembershipStatus', 'getvalue', array(
2167       'name' => 'Grace',
2168       'return' => 'id')
2169     );
2170     $this->setUpPendingContribution($this->_ids['price_field_value'][0]);
2171     $membership = $this->callAPISuccess('membership', 'getsingle', array('id' => $this->_ids['membership']));
2172     $logs = $this->callAPISuccess('MembershipLog', 'get', array(
2173       'membership_id' => $this->_ids['membership'],
2174     ));
2175     $this->assertEquals(1, $logs['count']);
2176     $this->assertEquals($stateOfGrace, $membership['status_id']);
2177     $this->callAPISuccess('contribution', 'completetransaction', array('id' => $this->_ids['contribution']));
2178     $membership = $this->callAPISuccess('membership', 'getsingle', array('id' => $this->_ids['membership']));
2179     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 1 year')), $membership['end_date']);
2180     $this->callAPISuccessGetSingle('LineItem', array(
2181       'entity_id' => $this->_ids['membership'],
2182       'entity_table' => 'civicrm_membership',
2183     ));
2184     $logs = $this->callAPISuccess('MembershipLog', 'get', array(
2185       'membership_id' => $this->_ids['membership'],
2186     ));
2187     $this->assertEquals(2, $logs['count']);
2188     $this->assertNotEquals($stateOfGrace, $logs['values'][2]['status_id']);
2189     $this->cleanUpAfterPriceSets();
2190   }
2191
2192   /**
2193    * Test membership is renewed when transaction completed.
2194    */
2195   public function testCompleteTransactionMembershipPriceSetTwoTerms() {
2196     $this->createPriceSetWithPage('membership');
2197     $this->setUpPendingContribution($this->_ids['price_field_value'][1]);
2198     $this->callAPISuccess('contribution', 'completetransaction', array('id' => $this->_ids['contribution']));
2199     $membership = $this->callAPISuccess('membership', 'getsingle', array('id' => $this->_ids['membership']));
2200     $this->assertEquals(date('Y-m-d', strtotime('yesterday + 2 years')), $membership['end_date']);
2201     $this->cleanUpAfterPriceSets();
2202   }
2203
2204   public function cleanUpAfterPriceSets() {
2205     $this->quickCleanUpFinancialEntities();
2206     $this->contactDelete($this->_ids['contact']);
2207   }
2208
2209
2210   /**
2211    * Create price set with contribution test for test setup.
2212    *
2213    * This could be merged with 4.5 function setup in api_v3_ContributionPageTest::setUpContributionPage
2214    * on parent class at some point (fn is not in 4.4).
2215    *
2216    * @param $entity
2217    * @param array $params
2218    */
2219   public function createPriceSetWithPage($entity, $params = array()) {
2220     $membershipTypeID = $this->membershipTypeCreate();
2221     $contributionPageResult = $this->callAPISuccess('contribution_page', 'create', array(
2222       'title' => "Test Contribution Page",
2223       'financial_type_id' => 1,
2224       'currency' => 'NZD',
2225       'goal_amount' => 50,
2226       'is_pay_later' => 1,
2227       'is_monetary' => TRUE,
2228       'is_email_receipt' => FALSE,
2229     ));
2230     $priceSet = $this->callAPISuccess('price_set', 'create', array(
2231       'is_quick_config' => 0,
2232       'extends' => 'CiviMember',
2233       'financial_type_id' => 1,
2234       'title' => 'my Page',
2235     ));
2236     $priceSetID = $priceSet['id'];
2237
2238     CRM_Price_BAO_PriceSet::addTo('civicrm_contribution_page', $contributionPageResult['id'], $priceSetID);
2239     $priceField = $this->callAPISuccess('price_field', 'create', array(
2240       'price_set_id' => $priceSetID,
2241       'label' => 'Goat Breed',
2242       'html_type' => 'Radio',
2243     ));
2244     $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', array(
2245         'price_set_id' => $priceSetID,
2246         'price_field_id' => $priceField['id'],
2247         'label' => 'Long Haired Goat',
2248         'amount' => 20,
2249         'financial_type_id' => 'Donation',
2250         'membership_type_id' => $membershipTypeID,
2251         'membership_num_terms' => 1,
2252       )
2253     );
2254     $this->_ids['price_field_value'] = array($priceFieldValue['id']);
2255     $priceFieldValue = $this->callAPISuccess('price_field_value', 'create', array(
2256         'price_set_id' => $priceSetID,
2257         'price_field_id' => $priceField['id'],
2258         'label' => 'Shoe-eating Goat',
2259         'amount' => 10,
2260         'financial_type_id' => 'Donation',
2261         'membership_type_id' => $membershipTypeID,
2262         'membership_num_terms' => 2,
2263       )
2264     );
2265     $this->_ids['price_field_value'][] = $priceFieldValue['id'];
2266     $this->_ids['price_set'] = $priceSetID;
2267     $this->_ids['contribution_page'] = $contributionPageResult['id'];
2268     $this->_ids['price_field'] = array($priceField['id']);
2269
2270     $this->_ids['membership_type'] = $membershipTypeID;
2271   }
2272
2273   /**
2274    * Set up a pending transaction with a specific price field id.
2275    *
2276    * @param int $priceFieldValueID
2277    */
2278   public function setUpPendingContribution($priceFieldValueID) {
2279     $contactID = $this->individualCreate();
2280     $membership = $this->callAPISuccess('membership', 'create', array(
2281       'contact_id' => $contactID,
2282       'membership_type_id' => $this->_ids['membership_type'],
2283       'start_date' => 'yesterday - 1 year',
2284       'end_date' => 'yesterday',
2285       'join_date' => 'yesterday - 1 year',
2286     ));
2287     $contribution = $this->callAPISuccess('contribution', 'create', array(
2288       'domain_id' => 1,
2289       'contact_id' => $contactID,
2290       'receive_date' => date('Ymd'),
2291       'total_amount' => 100.00,
2292       'financial_type_id' => 1,
2293       'payment_instrument_id' => 'Credit Card',
2294       'non_deductible_amount' => 10.00,
2295       'trxn_id' => 'jdhfi88',
2296       'invoice_id' => 'djfhiewuyr',
2297       'source' => 'SSF',
2298       'contribution_status_id' => 2,
2299       'contribution_page_id' => $this->_ids['contribution_page'],
2300       'api.membership_payment.create' => array('membership_id' => $membership['id']),
2301     ));
2302
2303     $this->callAPISuccess('line_item', 'create', array(
2304       'entity_id' => $contribution['id'],
2305       'entity_table' => 'civicrm_contribution',
2306       'contribution_id' => $contribution['id'],
2307       'price_field_id' => $this->_ids['price_field'][0],
2308       'qty' => 1,
2309       'unit_price' => 20,
2310       'line_total' => 20,
2311       'financial_type_id' => 1,
2312       'price_field_value_id' => $priceFieldValueID,
2313     ));
2314     $this->_ids['contact'] = $contactID;
2315     $this->_ids['contribution'] = $contribution['id'];
2316     $this->_ids['membership'] = $membership['id'];
2317   }
2318
2319   /**
2320    * Test sending a mail via the API.
2321    */
2322   public function testSendMail() {
2323     $mut = new CiviMailUtils($this, TRUE);
2324     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
2325     $this->callAPISuccess('contribution', 'sendconfirmation', array(
2326         'id' => $contribution['id'],
2327         'receipt_from_email' => 'api@civicrm.org',
2328       )
2329     );
2330     $mut->checkMailLog(array(
2331         '$ 100.00',
2332         'Contribution Information',
2333         'Please print this confirmation for your records',
2334       ), array(
2335         'Event',
2336       )
2337     );
2338     $mut->stop();
2339   }
2340
2341   /**
2342    * Test sending a mail via the API.
2343    */
2344   public function testSendMailEvent() {
2345     $mut = new CiviMailUtils($this, TRUE);
2346     $contribution = $this->callAPISuccess('contribution', 'create', $this->_params);
2347     $event = $this->eventCreate(array(
2348       'is_email_confirm' => 1,
2349       'confirm_from_email' => 'test@civicrm.org',
2350     ));
2351     $this->_eventID = $event['id'];
2352     $participantParams = array(
2353       'contact_id' => $this->_individualId,
2354       'event_id' => $this->_eventID,
2355       'status_id' => 1,
2356       'role_id' => 1,
2357       // to ensure it matches later on
2358       'register_date' => '2007-07-21 00:00:00',
2359       'source' => 'Online Event Registration: API Testing',
2360
2361     );
2362     $participant = $this->callAPISuccess('participant', 'create', $participantParams);
2363     $this->callAPISuccess('participant_payment', 'create', array(
2364       'participant_id' => $participant['id'],
2365       'contribution_id' => $contribution['id'],
2366     ));
2367     $this->callAPISuccess('contribution', 'sendconfirmation', array(
2368         'id' => $contribution['id'],
2369         'receipt_from_email' => 'api@civicrm.org',
2370       )
2371     );
2372
2373     $mut->checkMailLog(array(
2374         'Annual CiviCRM meet',
2375         'Event',
2376         'To: "Mr. Anthony Anderson II" <anthony_anderson@civicrm.org>',
2377       ), array()
2378     );
2379     $mut->stop();
2380   }
2381
2382   /**
2383    * This function does a GET & compares the result against the $params.
2384    *
2385    * Use as a double check on Creates.
2386    *
2387    * @param array $params
2388    * @param int $id
2389    * @param bool $delete
2390    */
2391   public function contributionGetnCheck($params, $id, $delete = TRUE) {
2392
2393     $contribution = $this->callAPISuccess('Contribution', 'Get', array(
2394       'id' => $id,
2395
2396     ));
2397
2398     if ($delete) {
2399       $this->callAPISuccess('contribution', 'delete', array('id' => $id));
2400     }
2401     $this->assertAPISuccess($contribution, 0);
2402     $values = $contribution['values'][$contribution['id']];
2403     $params['receive_date'] = date('Y-m-d H:i:s', strtotime($params['receive_date']));
2404     // this is not returned in id format
2405     unset($params['payment_instrument_id']);
2406     $params['contribution_source'] = $params['source'];
2407     unset($params['source']);
2408     foreach ($params as $key => $value) {
2409       $this->assertEquals($value, $values[$key], $key . " value: $value doesn't match " . print_r($values, TRUE));
2410     }
2411   }
2412
2413   /**
2414    * Create a pending contribution & linked pending pledge record.
2415    */
2416   public function createPendingPledgeContribution() {
2417
2418     $pledgeID = $this->pledgeCreate(array('contact_id' => $this->_individualId, 'installments' => 1, 'amount' => 500));
2419     $this->_ids['pledge'] = $pledgeID;
2420     $contribution = $this->callAPISuccess('contribution', 'create', array_merge($this->_params, array(
2421       'contribution_status_id' => 'Pending',
2422        'total_amount' => 500,
2423       ))
2424     );
2425     $paymentID = $this->callAPISuccessGetValue('PledgePayment', array(
2426       'options' => array('limit' => 1),
2427       'return' => 'id',
2428     ));
2429     $this->callAPISuccess('PledgePayment', 'create', array(
2430       'id' => $paymentID,
2431       'contribution_id' =>
2432       $contribution['id'],
2433       'status_id' => 'Pending',
2434       'scheduled_amount' => 500,
2435     ));
2436
2437     return $contribution['id'];
2438   }
2439
2440   /**
2441    * Create a pending contribution & linked pending participant record (along with an event).
2442    */
2443   public function createPendingParticipantContribution() {
2444     $event = $this->eventCreate(array('is_email_confirm' => 1, 'confirm_from_email' => 'test@civicrm.org'));
2445     $participantID = $this->participantCreate(array('event_id' => $event['id'], 'status_id' => 6));
2446     $this->_ids['participant'] = $participantID;
2447     $params = array_merge($this->_params, array('contribution_status_id' => 2, 'financial_type_id' => 'Event Fee'));
2448     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2449     $this->callAPISuccess('participant_payment', 'create', array(
2450       'contribution_id' => $contribution['id'],
2451       'participant_id' => $participantID,
2452     ));
2453     $this->callAPISuccess('line_item', 'get', array(
2454       'entity_id' => $contribution['id'],
2455       'entity_table' => 'civicrm_contribution',
2456       'api.line_item.create' => array(
2457         'entity_id' => $participantID,
2458         'entity_table' => 'civicrm_participant',
2459       ),
2460     ));
2461     return $contribution['id'];
2462   }
2463
2464   /**
2465    * Get financial transaction amount.
2466    *
2467    * @param int $contId
2468    *
2469    * @return null|string
2470    */
2471   public function _getFinancialTrxnAmount($contId) {
2472     $query = "SELECT
2473      SUM( ft.total_amount ) AS total
2474      FROM civicrm_financial_trxn AS ft
2475      LEFT JOIN civicrm_entity_financial_trxn AS ceft ON ft.id = ceft.financial_trxn_id
2476      WHERE ceft.entity_table = 'civicrm_contribution'
2477      AND ceft.entity_id = {$contId}";
2478
2479     $result = CRM_Core_DAO::singleValueQuery($query);
2480     return $result;
2481   }
2482
2483   /**
2484    * @param int $contId
2485    *
2486    * @return null|string
2487    */
2488   public function _getFinancialItemAmount($contId) {
2489     $lineItem = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
2490     $query = "SELECT
2491      SUM(amount)
2492      FROM civicrm_financial_item
2493      WHERE entity_table = 'civicrm_line_item'
2494      AND entity_id = {$lineItem}";
2495     $result = CRM_Core_DAO::singleValueQuery($query);
2496     return $result;
2497   }
2498
2499   /**
2500    * @param int $contId
2501    * @param $context
2502    */
2503   public function _checkFinancialItem($contId, $context) {
2504     if ($context != 'paylater') {
2505       $params = array(
2506         'entity_id' => $contId,
2507         'entity_table' => 'civicrm_contribution',
2508       );
2509       $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($params, TRUE));
2510       $entityParams = array(
2511         'financial_trxn_id' => $trxn['financial_trxn_id'],
2512         'entity_table' => 'civicrm_financial_item',
2513       );
2514       $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
2515       $params = array(
2516         'id' => $entityTrxn['entity_id'],
2517       );
2518     }
2519     if ($context == 'paylater') {
2520       $lineItems = CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution');
2521       foreach ($lineItems as $key => $item) {
2522         $params = array(
2523           'entity_id' => $key,
2524           'entity_table' => 'civicrm_line_item',
2525         );
2526         $compareParams = array('status_id' => 1);
2527         $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
2528       }
2529     }
2530     elseif ($context == 'refund') {
2531       $compareParams = array(
2532         'status_id' => 1,
2533         'financial_account_id' => 1,
2534         'amount' => -100,
2535       );
2536     }
2537     elseif ($context == 'cancelPending') {
2538       $compareParams = array(
2539         'status_id' => 3,
2540         'financial_account_id' => 1,
2541         'amount' => -100,
2542       );
2543     }
2544     elseif ($context == 'changeFinancial') {
2545       $lineKey = key(CRM_Price_BAO_LineItem::getLineItems($contId, 'contribution'));
2546       $params = array(
2547         'entity_id' => $lineKey,
2548         'amount' => -100,
2549       );
2550       $compareParams = array(
2551         'financial_account_id' => 1,
2552       );
2553       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
2554       $params = array(
2555         'financial_account_id' => 3,
2556         'entity_id' => $lineKey,
2557       );
2558       $compareParams = array(
2559         'amount' => 100,
2560       );
2561     }
2562     if ($context != 'paylater') {
2563       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $params, $compareParams);
2564     }
2565   }
2566
2567   /**
2568    * Check financial transaction.
2569    *
2570    * @todo break this down into sensible functions - most calls to it only use a few lines out of the big if.
2571    *
2572    * @param array $contribution
2573    * @param string $context
2574    * @param int $instrumentId
2575    * @param array $extraParams
2576    */
2577   public function _checkFinancialTrxn($contribution, $context, $instrumentId = NULL, $extraParams = array()) {
2578     $trxnParams = array(
2579       'entity_id' => $contribution['id'],
2580       'entity_table' => 'civicrm_contribution',
2581     );
2582     $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($trxnParams, TRUE));
2583     $params = array(
2584       'id' => $trxn['financial_trxn_id'],
2585     );
2586     if ($context == 'payLater') {
2587       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
2588       $compareParams = array(
2589         'status_id' => 1,
2590         'from_financial_account_id' => CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId),
2591       );
2592     }
2593     elseif ($context == 'refund') {
2594       $compareParams = array(
2595         'to_financial_account_id' => 6,
2596         'total_amount' => -100,
2597         'status_id' => 7,
2598         'trxn_date' => '2015-01-01 09:00:00',
2599         'trxn_id' => 'the refund',
2600       );
2601     }
2602     elseif ($context == 'cancelPending') {
2603       $compareParams = array(
2604         'to_financial_account_id' => 7,
2605         'total_amount' => -100,
2606         'status_id' => 3,
2607       );
2608     }
2609     elseif ($context == 'changeFinancial' || $context == 'paymentInstrument') {
2610       $entityParams = array(
2611         'entity_id' => $contribution['id'],
2612         'entity_table' => 'civicrm_contribution',
2613         'amount' => -100,
2614       );
2615       $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
2616       $trxnParams1 = array(
2617         'id' => $trxn['financial_trxn_id'],
2618       );
2619       $compareParams = array(
2620         'total_amount' => -100,
2621         'status_id' => 1,
2622       );
2623       if ($context == 'paymentInstrument') {
2624         $compareParams += array(
2625           'to_financial_account_id' => CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount(4),
2626           'payment_instrument_id' => 4,
2627         );
2628       }
2629       else {
2630         $compareParams['to_financial_account_id'] = 12;
2631       }
2632       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams1, array_merge($compareParams, $extraParams));
2633       $compareParams['total_amount'] = 100;
2634       if ($context == 'paymentInstrument') {
2635         $compareParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($instrumentId);
2636         $compareParams['payment_instrument_id'] = $instrumentId;
2637       }
2638       else {
2639         $compareParams['to_financial_account_id'] = 12;
2640       }
2641     }
2642
2643     $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $params, array_merge($compareParams, $extraParams));
2644   }
2645
2646   /**
2647    * @return mixed
2648    */
2649   public function _addPaymentInstrument() {
2650     $gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'payment_instrument', 'id', 'name');
2651     $optionParams = array(
2652       'option_group_id' => $gId,
2653       'label' => 'Test Card',
2654       'name' => 'Test Card',
2655       'value' => '6',
2656       'weight' => '6',
2657       'is_active' => 1,
2658     );
2659     $optionValue = $this->callAPISuccess('option_value', 'create', $optionParams);
2660     $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Asset Account is' "));
2661     $financialParams = array(
2662       'entity_table' => 'civicrm_option_value',
2663       'entity_id' => $optionValue['id'],
2664       'account_relationship' => $relationTypeId,
2665       'financial_account_id' => 7,
2666     );
2667     CRM_Financial_BAO_FinancialTypeAccount::add($financialParams, CRM_Core_DAO::$_nullArray);
2668     $this->assertNotEmpty($optionValue['values'][$optionValue['id']]['value']);
2669     return $optionValue['values'][$optionValue['id']]['value'];
2670   }
2671
2672   /**
2673    * @param array $params
2674    * @param $context
2675    */
2676   public function _checkFinancialRecords($params, $context) {
2677     $entityParams = array(
2678       'entity_id' => $params['id'],
2679       'entity_table' => 'civicrm_contribution',
2680     );
2681     $contribution = $this->callAPISuccess('contribution', 'getsingle', array('id' => $params['id']));
2682     $this->assertEquals($contribution['total_amount'] - $contribution['fee_amount'], $contribution['net_amount']);
2683     if ($context == 'pending') {
2684       $trxn = CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams);
2685       $this->assertNull($trxn, 'No Trxn to be created until IPN callback');
2686       return;
2687     }
2688     $trxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
2689     $trxnParams = array(
2690       'id' => $trxn['financial_trxn_id'],
2691     );
2692     if ($context != 'online' && $context != 'payLater') {
2693       $compareParams = array(
2694         'to_financial_account_id' => 6,
2695         'total_amount' => 100,
2696         'status_id' => 1,
2697       );
2698     }
2699     if ($context == 'feeAmount') {
2700       $compareParams['fee_amount'] = 50;
2701     }
2702     elseif ($context == 'online') {
2703       $compareParams = array(
2704         'to_financial_account_id' => 12,
2705         'total_amount' => 100,
2706         'status_id' => 1,
2707       );
2708     }
2709     elseif ($context == 'payLater') {
2710       $compareParams = array(
2711         'to_financial_account_id' => 7,
2712         'total_amount' => 100,
2713         'status_id' => 2,
2714       );
2715     }
2716     $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
2717     $entityParams = array(
2718       'financial_trxn_id' => $trxn['financial_trxn_id'],
2719       'entity_table' => 'civicrm_financial_item',
2720     );
2721     $entityTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($entityParams));
2722     $fitemParams = array(
2723       'id' => $entityTrxn['entity_id'],
2724     );
2725     $compareParams = array(
2726       'amount' => 100,
2727       'status_id' => 1,
2728       'financial_account_id' => 1,
2729     );
2730     if ($context == 'payLater') {
2731       $compareParams = array(
2732         'amount' => 100,
2733         'status_id' => 3,
2734         'financial_account_id' => 1,
2735       );
2736     }
2737     $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
2738     if ($context == 'feeAmount') {
2739       $maxParams = array(
2740         'entity_id' => $params['id'],
2741         'entity_table' => 'civicrm_contribution',
2742       );
2743       $maxTrxn = current(CRM_Financial_BAO_FinancialItem::retrieveEntityFinancialTrxn($maxParams, TRUE));
2744       $trxnParams = array(
2745         'id' => $maxTrxn['financial_trxn_id'],
2746       );
2747       $compareParams = array(
2748         'to_financial_account_id' => 5,
2749         'from_financial_account_id' => 6,
2750         'total_amount' => 50,
2751         'status_id' => 1,
2752       );
2753       $trxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['id'], 'DESC');
2754       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialTrxn', $trxnParams, $compareParams);
2755       $fitemParams = array(
2756         'entity_id' => $trxnId['financialTrxnId'],
2757         'entity_table' => 'civicrm_financial_trxn',
2758       );
2759       $compareParams = array(
2760         'amount' => 50,
2761         'status_id' => 1,
2762         'financial_account_id' => 5,
2763       );
2764       $this->assertDBCompareValues('CRM_Financial_DAO_FinancialItem', $fitemParams, $compareParams);
2765     }
2766   }
2767
2768   /**
2769    * Set up the basic recurring contribution for tests.
2770    *
2771    * @param array $generalParams
2772    *   Parameters that can be merged into the recurring AND the contribution.
2773    *
2774    * @param array $recurParams
2775    *   Parameters to merge into the recur only.
2776    *
2777    * @return array|int
2778    */
2779   protected function setUpRecurringContribution($generalParams = array(), $recurParams = array()) {
2780     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge(array(
2781       'contact_id' => $this->_individualId,
2782       'installments' => '12',
2783       'frequency_interval' => '1',
2784       'amount' => '100',
2785       'contribution_status_id' => 1,
2786       'start_date' => '2012-01-01 00:00:00',
2787       'currency' => 'USD',
2788       'frequency_unit' => 'month',
2789       'payment_processor_id' => $this->paymentProcessorID,
2790     ), $generalParams, $recurParams));
2791     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2792       $this->_params,
2793       array(
2794         'contribution_recur_id' => $contributionRecur['id'],
2795       ), $generalParams)
2796     );
2797     return $originalContribution;
2798   }
2799
2800   /**
2801    * Set up a repeat transaction.
2802    *
2803    * @param array $recurParams
2804    *
2805    * @return array
2806    */
2807   protected function setUpRepeatTransaction($recurParams = array()) {
2808     $paymentProcessorID = $this->paymentProcessorCreate();
2809     $contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array_merge(array(
2810       'contact_id' => $this->_individualId,
2811       'installments' => '12',
2812       'frequency_interval' => '1',
2813       'amount' => '500',
2814       'contribution_status_id' => 1,
2815       'start_date' => '2012-01-01 00:00:00',
2816       'currency' => 'USD',
2817       'frequency_unit' => 'month',
2818       'payment_processor_id' => $paymentProcessorID,
2819     ), $recurParams));
2820     $originalContribution = $this->callAPISuccess('contribution', 'create', array_merge(
2821       $this->_params,
2822       array('contribution_recur_id' => $contributionRecur['id']))
2823     );
2824     return $originalContribution;
2825   }
2826
2827   /**
2828    * Common set up routine.
2829    *
2830    * @return array
2831    */
2832   protected function setUpForCompleteTransaction() {
2833     $this->mut = new CiviMailUtils($this, TRUE);
2834     $this->createLoggedInUser();
2835     $params = array_merge($this->_params, array('contribution_status_id' => 2, 'receipt_date' => 'now'));
2836     $contribution = $this->callAPISuccess('contribution', 'create', $params);
2837     return $contribution;
2838   }
2839
2840 }