...
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.
Results
Toggle cloak |
---|
Cloak |
---|
...
Cloak | |||||
---|---|---|---|---|---|
If the request is successful, the RECID of the GLA will be returned as follows:
In the above example, '58337' represents the returned RECID. |
...
...
GLA Charges
GLA Endpoint
No Format |
---|
http://DOMAIN/api/API_KEY/gla.OUTPUT |
...
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 | ||
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 | ||
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. | ||
stop_date | no | String | The Date the Recurring 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 |
...
Cloak | |||||
---|---|---|---|---|---|
If the request is successful, the RECID of the GLA Charge will be returned as follows:
In the above example, '2342' represents the returned RECID. |
...
Locating GLA Data
Within PCR-360, these menu options list a variety of Grids that can be used to help locate any of the required fields.
...