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 FinancialItem.
31 * @package CiviCRM_APIv3
35 * Save a Financial Item.
37 * @param array $params
41 function civicrm_api3_financial_trxn_create($params) {
42 if (empty($params['id']) && empty($params['contribution_id']) && empty($params['entity_id'])) {
43 throw new API_Exception("Mandatory key(s) missing from params array: both contribution_id and entity_id are missing");
46 return _civicrm_api3_basic_create('CRM_Core_BAO_FinancialTrxn', $params, 'FinancialTrxn');
50 * Get a Financialtrxn.
52 * @param array $params
55 * Array of retrieved Financial trxn property values.
57 function civicrm_api3_financial_trxn_get($params) {
58 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
62 * Delete a Financial trxn.
64 * @param array $params
67 * Array of deleted values.
69 function civicrm_api3_financial_trxn_delete($params) {
70 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
74 * Adjust Metadata for Create action.
76 * The metadata is used for setting defaults, documentation & validation.
78 * @param array $params
79 * Array of parameters determined by getfields.
81 function _civicrm_api3_financial_trxn_create_spec(&$params) {
82 $params['to_financial_account_id']['api.required'] = 1;
83 $params['status_id']['api.required'] = 1;
84 $params['payment_instrument_id']['api.required'] = 1;
85 $params['total_amount']['api.required'] = 1;