...
Field | Required | Data Type | Options | Default | Notes |
|---|---|---|---|---|---|
type | Yes | String | CHARGES | This is REQUIRED when interacting with GLA Charges | |
recid | Conditionally* | Integer | *Required if attempting to UPDATE a GLA Charge. RECID column from GLA_CHARGES table. | ||
gla | Yes | Integer | RECID of the GLA for this Charge | ||
catalog | Yes | Integer | Charge Catalog RECID for this Charge | ||
prorate | Yes | Integer | 1 or 0 | 0 | 1 = Prorate, 0 = Do not Prorate |
description | No | String | Description of the Charge | ||
amount | No | Decimal | Will be used if Charge Catalog does not have a Default Amount set | ||
quantity | No | Integer | The quantity of Charge to be applied | ||
| start_date | yesno | String | The Start Date of a Charge. YYYY-MM-DD format. Other formats may give unexpected results. Used for Monthly Recurring Charges and Alternate Recurring Charges. | ||
| stop_date | no | String | YYYY-MM-DD format. Other formats may give unexpected results. Used for Monthly Recurring Charges and Alternate Recurring Charges | ||
| recurring_date | no | String | YYYY-MM-DD format. Other formats may give unexpected results. Used for Alternate Recurring Charges | ||
| transaction_date | no | String | YYYY-MM-DD format. Other formats may give unexpected results. Used for Non-Recurring Charges | ||
billing_group | No | Integer | RECID of the Billing Group, if applicable | ||
owner_type | No | String | 'Contact' or 'Department' | Type of Owner of the Charge | |
owner | Conditionally | Integer | Contact, Department Hierarchy | RECID of the Owner, *Required if the "owner_type" is provided. | |
override_amount | No | Decimal | Amount to override the default amount with, if applicable. | ||
| effective | no | String | today, backdate | today | Effective flag for the charge being added/stopped. if set to any value other than listed, "today" will be assumed by the API Alternate Recurring Charges (Quarterly, Semi-Annual and Annual), when updated will always use backdate as the Effective Date. |
...