...
Parameter | Replace With |
---|---|
LISTTYPE | The type of List to be retrieved. Types can be found below. |
List Types
Type | Description | Extra Parameters* | Searchable | Results |
---|---|---|---|---|
CHARGE_CATALOG | Get available Charge Catalogs | Yes |
CONTACTS
Get available Contacts
CTYPE - Type of contact. Example: "worker"
Yes
DEPTHIER
Get available Departments
No
...
Charger Catalog Results
|
...
CONTACTS | Get available Contacts | CTYPE - Type of contact. Example: "worker" | Yes | Contacts Results
|
...
DEPTHIER | Get available Departments | No | Departmental Hierarchy Results
|
Writing GLAs
Available as of 2.1.4.5
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.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
recid | Conditionally* | Integer | *Required if attempting UPDATE on GLA | ||
ledger | No | Integer | 1 or 0 | 0 | 1 = Yes, 0 = No |
status | No | Integer | 1 or 0 | 1 | 1 = Active, 0 = Inactive |
speed_code | No | String | Speed Code of the GLA | ||
description | No | String | Description of the GLA | ||
format | Yes | String | System Specific | Name of the Format of the GLA | |
revenue | Conditionally* | Integer | 1 or 0 | 0 | 1 = marks GLA as Revenue / *Requirement: Either 'revenue', 'expense', or 'both' need to be set to '1'. |
expense | Conditionally* | Integer | 1 or 0 | 0 | 1 = marks GLA as Expense / *Requirement: Either 'revenue', 'expense', or 'both' need to be set to '1'. |
taxable | No | Integer | 1 or 0 | 0 | 1 = marks the GLA as taxable |
gla_item_1 | Yes | String | The first component of the GLA | ||
gla_item_n | System specific* | String | See post script postscript note |
*Post script 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 a 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 | |||||
---|---|---|---|---|---|
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 App Record
...
GLA Charges
Available as of 2.1.4.5
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 | NoFloat | Decimal | Will be used if Charge Catalog does not have a Default Amount set | ||
quantity | No | Integer | Quantity 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 | FloatDecimal | Amount to override the default amount with, if appplicable. |
...
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 |
Results
Toggle cloak |
---|
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. |
GLA Charges Tab App Record
Locating GLA Data
Within PCR-360, these menu options lists list a variety of Grids that can be used to help locate any of the required fields.
...