LineItem.php
This api exposes CiviCRM LineItem records.
Line items are sub-components of a complete financial transaction record.
Table of Contents
Functions
- civicrm_api3_line_item_create() : array<string|int, mixed>
- Create or update a line_item.
- _civicrm_api3_line_item_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_line_item_get() : array<string|int, mixed>
- Returns array of line_items matching a set of one or more group properties.
- civicrm_api3_line_item_delete() : array<string|int, mixed>
- Delete an existing LineItem.
Functions
civicrm_api3_line_item_create()
Create or update a line_item.
civicrm_api3_line_item_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of property name/value pairs to insert in new 'line_item'
Tags
Return values
array<string|int, mixed> —api result array
_civicrm_api3_line_item_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_line_item_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_line_item_get()
Returns array of line_items matching a set of one or more group properties.
civicrm_api3_line_item_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of one or more valid property_name=>value pairs. If $params is set. as null, all line_items will be returned (default limit is 25)
Return values
array<string|int, mixed> —Array of matching line_items
civicrm_api3_line_item_delete()
Delete an existing LineItem.
civicrm_api3_line_item_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This method is used to delete any existing LineItem given its id.
Parameters
- $params : array<string|int, mixed>
-
Array containing id of the group to be deleted.
Tags
Return values
array<string|int, mixed> —API result array