api/v3/Contribution.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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  * This api exposes CiviCRM Contribution records.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Add or update a Contribution.
  36  *
  37  * @param array $params
  38  *   Input parameters.
  39  *
  40  * @throws API_Exception
  41  * @return array
  42  *   Api result array
  43  */
  44 function civicrm_api3_contribution_create(&$params) {
  45   $values = array();
  46   _civicrm_api3_custom_format_params($params, $values, 'Contribution');
  47   $params = array_merge($params, $values);
  48
  49   if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
  50     if (empty($params['id'])) {
  51       $op = 'add';
  52     }
  53     else {
  54       if (empty($params['financial_type_id'])) {
  55         $params['financial_type_id'] = civicrm_api3('Contribution', 'getvalue', array(
  56           'id' => $params['id'],
  57           'return' => 'financial_type_id',
  58         ));
  59       }
  60       $op = 'edit';
  61     }
  62     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($types, $op);
  63     if (!in_array($params['financial_type_id'], array_keys($types))) {
  64       return civicrm_api3_create_error('You do not have permission to create this contribution');
  65     }
  66   }
  67   if (!empty($params['id']) && !empty($params['contribution_status_id'])) {
  68     $error = array();
  69     //throw error for invalid status change such as setting completed back to pending
  70     //@todo this sort of validation belongs in the BAO not the API - if it is not an OK
  71     // action it needs to be blocked there. If it is Ok through a form it needs to be OK through the api
  72     CRM_Contribute_BAO_Contribution::checkStatusValidation(NULL, $params, $error);
  73     if (array_key_exists('contribution_status_id', $error)) {
  74       throw new API_Exception($error['contribution_status_id']);
  75     }
  76   }
  77   if (!empty($params['id']) && !empty($params['financial_type_id'])) {
  78     $error = array();
  79     CRM_Contribute_BAO_Contribution::checkFinancialTypeChange($params['financial_type_id'], $params['id'], $error);
  80     if (array_key_exists('financial_type_id', $error)) {
  81       throw new API_Exception($error['financial_type_id']);
  82     }
  83   }
  84   _civicrm_api3_contribution_create_legacy_support_45($params);
  85
  86   // Make sure tax calculation is handled via api.
  87   $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params);
  88
  89   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Contribution');
  90 }
  91
  92 /**
  93  * Adjust Metadata for Create action.
  94  *
  95  * The metadata is used for setting defaults, documentation & validation.
  96  *
  97  * @param array $params
  98  *   Array of parameters determined by getfields.
  99  */
 100 function _civicrm_api3_contribution_create_spec(&$params) {
 101   $params['contact_id']['api.required'] = 1;
 102   $params['total_amount']['api.required'] = 1;
 103   $params['payment_instrument_id']['api.aliases'] = array('payment_instrument');
 104   $params['receive_date']['api.default'] = 'now';
 105   $params['payment_processor'] = array(
 106     'name' => 'payment_processor',
 107     'title' => 'Payment Processor ID',
 108     'description' => 'ID of payment processor used for this contribution',
 109     // field is called payment processor - not payment processor id but can only be one id so
 110     // it seems likely someone will fix it up one day to be more consistent - lets alias it from the start
 111     'api.aliases' => array('payment_processor_id'),
 112     'type' => CRM_Utils_Type::T_INT,
 113   );
 114   $params['financial_type_id']['api.aliases'] = array('contribution_type_id', 'contribution_type');
 115   $params['financial_type_id']['api.required'] = 1;
 116   $params['note'] = array(
 117     'name' => 'note',
 118     'uniqueName' => 'contribution_note',
 119     'title' => 'note',
 120     'type' => 2,
 121     'description' => 'Associated Note in the notes table',
 122   );
 123   $params['soft_credit_to'] = array(
 124     'name' => 'soft_credit_to',
 125     'title' => 'Soft Credit contact ID (legacy)',
 126     'type' => 1,
 127     'description' => 'ID of Contact to be Soft credited to (deprecated - use contribution_soft api)',
 128     'FKClassName' => 'CRM_Contact_DAO_Contact',
 129   );
 130   $params['honor_contact_id'] = array(
 131     'name' => 'honor_contact_id',
 132     'title' => 'Honoree contact ID (legacy)',
 133     'type' => 1,
 134     'description' => 'ID of honoree contact (deprecated - use contribution_soft api)',
 135     'FKClassName' => 'CRM_Contact_DAO_Contact',
 136   );
 137   $params['honor_type_id'] = array(
 138     'name' => 'honor_type_id',
 139     'title' => 'Honoree Type (legacy)',
 140     'type' => 1,
 141     'description' => 'Type of honoree contact (deprecated - use contribution_soft api)',
 142     'pseudoconstant' => TRUE,
 143   );
 144   // note this is a recommended option but not adding as a default to avoid
 145   // creating unnecessary changes for the dev
 146   $params['skipRecentView'] = array(
 147     'name' => 'skipRecentView',
 148     'title' => 'Skip adding to recent view',
 149     'type' => CRM_Utils_Type::T_BOOLEAN,
 150     'description' => 'Do not add to recent view (setting this improves performance)',
 151   );
 152   $params['skipLineItem'] = array(
 153     'name' => 'skipLineItem',
 154     'title' => 'Skip adding line items',
 155     'type' => CRM_Utils_Type::T_BOOLEAN,
 156     'api.default' => 0,
 157     'description' => 'Do not add line items by default (if you wish to add your own)',
 158   );
 159   $params['batch_id'] = array(
 160     'title' => 'Batch',
 161     'type' => 1,
 162     'description' => 'Batch which relevant transactions should be added to',
 163   );
 164 }
 165
 166 /**
 167  * Support for schema changes made in 4.5.
 168  *
 169  * The main purpose of the API is to provide integrators a level of stability not provided by
 170  * the core code or schema - this means we have to provide support for api calls (where possible)
 171  * across schema changes.
 172  *
 173  * @param array $params
 174  */
 175 function _civicrm_api3_contribution_create_legacy_support_45(&$params) {
 176   //legacy soft credit handling - recommended approach is chaining
 177   if (!empty($params['soft_credit_to'])) {
 178     $params['soft_credit'][] = array(
 179       'contact_id'          => $params['soft_credit_to'],
 180       'amount'              => $params['total_amount'],
 181       'soft_credit_type_id' => CRM_Core_OptionGroup::getDefaultValue("soft_credit_type"),
 182     );
 183   }
 184   if (!empty($params['honor_contact_id'])) {
 185     $params['soft_credit'][] = array(
 186       'contact_id'          => $params['honor_contact_id'],
 187       'amount'              => $params['total_amount'],
 188       'soft_credit_type_id' => CRM_Utils_Array::value('honor_type_id', $params, CRM_Core_OptionGroup::getValue('soft_credit_type', 'in_honor_of', 'name')),
 189     );
 190   }
 191 }
 192
 193 /**
 194  * Delete a Contribution.
 195  *
 196  * @param array $params
 197  *   Input parameters.
 198  *
 199  * @return array
 200  */
 201 function civicrm_api3_contribution_delete($params) {
 202
 203   $contributionID = !empty($params['contribution_id']) ? $params['contribution_id'] : $params['id'];
 204   // First check contribution financial type
 205   $financialType = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionID, 'financial_type_id');
 206   // Now check permissioned lineitems & permissioned contribution
 207   if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()
 208     && !CRM_Core_Permission::check('delete contributions of type ' . CRM_Contribute_PseudoConstant::financialType($financialType)) ||
 209       !CRM_Financial_BAO_FinancialType::checkPermissionedLineItems($contributionID, 'delete', FALSE)
 210   ) {
 211     return civicrm_api3_create_error('You do not have permission to delete this contribution');
 212   }
 213   if (CRM_Contribute_BAO_Contribution::deleteContribution($contributionID)) {
 214     return civicrm_api3_create_success(array($contributionID => 1));
 215   }
 216   else {
 217     return civicrm_api3_create_error('Could not delete contribution');
 218   }
 219 }
 220
 221 /**
 222  * Modify metadata for delete action.
 223  *
 224  * Legacy support for contribution_id.
 225  *
 226  * @param array $params
 227  */
 228 function _civicrm_api3_contribution_delete_spec(&$params) {
 229   $params['id']['api.aliases'] = array('contribution_id');
 230 }
 231
 232 /**
 233  * Retrieve a set of contributions.
 234  *
 235  * @param array $params
 236  *  Input parameters.
 237  *
 238  * @return array
 239  *   Array of contributions, if error an array with an error id and error message
 240  */
 241 function civicrm_api3_contribution_get($params) {
 242
 243   $mode = CRM_Contact_BAO_Query::MODE_CONTRIBUTE;
 244   list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, 'Contribution');
 245
 246   $contribution = array();
 247   while ($dao->fetch()) {
 248     //CRM-8662
 249     $contribution_details = $query->store($dao);
 250     $softContribution = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($dao->contribution_id, TRUE);
 251     $contribution[$dao->contribution_id] = array_merge($contribution_details, $softContribution);
 252     // format soft credit for backward compatibility
 253     _civicrm_api3_format_soft_credit($contribution[$dao->contribution_id]);
 254   }
 255   return civicrm_api3_create_success($contribution, $params, 'Contribution', 'get');
 256 }
 257
 258 /**
 259  * Get number of contacts matching the supplied criteria.
 260  *
 261  * @param array $params
 262  *
 263  * @return int
 264  */
 265 function civicrm_api3_contribution_getcount($params) {
 266   $count = _civicrm_api3_get_using_query_object('Contribution', $params, array(), TRUE, CRM_Contact_BAO_Query::MODE_CONTRIBUTE);
 267   return (int) $count;
 268 }
 269
 270 /**
 271  * This function is used to format the soft credit for backward compatibility.
 272  *
 273  * As of v4.4 we support multiple soft credit, so now contribution returns array with 'soft_credit' as key
 274  * but we still return first soft credit as a part of contribution array
 275  *
 276  * @param $contribution
 277  */
 278 function _civicrm_api3_format_soft_credit(&$contribution) {
 279   if (!empty($contribution['soft_credit'])) {
 280     $contribution['soft_credit_to'] = $contribution['soft_credit'][1]['contact_id'];
 281     $contribution['soft_credit_id'] = $contribution['soft_credit'][1]['soft_credit_id'];
 282   }
 283 }
 284
 285 /**
 286  * Adjust Metadata for Get action.
 287  *
 288  * The metadata is used for setting defaults, documentation & validation.
 289  *
 290  * @param array $params
 291  *   Array of parameters determined by getfields.
 292  */
 293 function _civicrm_api3_contribution_get_spec(&$params) {
 294   $params['contribution_test'] = array(
 295     'api.default' => 0,
 296     'type' => CRM_Utils_Type::T_BOOLEAN,
 297     'title' => 'Get Test Contributions?',
 298     'api.aliases' => array('is_test'),
 299   );
 300
 301   $params['financial_type_id']['api.aliases'] = array('contribution_type_id');
 302   $params['payment_instrument_id']['api.aliases'] = array('contribution_payment_instrument', 'payment_instrument');
 303   $params['contact_id'] = $params['contribution_contact_id'];
 304   $params['contact_id']['api.aliases'] = array('contribution_contact_id');
 305   unset($params['contribution_contact_id']);
 306 }
 307
 308 /**
 309  * Legacy handling for contribution parameters.
 310  *
 311  * Take the input parameter list as specified in the data model and
 312  * convert it into the same format that we use in QF and BAO object.
 313  *
 314  * @param array $params
 315  *   property name/value  pairs to insert in new contact.
 316  * @param array $values
 317  *   The reformatted properties that we can use internally.
 318  *
 319  * @return array
 320  */
 321 function _civicrm_api3_contribute_format_params($params, &$values) {
 322   //legacy way of formatting from v2 api - v3 way is to define metadata & do it in the api layer
 323   _civicrm_api3_filter_fields_for_bao('Contribution', $params, $values);
 324   return array();
 325 }
 326
 327 /**
 328  * Adjust Metadata for Transact action.
 329  *
 330  * The metadata is used for setting defaults, documentation & validation.
 331  *
 332  * @param array $params
 333  *   Array of parameters determined by getfields.
 334  */
 335 function _civicrm_api3_contribution_transact_spec(&$params) {
 336   $fields = civicrm_api3('Contribution', 'getfields', array('action' => 'create'));
 337   $params = array_merge($params, $fields['values']);
 338   $params['receive_date']['api.default'] = 'now';
 339 }
 340
 341 /**
 342  * Process a transaction and record it against the contact.
 343  *
 344  * @param array $params
 345  *   Input parameters.
 346  *
 347  * @return array
 348  *   contribution of created or updated record (or a civicrm error)
 349  */
 350 function civicrm_api3_contribution_transact($params) {
 351   // Set some params specific to payment processing
 352   // @todo - fix this function - none of the results checked by civicrm_error would ever be an array with
 353   // 'is_error' set
 354   // also trxn_id is not saved.
 355   // but since there is no test it's not desirable to jump in & make the obvious changes.
 356   $params['payment_processor_mode'] = empty($params['is_test']) ? 'live' : 'test';
 357   $params['amount'] = $params['total_amount'];
 358   if (!isset($params['net_amount'])) {
 359     $params['net_amount'] = $params['amount'];
 360   }
 361   if (!isset($params['invoiceID']) && isset($params['invoice_id'])) {
 362     $params['invoiceID'] = $params['invoice_id'];
 363   }
 364
 365   // Some payment processors expect a unique invoice_id - generate one if not supplied
 366   $params['invoice_id'] = CRM_Utils_Array::value('invoice_id', $params, md5(uniqid(rand(), TRUE)));
 367
 368   $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($params['payment_processor'], $params['payment_processor_mode']);
 369   $paymentProcessor['object']->doPayment($params);
 370
 371   $params['payment_instrument_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType', $paymentProcessor['payment_processor_type_id'], 'payment_type') == 1 ? 'Credit Card' : 'Debit Card';
 372   return civicrm_api('Contribution', 'create', $params);
 373 }
 374
 375 /**
 376  * Send a contribution confirmation (receipt or invoice).
 377  *
 378  * The appropriate online template will be used (the existence of related objects
 379  * (e.g. memberships ) will affect this selection
 380  *
 381  * @param array $params
 382  *   Input parameters.
 383  *
 384  * @throws Exception
 385  */
 386 function civicrm_api3_contribution_sendconfirmation($params) {
 387   $contribution = new CRM_Contribute_BAO_Contribution();
 388   $contribution->id = $params['id'];
 389   if (!$contribution->find(TRUE)) {
 390     throw new Exception('Contribution does not exist');
 391   }
 392   $input = $ids = $cvalues = array('receipt_from_email' => $params['receipt_from_email']);
 393   $contribution->loadRelatedObjects($input, $ids, TRUE);
 394   $contribution->composeMessageArray($input, $ids, $cvalues, FALSE, FALSE);
 395 }
 396
 397 /**
 398  * Adjust Metadata for sendconfirmation action.
 399  *
 400  * The metadata is used for setting defaults, documentation & validation.
 401  *
 402  * @param array $params
 403  *   Array of parameters determined by getfields.
 404  */
 405 function _civicrm_api3_contribution_sendconfirmation_spec(&$params) {
 406   $params['id'] = array(
 407     'api.required' => 1,
 408     'title' => 'Contribution ID',
 409     'type' => CRM_Utils_Type::T_INT,
 410   );
 411   $params['receipt_from_email'] = array(
 412     'api.required' => 1,
 413     'title' => 'From Email address (string) required until someone provides a patch :-)',
 414     'type' => CRM_Utils_Type::T_STRING,
 415   );
 416   $params['receipt_from_name'] = array(
 417     'title' => 'From Name (string)',
 418     'type' => CRM_Utils_Type::T_STRING,
 419   );
 420   $params['cc_receipt'] = array(
 421     'title' => 'CC Email address (string)',
 422     'type' => CRM_Utils_Type::T_STRING,
 423   );
 424   $params['bcc_receipt'] = array(
 425     'title' => 'BCC Email address (string)',
 426     'type' => CRM_Utils_Type::T_STRING,
 427   );
 428   $params['receipt_text'] = array(
 429     'title' => 'Message (string)',
 430     'type' => CRM_Utils_Type::T_STRING,
 431   );
 432 }
 433
 434 /**
 435  * Complete an existing (pending) transaction.
 436  *
 437  * This will update related entities (participant, membership, pledge etc)
 438  * and take any complete actions from the contribution page (e.g. send receipt).
 439  *
 440  * @todo - most of this should live in the BAO layer but as we want it to be an addition
 441  * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
 442  *
 443  * @param array $params
 444  *   Input parameters.
 445  *
 446  * @throws API_Exception
 447  *   Api result array.
 448  */
 449 function civicrm_api3_contribution_completetransaction(&$params) {
 450
 451   $input = $ids = array();
 452   if (isset($params['payment_processor_id'])) {
 453     $input['payment_processor_id'] = $params['payment_processor_id'];
 454   }
 455   $contribution = new CRM_Contribute_BAO_Contribution();
 456   $contribution->id = $params['id'];
 457   $contribution->find(TRUE);
 458   if (!$contribution->id == $params['id']) {
 459     throw new API_Exception('A valid contribution ID is required', 'invalid_data');
 460   }
 461
 462   if (!$contribution->loadRelatedObjects($input, $ids, TRUE)) {
 463     throw new API_Exception('failed to load related objects');
 464   }
 465   elseif ($contribution->contribution_status_id == CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name')) {
 466     throw new API_Exception(ts('Contribution already completed'), 'contribution_completed');
 467   }
 468   $input['trxn_id'] = !empty($params['trxn_id']) ? $params['trxn_id'] : $contribution->trxn_id;
 469   if (!empty($params['fee_amount'])) {
 470     $input['fee_amount'] = $params['fee_amount'];
 471   }
 472   $params = _ipn_process_transaction($params, $contribution, $input, $ids);
 473
 474 }
 475
 476 /**
 477  * Provide function metadata.
 478  *
 479  * @param array $params
 480  */
 481 function _civicrm_api3_contribution_completetransaction_spec(&$params) {
 482   $params['id'] = array(
 483     'title' => 'Contribution ID',
 484     'type' => CRM_Utils_Type::T_INT,
 485     'api.required' => TRUE,
 486   );
 487   $params['trxn_id'] = array(
 488     'title' => 'Transaction ID',
 489     'type' => CRM_Utils_Type::T_STRING,
 490   );
 491   $params['is_email_receipt'] = array(
 492     'title' => 'Send email Receipt?',
 493     'type' => CRM_Utils_Type::T_BOOLEAN,
 494   );
 495   $params['receipt_from_email'] = array(
 496     'title' => 'Email to send receipt from.',
 497     'description' => 'If not provided this will default to being based on domain mail or contribution page',
 498     'type' => CRM_Utils_Type::T_EMAIL,
 499   );
 500   $params['receipt_from_name'] = array(
 501     'title' => 'Name to send receipt from',
 502     'description' => '. If not provided this will default to domain mail or contribution page',
 503     'type' => CRM_Utils_Type::T_STRING,
 504   );
 505   $params['payment_processor_id'] = array(
 506     'title' => 'Payment processor ID',
 507     'description' => 'Providing this is strongly recommended, as not possible to calculate it accurately always',
 508     'type' => CRM_Utils_Type::T_INT,
 509   );
 510   $params['fee_amount'] = array(
 511     'title' => 'Fee charged on transaction',
 512     'description' => 'If a fee has been charged then the amount',
 513     'type' => CRM_Utils_Type::T_FLOAT,
 514   );
 515   $params['trxn_date'] = array(
 516     'title' => 'Transaction Date',
 517     'description' => 'Date this transaction occurred',
 518     'type' => CRM_Utils_Type::T_DATE,
 519   );
 520 }
 521
 522 /**
 523  * Complete an existing (pending) transaction.
 524  *
 525  * This will update related entities (participant, membership, pledge etc)
 526  * and take any complete actions from the contribution page (e.g. send receipt).
 527  *
 528  * @todo - most of this should live in the BAO layer but as we want it to be an addition
 529  * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
 530  *
 531  * @param array $params
 532  *   Input parameters.
 533  *
 534  * @throws API_Exception
 535  *   Api result array.
 536  */
 537 function civicrm_api3_contribution_repeattransaction(&$params) {
 538   $input = $ids = array();
 539   $contribution = new CRM_Contribute_BAO_Contribution();
 540   $contribution->id = $params['original_contribution_id'];
 541   if (!$contribution->find(TRUE)) {
 542     throw new API_Exception(
 543       'A valid original contribution ID is required', 'invalid_data');
 544   }
 545   $original_contribution = clone $contribution;
 546   try {
 547     if (!$contribution->loadRelatedObjects($input, $ids, TRUE)) {
 548       throw new API_Exception('failed to load related objects');
 549     }
 550
 551     unset($contribution->id, $contribution->receive_date, $contribution->invoice_id);
 552     $contribution->contribution_status_id = $params['contribution_status_id'];
 553     $contribution->receive_date = $params['receive_date'];
 554
 555     $passThroughParams = array('trxn_id', 'total_amount', 'campaign_id', 'fee_amount');
 556     $input = array_intersect_key($params, array_fill_keys($passThroughParams, NULL));
 557
 558     $params = _ipn_process_transaction($params, $contribution, $input, $ids, $original_contribution);
 559   }
 560   catch(Exception $e) {
 561     throw new API_Exception('failed to load related objects' . $e->getMessage() . "\n" . $e->getTraceAsString());
 562   }
 563 }
 564
 565 /**
 566  * Calls IPN complete transaction for completing or repeating a transaction.
 567  *
 568  * The IPN function is overloaded with two purposes - this is simply a wrapper for that
 569  * when separating them in the api layer.
 570  *
 571  * @param array $params
 572  * @param CRM_Contribute_BAO_Contribution $contribution
 573  * @param array $input
 574  *
 575  * @param array $ids
 576  *
 577  * @param CRM_Contribute_BAO_Contribution $firstContribution
 578  *
 579  * @return mixed
 580  */
 581 function _ipn_process_transaction(&$params, $contribution, $input, $ids, $firstContribution = NULL) {
 582   $objects = $contribution->_relatedObjects;
 583   $objects['contribution'] = &$contribution;
 584
 585   if ($firstContribution) {
 586     $objects['first_contribution'] = $firstContribution;
 587   }
 588   $input['component'] = $contribution->_component;
 589   $input['is_test'] = $contribution->is_test;
 590   $input['amount'] = empty($input['total_amount']) ? $contribution->total_amount : $input['total_amount'];
 591
 592   if (isset($params['is_email_receipt'])) {
 593     $input['is_email_receipt'] = $params['is_email_receipt'];
 594   }
 595   if (!empty($params['trxn_date'])) {
 596     $input['trxn_date'] = $params['trxn_date'];
 597   }
 598   if (empty($contribution->contribution_page_id)) {
 599     static $domainFromName;
 600     static $domainFromEmail;
 601     if (empty($domainFromEmail) && (empty($params['receipt_from_name']) || empty($params['receipt_from_email']))) {
 602       list($domainFromName, $domainFromEmail) = CRM_Core_BAO_Domain::getNameAndEmail(TRUE);
 603     }
 604     $input['receipt_from_name'] = CRM_Utils_Array::value('receipt_from_name', $params, $domainFromName);
 605     $input['receipt_from_email'] = CRM_Utils_Array::value('receipt_from_email', $params, $domainFromEmail);
 606   }
 607   $transaction = new CRM_Core_Transaction();
 608   CRM_Contribute_BAO_Contribution::completeOrder($input, $ids, $objects, $transaction, !empty($contribution->contribution_recur_id), $contribution,
 609     FALSE, FALSE);
 610   return $params;
 611 }
 612
 613 /**
 614  * Provide function metadata.
 615  *
 616  * @param array $params
 617  */
 618 function _civicrm_api3_contribution_repeattransaction_spec(&$params) {
 619   $params['original_contribution_id'] = array(
 620     'title' => 'Original Contribution ID',
 621     'type' => CRM_Utils_Type::T_INT,
 622     'api.required' => TRUE,
 623   );
 624   $params['trxn_id'] = array(
 625     'title' => 'Transaction ID',
 626     'type' => CRM_Utils_Type::T_STRING,
 627   );
 628   $params['is_email_receipt'] = array(
 629     'title' => 'Send email Receipt?',
 630     'type' => CRM_Utils_Type::T_BOOLEAN,
 631   );
 632   $params['contribution_status_id'] = array(
 633     'title' => 'Contribution Status ID',
 634     'name' => 'contribution_status_id',
 635     'type' => CRM_Utils_Type::T_INT,
 636     'pseudoconstant' => array(
 637       'optionGroupName' => 'contribution_status',
 638     ),
 639     'api.required' => TRUE,
 640   );
 641   $params['receive_date'] = array(
 642     'title' => 'Contribution Receive Date',
 643     'name' => 'receive_date',
 644     'type' => CRM_Utils_Type::T_DATE,
 645     'api.default' => 'now',
 646   );
 647   $params['trxn_id'] = array(
 648     'title' => 'Transaction ID',
 649     'name' => 'trxn_id',
 650     'type' => CRM_Utils_Type::T_STRING,
 651   );
 652   $params['payment_processor_id'] = array(
 653     'description' => ts('Payment processor ID, will be loaded from contribution_recur if not provided'),
 654     'title' => 'Payment processor ID',
 655     'name' => 'payment_processor_id',
 656     'type' => CRM_Utils_Type::T_INT,
 657   );
 658 }