Api docblock cleanup.
[civicrm-core.git] / api / v3 / FinancialAccount.php
CommitLineData
134bc82c 1<?php
134bc82c
CW
2/*
3 +--------------------------------------------------------------------+
39de6fd5 4 | CiviCRM version 4.6 |
134bc82c 5 +--------------------------------------------------------------------+
731a0992 6 | Copyright CiviCRM LLC (c) 2004-2014 |
134bc82c
CW
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 +--------------------------------------------------------------------+
d25dd0ee 26 */
134bc82c
CW
27
28/**
c28e1768 29 * This api exposes CiviCRM financial_account.
134bc82c
CW
30 *
31 * @package CiviCRM_APIv3
134bc82c
CW
32 */
33
34/**
9d32e6f7 35 * Save a financial_account.
134bc82c 36 *
c490a46a 37 * @param array $params
77b97be7 38 *
a6c01b45 39 * @return array
16b10e64 40 * Array of newly created financial_account property values.
134bc82c
CW
41 */
42function civicrm_api3_financial_account_create($params) {
43 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
44}
45
46/**
9d32e6f7 47 * Get a financial_account.
134bc82c 48 *
c490a46a 49 * @param array $params
77b97be7 50 *
a6c01b45 51 * @return array
16b10e64 52 * Array of retrieved financial_account property values.
134bc82c
CW
53 */
54function civicrm_api3_financial_account_get($params) {
55 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
56}
57
58/**
9d32e6f7 59 * Delete a financial_account.
134bc82c 60 *
c490a46a 61 * @param array $params
77b97be7 62 *
a6c01b45 63 * @return array
16b10e64 64 * Array of deleted values.
134bc82c
CW
65 */
66function civicrm_api3_financial_account_delete($params) {
67 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
68}