3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM Contribution records.
31 * @package CiviCRM_APIv3
35 * Add or update a Contribution.
37 * @param array $params
40 * @throws API_Exception
44 function civicrm_api3_contribution_create(&$params) {
46 _civicrm_api3_custom_format_params($params, $values, 'Contribution');
47 $params = array_merge($params, $values);
48 // The BAO should not clean money - it should be done in the form layer & api wrapper
49 // (although arguably the api should expect pre-cleaned it seems to do some cleaning.)
50 if (empty($params['skipCleanMoney'])) {
51 foreach (['total_amount', 'net_amount', 'fee_amount'] as $field) {
52 if (isset($params[$field])) {
53 $params[$field] = CRM_Utils_Rule
::cleanMoney($params[$field]);
57 $params['skipCleanMoney'] = TRUE;
59 if (!empty($params['check_permissions']) && CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
60 if (empty($params['id'])) {
61 $op = CRM_Core_Action
::ADD
;
64 if (empty($params['financial_type_id'])) {
65 $params['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $params['id'], 'financial_type_id');
67 $op = CRM_Core_Action
::UPDATE
;
69 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($types, $op);
70 if (!in_array($params['financial_type_id'], array_keys($types))) {
71 throw new API_Exception('You do not have permission to create this contribution');
74 if (!empty($params['id']) && !empty($params['contribution_status_id'])) {
76 //throw error for invalid status change such as setting completed back to pending
77 //@todo this sort of validation belongs in the BAO not the API - if it is not an OK
78 // action it needs to be blocked there. If it is Ok through a form it needs to be OK through the api
79 CRM_Contribute_BAO_Contribution
::checkStatusValidation(NULL, $params, $error);
80 if (array_key_exists('contribution_status_id', $error)) {
81 throw new API_Exception($error['contribution_status_id']);
84 if (!empty($params['id']) && !empty($params['financial_type_id'])) {
86 CRM_Contribute_BAO_Contribution
::checkFinancialTypeChange($params['financial_type_id'], $params['id'], $error);
87 if (array_key_exists('financial_type_id', $error)) {
88 throw new API_Exception($error['financial_type_id']);
91 _civicrm_api3_contribution_create_legacy_support_45($params);
93 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Contribution');
97 * Adjust Metadata for Create action.
99 * The metadata is used for setting defaults, documentation & validation.
101 * @param array $params
102 * Array of parameters determined by getfields.
104 function _civicrm_api3_contribution_create_spec(&$params) {
105 $params['contact_id']['api.required'] = 1;
106 $params['total_amount']['api.required'] = 1;
107 $params['payment_instrument_id']['api.aliases'] = array('payment_instrument');
108 $params['receive_date']['api.default'] = 'now';
109 $params['receive_date']['api.required'] = TRUE;
110 $params['payment_processor'] = array(
111 'name' => 'payment_processor',
112 'title' => 'Payment Processor ID',
113 'description' => 'ID of payment processor used for this contribution',
114 // field is called payment processor - not payment processor id but can only be one id so
115 // it seems likely someone will fix it up one day to be more consistent - lets alias it from the start
116 'api.aliases' => array('payment_processor_id'),
117 'type' => CRM_Utils_Type
::T_INT
,
119 $params['financial_type_id']['api.aliases'] = array('contribution_type_id', 'contribution_type');
120 $params['financial_type_id']['api.required'] = 1;
121 $params['note'] = array(
123 'uniqueName' => 'contribution_note',
126 'description' => 'Associated Note in the notes table',
128 $params['soft_credit_to'] = array(
129 'name' => 'soft_credit_to',
130 'title' => 'Soft Credit contact ID (legacy)',
131 'type' => CRM_Utils_Type
::T_INT
,
132 'description' => 'ID of Contact to be Soft credited to (deprecated - use contribution_soft api)',
133 'FKClassName' => 'CRM_Contact_DAO_Contact',
135 $params['honor_contact_id'] = array(
136 'name' => 'honor_contact_id',
137 'title' => 'Honoree contact ID (legacy)',
138 'type' => CRM_Utils_Type
::T_INT
,
139 'description' => 'ID of honoree contact (deprecated - use contribution_soft api)',
140 'FKClassName' => 'CRM_Contact_DAO_Contact',
142 $params['honor_type_id'] = array(
143 'name' => 'honor_type_id',
144 'title' => 'Honoree Type (legacy)',
145 'type' => CRM_Utils_Type
::T_INT
,
146 'description' => 'Type of honoree contact (deprecated - use contribution_soft api)',
147 'pseudoconstant' => TRUE,
149 // note this is a recommended option but not adding as a default to avoid
150 // creating unnecessary changes for the dev
151 $params['skipRecentView'] = array(
152 'name' => 'skipRecentView',
153 'title' => 'Skip adding to recent view',
154 'type' => CRM_Utils_Type
::T_BOOLEAN
,
155 'description' => 'Do not add to recent view (setting this improves performance)',
157 $params['skipLineItem'] = array(
158 'name' => 'skipLineItem',
159 'title' => 'Skip adding line items',
160 'type' => CRM_Utils_Type
::T_BOOLEAN
,
162 'description' => 'Do not add line items by default (if you wish to add your own)',
164 $params['batch_id'] = array(
166 'type' => CRM_Utils_Type
::T_INT
,
167 'description' => 'Batch which relevant transactions should be added to',
169 $params['refund_trxn_id'] = array(
170 'title' => 'Refund Transaction ID',
171 'type' => CRM_Utils_Type
::T_STRING
,
172 'description' => 'Transaction ID specific to the refund taking place',
174 $params['card_type_id'] = array(
175 'title' => 'Card Type ID',
176 'description' => 'Providing Credit Card Type ID',
177 'type' => CRM_Utils_Type
::T_INT
,
178 'pseudoconstant' => array(
179 'optionGroupName' => 'accept_creditcard',
185 * Support for schema changes made in 4.5.
187 * The main purpose of the API is to provide integrators a level of stability not provided by
188 * the core code or schema - this means we have to provide support for api calls (where possible)
189 * across schema changes.
191 * @param array $params
193 function _civicrm_api3_contribution_create_legacy_support_45(&$params) {
194 //legacy soft credit handling - recommended approach is chaining
195 if (!empty($params['soft_credit_to'])) {
196 $params['soft_credit'][] = array(
197 'contact_id' => $params['soft_credit_to'],
198 'amount' => $params['total_amount'],
199 'soft_credit_type_id' => CRM_Core_OptionGroup
::getDefaultValue("soft_credit_type"),
202 if (!empty($params['honor_contact_id'])) {
203 $params['soft_credit'][] = array(
204 'contact_id' => $params['honor_contact_id'],
205 'amount' => $params['total_amount'],
206 'soft_credit_type_id' => CRM_Utils_Array
::value('honor_type_id', $params, CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', 'in_honor_of')),
212 * Delete a Contribution.
214 * @param array $params
218 * @throws \API_Exception
220 function civicrm_api3_contribution_delete($params) {
222 $contributionID = !empty($params['contribution_id']) ?
$params['contribution_id'] : $params['id'];
223 // First check contribution financial type
224 $financialType = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionID, 'financial_type_id');
225 // Now check permissioned lineitems & permissioned contribution
226 if (!empty($params['check_permissions']) && CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus() &&
228 !CRM_Core_Permission
::check('delete contributions of type ' . CRM_Contribute_PseudoConstant
::financialType($financialType))
229 ||
!CRM_Financial_BAO_FinancialType
::checkPermissionedLineItems($contributionID, 'delete', FALSE)
232 throw new API_Exception('You do not have permission to delete this contribution');
234 if (CRM_Contribute_BAO_Contribution
::deleteContribution($contributionID)) {
235 return civicrm_api3_create_success(array($contributionID => 1));
238 throw new API_Exception('Could not delete contribution');
243 * Modify metadata for delete action.
245 * Legacy support for contribution_id.
247 * @param array $params
249 function _civicrm_api3_contribution_delete_spec(&$params) {
250 $params['id']['api.aliases'] = array('contribution_id');
254 * Retrieve a set of contributions.
256 * @param array $params
260 * Array of contributions, if error an array with an error id and error message
262 function civicrm_api3_contribution_get($params) {
264 $mode = CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
;
265 $additionalOptions = _civicrm_api3_contribution_get_support_nonunique_returns($params);
266 $returnProperties = CRM_Contribute_BAO_Query
::defaultReturnProperties($mode);
268 $contributions = _civicrm_api3_get_using_query_object('Contribution', $params, $additionalOptions, NULL, $mode, $returnProperties);
270 foreach ($contributions as $id => $contribution) {
271 $softContribution = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($id, TRUE);
272 $contributions[$id] = array_merge($contribution, $softContribution);
273 // format soft credit for backward compatibility
274 _civicrm_api3_format_soft_credit($contributions[$id]);
275 _civicrm_api3_contribution_add_supported_fields($contributions[$id]);
278 return civicrm_api3_create_success($contributions, $params, 'Contribution', 'get');
282 * Fix the return values to reflect cases where the schema has been changed.
284 * At the query object level using uniquenames dismbiguates between tables.
286 * However, adding uniquename can change inputs accepted by the api, so we need
287 * to ensure we are asking for the unique name return fields.
289 * @param array $params
292 * @throws \API_Exception
294 function _civicrm_api3_contribution_get_support_nonunique_returns($params) {
295 $additionalOptions = array();
296 $options = _civicrm_api3_get_options_from_params($params, TRUE);
297 foreach (array('check_number', 'address_id') as $changedVariable) {
298 if (isset($options['return']) && !empty($options['return'][$changedVariable])) {
299 $additionalOptions['return']['contribution_' . $changedVariable] = 1;
302 return $additionalOptions;
306 * Support for supported output variables.
308 * @param $contribution
310 function _civicrm_api3_contribution_add_supported_fields(&$contribution) {
311 // These are output fields that are supported in our test contract.
312 // Arguably we should also do the same with 'campaign_id' &
313 // 'source' - which are also fields being rendered with unique names.
314 // That seems more consistent with other api where we output the actual field names.
315 $outputAliases = array(
316 'contribution_check_number' => 'check_number',
317 'contribution_address_id' => 'address_id',
318 'payment_instrument_id' => 'instrument_id',
320 foreach ($outputAliases as $returnName => $copyTo) {
321 if (array_key_exists($returnName, $contribution)) {
322 $contribution[$copyTo] = $contribution[$returnName];
329 * Get number of contacts matching the supplied criteria.
331 * @param array $params
335 function civicrm_api3_contribution_getcount($params) {
336 $count = _civicrm_api3_get_using_query_object('Contribution', $params, array(), TRUE, CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
);
341 * This function is used to format the soft credit for backward compatibility.
343 * As of v4.4 we support multiple soft credit, so now contribution returns array with 'soft_credit' as key
344 * but we still return first soft credit as a part of contribution array
346 * @param $contribution
348 function _civicrm_api3_format_soft_credit(&$contribution) {
349 if (!empty($contribution['soft_credit'])) {
350 $contribution['soft_credit_to'] = $contribution['soft_credit'][1]['contact_id'];
351 $contribution['soft_credit_id'] = $contribution['soft_credit'][1]['soft_credit_id'];
356 * Adjust Metadata for Get action.
358 * The metadata is used for setting defaults, documentation & validation.
360 * @param array $params
361 * Array of parameters determined by getfields.
363 function _civicrm_api3_contribution_get_spec(&$params) {
364 $params['contribution_test'] = array(
366 'type' => CRM_Utils_Type
::T_BOOLEAN
,
367 'title' => 'Get Test Contributions?',
368 'api.aliases' => array('is_test'),
371 $params['financial_type_id']['api.aliases'] = array('contribution_type_id');
372 $params['payment_instrument_id']['api.aliases'] = array('contribution_payment_instrument', 'payment_instrument');
373 $params['contact_id'] = CRM_Utils_Array
::value('contribution_contact_id', $params);
374 $params['contact_id']['api.aliases'] = array('contribution_contact_id');
375 unset($params['contribution_contact_id']);
379 * Legacy handling for contribution parameters.
381 * Take the input parameter list as specified in the data model and
382 * convert it into the same format that we use in QF and BAO object.
384 * @param array $params
385 * property name/value pairs to insert in new contact.
386 * @param array $values
387 * The reformatted properties that we can use internally.
391 function _civicrm_api3_contribute_format_params($params, &$values) {
392 //legacy way of formatting from v2 api - v3 way is to define metadata & do it in the api layer
393 _civicrm_api3_filter_fields_for_bao('Contribution', $params, $values);
398 * Adjust Metadata for Transact action.
400 * The metadata is used for setting defaults, documentation & validation.
402 * @param array $params
403 * Array of parameters determined by getfields.
405 function _civicrm_api3_contribution_transact_spec(&$params) {
406 $fields = civicrm_api3('Contribution', 'getfields', array('action' => 'create'));
407 $params = array_merge($params, $fields['values']);
408 $params['receive_date']['api.default'] = 'now';
412 * Process a transaction and record it against the contact.
414 * @param array $params
418 * contribution of created or updated record (or a civicrm error)
420 function civicrm_api3_contribution_transact($params) {
421 // Set some params specific to payment processing
422 // @todo - fix this function - none of the results checked by civicrm_error would ever be an array with
424 // also trxn_id is not saved.
425 // but since there is no test it's not desirable to jump in & make the obvious changes.
426 $params['payment_processor_mode'] = empty($params['is_test']) ?
'live' : 'test';
427 $params['amount'] = $params['total_amount'];
428 if (!isset($params['net_amount'])) {
429 $params['net_amount'] = $params['amount'];
431 if (!isset($params['invoiceID']) && isset($params['invoice_id'])) {
432 $params['invoiceID'] = $params['invoice_id'];
435 // Some payment processors expect a unique invoice_id - generate one if not supplied
436 $params['invoice_id'] = CRM_Utils_Array
::value('invoice_id', $params, md5(uniqid(rand(), TRUE)));
438 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::getPayment($params['payment_processor'], $params['payment_processor_mode']);
439 $paymentProcessor['object']->doPayment($params);
441 $params['payment_instrument_id'] = $paymentProcessor['object']->getPaymentInstrumentID();
443 return civicrm_api('Contribution', 'create', $params);
447 * Send a contribution confirmation (receipt or invoice).
449 * The appropriate online template will be used (the existence of related objects
450 * (e.g. memberships ) will affect this selection
452 * @param array $params
457 function civicrm_api3_contribution_sendconfirmation($params) {
458 $ids = $values = array();
459 $allowedParams = array(
460 'receipt_from_email',
466 'payment_processor_id',
468 $input = array_intersect_key($params, array_flip($allowedParams));
469 $input['is_email_receipt'] = TRUE;
470 CRM_Contribute_BAO_Contribution
::sendMail($input, $ids, $params['id'], $values);
474 * Adjust Metadata for sendconfirmation action.
476 * The metadata is used for setting defaults, documentation & validation.
478 * @param array $params
479 * Array of parameters determined by getfields.
481 function _civicrm_api3_contribution_sendconfirmation_spec(&$params) {
482 $params['id'] = array(
484 'title' => ts('Contribution ID'),
485 'type' => CRM_Utils_Type
::T_INT
,
487 $params['receipt_from_email'] = array(
488 'title' => ts('From Email address (string)'),
489 'type' => CRM_Utils_Type
::T_STRING
,
491 $params['receipt_from_name'] = array(
492 'title' => ts('From Name (string)'),
493 'type' => CRM_Utils_Type
::T_STRING
,
495 $params['cc_receipt'] = array(
496 'title' => ts('CC Email address (string)'),
497 'type' => CRM_Utils_Type
::T_STRING
,
499 $params['bcc_receipt'] = array(
500 'title' => ts('BCC Email address (string)'),
501 'type' => CRM_Utils_Type
::T_STRING
,
503 $params['receipt_text'] = array(
504 'title' => ts('Message (string)'),
505 'type' => CRM_Utils_Type
::T_STRING
,
507 $params['receipt_update'] = array(
508 'title' => ts('Update the Receipt Date'),
509 'type' => CRM_Utils_Type
::T_BOOLEAN
,
510 'api.default' => TRUE,
512 $params['payment_processor_id'] = array(
513 'title' => ts('Payment processor Id (avoids mis-guesses)'),
514 'type' => CRM_Utils_Type
::T_INT
,
519 * Complete an existing (pending) transaction.
521 * This will update related entities (participant, membership, pledge etc)
522 * and take any complete actions from the contribution page (e.g. send receipt).
524 * @todo - most of this should live in the BAO layer but as we want it to be an addition
525 * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
527 * @param array $params
532 * @throws \API_Exception
533 * @throws \CRM_Core_Exception
536 function civicrm_api3_contribution_completetransaction(&$params) {
537 $input = $ids = array();
538 if (isset($params['payment_processor_id'])) {
539 $input['payment_processor_id'] = $params['payment_processor_id'];
541 $contribution = new CRM_Contribute_BAO_Contribution();
542 $contribution->id
= $params['id'];
543 if (!$contribution->find(TRUE)) {
544 throw new API_Exception('A valid contribution ID is required', 'invalid_data');
547 if (!$contribution->loadRelatedObjects($input, $ids, TRUE)) {
548 throw new API_Exception('failed to load related objects');
550 elseif ($contribution->contribution_status_id
== CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed')) {
551 throw new API_Exception(ts('Contribution already completed'), 'contribution_completed');
553 $input['trxn_id'] = !empty($params['trxn_id']) ?
$params['trxn_id'] : $contribution->trxn_id
;
554 if (!empty($params['fee_amount'])) {
555 $input['fee_amount'] = $params['fee_amount'];
557 return _ipn_process_transaction($params, $contribution, $input, $ids);
562 * Provide function metadata.
564 * @param array $params
566 function _civicrm_api3_contribution_completetransaction_spec(&$params) {
567 $params['id'] = array(
568 'title' => 'Contribution ID',
569 'type' => CRM_Utils_Type
::T_INT
,
570 'api.required' => TRUE,
572 $params['trxn_id'] = array(
573 'title' => 'Transaction ID',
574 'type' => CRM_Utils_Type
::T_STRING
,
576 $params['is_email_receipt'] = array(
577 'title' => 'Send email Receipt?',
578 'type' => CRM_Utils_Type
::T_BOOLEAN
,
580 $params['receipt_from_email'] = array(
581 'title' => 'Email to send receipt from.',
582 'description' => 'If not provided this will default to being based on domain mail or contribution page',
583 'type' => CRM_Utils_Type
::T_EMAIL
,
585 $params['receipt_from_name'] = array(
586 'title' => 'Name to send receipt from',
587 'description' => '. If not provided this will default to domain mail or contribution page',
588 'type' => CRM_Utils_Type
::T_STRING
,
590 $params['payment_processor_id'] = array(
591 'title' => 'Payment processor ID',
592 'description' => 'Providing this is strongly recommended, as not possible to calculate it accurately always',
593 'type' => CRM_Utils_Type
::T_INT
,
595 $params['fee_amount'] = array(
596 'title' => 'Fee charged on transaction',
597 'description' => 'If a fee has been charged then the amount',
598 'type' => CRM_Utils_Type
::T_FLOAT
,
600 $params['trxn_date'] = array(
601 'title' => 'Transaction Date',
602 'description' => 'Date this transaction occurred',
603 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
605 $params['card_type_id'] = array(
606 'title' => 'Card Type ID',
607 'description' => 'Providing Credit Card Type ID',
608 'type' => CRM_Utils_Type
::T_INT
,
609 'pseudoconstant' => array(
610 'optionGroupName' => 'accept_creditcard',
616 * Complete an existing (pending) transaction.
618 * This will update related entities (participant, membership, pledge etc)
619 * and take any complete actions from the contribution page (e.g. send receipt).
621 * @todo - most of this should live in the BAO layer but as we want it to be an addition
622 * to 4.3 which is already stable we should add it to the api layer & re-factor into the BAO layer later
624 * @param array $params
629 * @throws API_Exception
631 function civicrm_api3_contribution_repeattransaction(&$params) {
632 $input = $ids = array();
633 civicrm_api3_verify_one_mandatory($params, NULL, array('contribution_recur_id', 'original_contribution_id'));
634 if (empty($params['original_contribution_id'])) {
635 // CRM-19873 call with test mode.
636 $params['original_contribution_id'] = civicrm_api3('contribution', 'getvalue', array(
638 'contribution_status_id' => array('IN' => array('Completed')),
639 'contribution_recur_id' => $params['contribution_recur_id'],
640 'contribution_test' => CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionRecur', $params['contribution_recur_id'], 'is_test'),
641 'options' => array('limit' => 1, 'sort' => 'id DESC'),
644 $contribution = new CRM_Contribute_BAO_Contribution();
645 $contribution->id
= $params['original_contribution_id'];
646 if (!$contribution->find(TRUE)) {
647 throw new API_Exception(
648 'A valid original contribution ID is required', 'invalid_data');
650 $original_contribution = clone $contribution;
651 $input['payment_processor_id'] = civicrm_api3('contributionRecur', 'getvalue', array(
652 'return' => 'payment_processor_id',
653 'id' => $contribution->contribution_recur_id
,
656 if (!$contribution->loadRelatedObjects($input, $ids, TRUE)) {
657 throw new API_Exception('failed to load related objects');
660 unset($contribution->id
, $contribution->receive_date
, $contribution->invoice_id
);
661 $contribution->receive_date
= $params['receive_date'];
663 $passThroughParams = array(
669 'contribution_status_id',
671 $input = array_intersect_key($params, array_fill_keys($passThroughParams, NULL));
673 return _ipn_process_transaction($params, $contribution, $input, $ids, $original_contribution);
675 catch(Exception
$e) {
676 throw new API_Exception('failed to load related objects' . $e->getMessage() . "\n" . $e->getTraceAsString());
681 * Calls IPN complete transaction for completing or repeating a transaction.
683 * The IPN function is overloaded with two purposes - this is simply a wrapper for that
684 * when separating them in the api layer.
686 * @param array $params
687 * @param CRM_Contribute_BAO_Contribution $contribution
688 * @param array $input
692 * @param CRM_Contribute_BAO_Contribution $firstContribution
696 function _ipn_process_transaction(&$params, $contribution, $input, $ids, $firstContribution = NULL) {
697 $objects = $contribution->_relatedObjects
;
698 $objects['contribution'] = &$contribution;
700 if ($firstContribution) {
701 $objects['first_contribution'] = $firstContribution;
703 $input['component'] = $contribution->_component
;
704 $input['is_test'] = $contribution->is_test
;
705 $input['amount'] = empty($input['total_amount']) ?
$contribution->total_amount
: $input['total_amount'];
707 if (isset($params['is_email_receipt'])) {
708 $input['is_email_receipt'] = $params['is_email_receipt'];
710 if (!empty($params['trxn_date'])) {
711 $input['trxn_date'] = $params['trxn_date'];
713 if (!empty($params['receive_date'])) {
714 $input['receive_date'] = $params['receive_date'];
716 if (empty($contribution->contribution_page_id
)) {
717 static $domainFromName;
718 static $domainFromEmail;
719 if (empty($domainFromEmail) && (empty($params['receipt_from_name']) ||
empty($params['receipt_from_email']))) {
720 list($domainFromName, $domainFromEmail) = CRM_Core_BAO_Domain
::getNameAndEmail(TRUE);
722 $input['receipt_from_name'] = CRM_Utils_Array
::value('receipt_from_name', $params, $domainFromName);
723 $input['receipt_from_email'] = CRM_Utils_Array
::value('receipt_from_email', $params, $domainFromEmail);
725 $input['card_type_id'] = CRM_Utils_Array
::value('card_type_id', $params);
726 $input['pan_truncation'] = CRM_Utils_Array
::value('pan_truncation', $params);
727 $transaction = new CRM_Core_Transaction();
728 return CRM_Contribute_BAO_Contribution
::completeOrder($input, $ids, $objects, $transaction, !empty
729 ($contribution->contribution_recur_id
), $contribution);
733 * Provide function metadata.
735 * @param array $params
737 function _civicrm_api3_contribution_repeattransaction_spec(&$params) {
738 $params['original_contribution_id'] = array(
739 'title' => 'Original Contribution ID',
740 'description' => 'Contribution ID to copy (will be calculated from recurring contribution if not provided)',
741 'type' => CRM_Utils_Type
::T_INT
,
743 $params['contribution_recur_id'] = array(
744 'title' => 'Recurring contribution ID',
745 'type' => CRM_Utils_Type
::T_INT
,
747 $params['trxn_id'] = array(
748 'title' => 'Transaction ID',
749 'type' => CRM_Utils_Type
::T_STRING
,
751 $params['is_email_receipt'] = array(
752 'title' => 'Send email Receipt?',
753 'type' => CRM_Utils_Type
::T_BOOLEAN
,
755 $params['contribution_status_id'] = array(
756 'title' => 'Contribution Status ID',
757 'name' => 'contribution_status_id',
758 'type' => CRM_Utils_Type
::T_INT
,
759 'pseudoconstant' => array(
760 'optionGroupName' => 'contribution_status',
762 'api.required' => TRUE,
764 $params['receive_date'] = array(
765 'title' => 'Contribution Receive Date',
766 'name' => 'receive_date',
767 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
768 'api.default' => 'now',
770 $params['trxn_id'] = array(
771 'title' => 'Transaction ID',
773 'type' => CRM_Utils_Type
::T_STRING
,
775 $params['campaign_id'] = array(
776 'title' => 'Campaign ID',
777 'name' => 'campaign_id',
778 'type' => CRM_Utils_Type
::T_INT
,
779 'pseudoconstant' => array(
780 'table' => 'civicrm_campaign',
782 'labelColumn' => 'title',
785 $params['financial_type_id'] = array(
786 'title' => 'Financial ID (ignored if more than one line item)',
787 'name' => 'financial_type_id',
788 'type' => CRM_Utils_Type
::T_INT
,
789 'pseudoconstant' => array(
790 'table' => 'civicrm_financial_type',
792 'labelColumn' => 'name',
795 $params['payment_processor_id'] = array(
796 'description' => ts('Payment processor ID, will be loaded from contribution_recur if not provided'),
797 'title' => 'Payment processor ID',
798 'name' => 'payment_processor_id',
799 'type' => CRM_Utils_Type
::T_INT
,