...
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.
...
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
|
...
Contact 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.
...
No Format |
---|
http://DOMAIN/api/API_KEY/gla.OUTPUT |
Insert excerpt SQL API Calls SQL API Calls nopanel true
Insert excerpt Custom API Custom API nopanel true
Available Fields
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 Charges
...
GLA Endpoint
No Format |
---|
http://DOMAIN/api/API_KEY/gla.OUTPUT |
Available Fields
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
type | Yes | String | CHARGES | This is |
Required when interacting with GLA Charges |
recid |
No* | 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. |
Charge Validations
The following checks are made by the API when adding a Charge:
- Charge Catalog restrictions are not violated
- Error if the amount is provided and the Catalog does not allow overrides
- Error if quantity provided for non/quantity Catalogs, also checks for whole numbers/fractional and errors is a fraction
- Verify Service is billable when adding a Charge
- Verify there exists an expense GLA that matches the Charge Catalog Expense Type
- Monthly Recurring Charges
- start_date is required for new charge
- error if stop_date is provided for billing complete charges
- error if stop_date is earlier than start_date
- Non-Recurrring Charges
- transaction_date is required for new charge
- error if stop_date is provided
- Alternate Recurring Charges (Annual, Semi-Anual, Quarterly)
- start_date is required for new charge
- recurring_date is required for new charge
- error if stop_date is provided for billing complete charges
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. |
...
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.
...