4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.6 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * File for the CiviCRM APIv3 group functions
33 * @package CiviCRM_APIv3
34 * @subpackage API_LineItem
35 * @copyright CiviCRM LLC (c) 20042012
39 * Create or update a line_item
41 * @param array $params
42 * Associative array of property.
43 * name/value pairs to insert in new 'line_item'
44 * @example LineItemCreate.php Std Create example
46 * @return array api result array
47 * {@getfields line_item_create}
50 function civicrm_api3_line_item_create($params) {
51 $params = CRM_Contribute_BAO_Contribution
::checkTaxAmount($params,True);
52 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
56 * Adjust Metadata for Create action
58 * The metadata is used for setting defaults, documentation & validation
59 * @param array $params
60 * Array or parameters determined by getfields.
62 function _civicrm_api3_line_item_create_spec(&$params) {
63 $params['entity_id']['api.required'] = 1;
64 $params['qty']['api.required'] = 1;
65 $params['unit_price']['api.required'] = 1;
66 $params['line_total']['api.required'] = 1;
67 $params['label']['api.default'] = 'line item';
71 * Returns array of line_items matching a set of one or more group properties
73 * @param array $params
74 * Array of one or more valid property_name=>value pairs. If $params is set.
75 * as null, all line_items will be returned (default limit is 25)
77 * @return array Array of matching line_items
78 * {@getfields line_item_get}
81 function civicrm_api3_line_item_get($params) {
82 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
86 * delete an existing line_item
88 * This method is used to delete any existing line_item. id of the group
89 * to be deleted is required field in $params array
91 * @param array $params
92 * Array containing id of the group.
95 * @return array API result array
96 * {@getfields line_item_delete}
99 function civicrm_api3_line_item_delete($params) {
100 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);