Merge pull request #6450 from civicrm/4.6
[civicrm-core.git] / api / v3 / EntityFinancialTrxn.php
CommitLineData
b193994e
PN
1<?php
2/*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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 FinancialType.
30 *
31 * @package CiviCRM_APIv3
32 */
33
34/**
35 * Save a Entity Financial Trxn.
36 *
37 * @param array $params
38 *
39 * @return array
40 */
41function civicrm_api3_entity_financial_trxn_create($params) {
42 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
43}
44
45/**
46 * Get a Entity Financial Trxn.
47 *
48 * @param array $params
49 *
50 * @return array
51 * Array of retrieved Entity Financial Trxn property values.
52 */
53function civicrm_api3_entity_financial_trxn_get($params) {
54 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
55}
56
57/**
58 * Delete a Entity Financial Trxn.
59 *
60 * @param array $params
61 *
62 * @return array
63 * Array of deleted values.
64 */
65function civicrm_api3_entity_financial_trxn_delete($params) {
66 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
67}
68
69/**
70 * Adjust Metadata for Create action.
71 *
72 * The metadata is used for setting defaults, documentation & validation.
73 *
74 * @param array $params
75 * Array of parameters determined by getfields.
76 */
77function _civicrm_api3_entity_financial_trxn_create_spec(&$params) {
78 $params['entity_table']['api.required'] = 1;
79 $params['entity_id']['api.required'] = 1;
80 $params['financial_trxn_id']['api.required'] = 1;
81 $params['amount']['api.required'] = 1;
429a0484 82}