Merge pull request #3679 from yashodha/CRM-14951
[civicrm-core.git] / api / v3 / FinancialType.php
CommitLineData
134bc82c
CW
1<?php
2
3/*
4 +--------------------------------------------------------------------+
731a0992 5 | CiviCRM version 4.5 |
134bc82c 6 +--------------------------------------------------------------------+
731a0992 7 | Copyright CiviCRM LLC (c) 2004-2014 |
134bc82c
CW
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
10 | |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
19 | |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
27*/
28
29/**
30 * File for the CiviCRM APIv3 financial_type functions
31 *
32 * @package CiviCRM_APIv3
33 * @subpackage API_financial_type
34 *
35 */
36
37/**
38 * Save a financial_type
39 *
40 * Allowed @params array keys are:
41 * {@getfields financial_type_create}
42 * @example financial_typeCreate.php
43 *
77b97be7
EM
44 * @param $params
45 *
134bc82c
CW
46 * @return array of newly created financial_type property values.
47 * @access public
48 */
49function civicrm_api3_financial_type_create($params) {
50 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
51}
52
53/**
54 * Get a financial_type
55 *
56 * Allowed @params array keys are:
57 * {@getfields financial_type_get}
58 * @example financial_typeCreate.php
59 *
77b97be7
EM
60 * @param $params
61 *
134bc82c
CW
62 * @return array of retrieved financial_type property values.
63 * @access public
64 */
65function civicrm_api3_financial_type_get($params) {
66 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
67}
68
69/**
70 * Delete a financial_type
71 *
72 * Allowed @params array keys are:
73 * {@getfields financial_type_delete}
74 * @example financial_typeCreate.php
75 *
77b97be7
EM
76 * @param $params
77 *
134bc82c
CW
78 * @return array of deleted values.
79 * @access public
80 */
81function civicrm_api3_financial_type_delete($params) {
82 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
83}