...
Field | Required | Data Type | Options | Default | Notes |
|---|---|---|---|---|---|
equipment_recid | yes | Integer | The RECID of the Equipment that the charge is for | ||
charge_recid | yes | Integer | Record ID RECID of the applicable charge catalog. | ||
description | no | String | The details or description of the charge on the Equipment | ||
amount | no* | Float | The amount to be charged. *Required if charge does not have an amount on it. | ||
quantity | no | Integer | 1 | Quantity of charge to be used. | |
prorate | no | Integer | 1 or 0 | 0 | Should the charge be prorated when activated |
bill_date | no | String | Date the charge was billed | ||
override_amount | no | Float | If allowed by the selected charge, overrides the default amount from the charge. | ||
override_gla | no | Integer | Recid of GLA to override default GLA with. | ||
| stop_date | no | String | The Date the Recuring Charge should stop on. YYYY-MM-DD format. | ||
| 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 |
...