...
In an effort to make the PCR-360 API more flexible, PCR has made the decision to no longer create individual endpoints for all the different data types. Instead, PCR is encouraging Users to use the SQL endpoint with a structured SELECT statement to retrieve exactly the data you want. Please see the SQL endpoint documentation for more information.
...
GLAs can be easily added (INSERT) or updated (UPDATE) through the API. Each installation of PCR-360 can have a different number of GLA Components so this documentation generalizes the information, but knowledge of the specific system's requirements is necessary.
...
*Postscript note: The value ‘gla_item_n’ represents any additional GLA Components a specific installation may have where 'n' is a sequential number starting at 2 and incrementing by 1 for each additional GLA Component. The necessity to provide each additional Component also depends on your installation of PCR-360. If Users have any questions about how many GLA Components their system has and if the Components are Required, please contact your System Administrator.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
type | Yes | String | CHARGES | This is REQUIRED Required when interacting with GLA Charges | |
recid | ConditionallyNo* | Integer | *Conditionally Required if attempting to UPDATE a GLA Charge. RECID column from GLA_CHARGES table. | ||
gla | Yes | Integer | RECID of the GLA for this Charge. | ||
charge_catalog_recid | Yes | Integer | Charge Catalog RECID for this Charge. | ||
prorate | No | Integer | 1 or 0 | 0 | 1 = Prorate, 0 = Do not Prorate. Only allowed if BILL_MRC_CHANGE_FORCE_PRORATE config option is false. |
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. Only allowed if Charge Catalog allows it. | ||
start_date | No | String | MRC ARC | 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 | MRC ARC | YYYY-MM-DD format. Other formats may give unexpected results. Used for Monthly Recurring Charges and Alternate Recurring Charges. | |
recurring_date | No | String | ARC | YYYY-MM-DD format. Other formats may give unexpected results. Used for Alternate Recurring Charges. | |
transaction_date | No | String | NRC | 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 | Yes | String | 'Contact' or 'Department' | Type of Owner of the Charge. | |
owner | Yes | Integer | Contact, Department Hierarchy | RECID of the Owner. | |
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. |
...