Table of Contents | ||||
---|---|---|---|---|
|
...
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.
...
Remember, OUTPUT is replaced by the desired data type you want returned. Making a Request
Controlling Results Count
...
Type | Description | Extra Parameters* | Searchable | Results | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CONTACTS | Retrieve available Contacts | CTYPE - Type of contact. Example: "worker" | yes | Contacts
| |||||||||||
DEPTHIER | Retrieve available Departments | Coming Soon | Department Hierarchy
| ||||||||||||
EQP_CATALOG | Retrieve available Equipment Catalogs | yes | Equipment Catalog
| ||||||||||||
EXPENSE_TYPE | Retrieve available Expense Types | no | Expense Types
| ||||||||||||
GLAS | Retrieve available GLAs | no | GLA
| ||||||||||||
LOCATIONS | Retrieve available Locations | yes | Locations
| ||||||||||||
UDFS | Retrieve available User Defined Fields (UDF) | eqp_catalog_recid - REQUIRED: The RECID of a valid Equipment Catalog. Example: "53" | no | UDF
| |||||||||||
CABLING_EQP_TYPE | Retrieve available Cabling Equipment Types | no | Cabling Equipment Types
| ||||||||||||
EQP_CONDITION | Retrieve available Equipment Conditions | no | Equipment Conditions
| ||||||||||||
EQP_STATUS | Retrieve available Equipment Statuses | no | Equipment Statuses
| ||||||||||||
VLANS | Retrieve available VLANs | no | VLAN
|
Write Call
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 | no* | Integer | Identifier of the record to be updated | ||||||||||||||||||||||||
status | yes | Integer | Lists Value Lookups:
| The status of the Equipment | |||||||||||||||||||||||
eqp_catalog | yes | Integer | Lists Value Lookups:
Cloak | Insert excerpt | API | API | nopanel | true | | Recid of the Equipment Catalog item | |||||||||||||||||
location | no | Integer | Lists Value Lookups:
| Recid of Location | |||||||||||||||||||||||
owner | no* | Integer | Lists Value Lookups:
| Record ID of either the Contact or the Department Owner | |||||||||||||||||||||||
owner_type | no* | String | "contact" or "department" | Type of Owner. | |||||||||||||||||||||||
serial_number | no | String | Serial number of Equipment | ||||||||||||||||||||||||
serial_number_barcode | no | String | Serial number barcode of Equipment | ||||||||||||||||||||||||
equipment_id | no | String | ID of Equipment | ||||||||||||||||||||||||
asset_tag | no | String | Asset tag of the Equipment | ||||||||||||||||||||||||
billable | yes | Integer | 1 = yes; 0 = no | Designate if the Equipment is Billable | |||||||||||||||||||||||
consumed | yes | Integer | 1 = yes; 0 = no | Designate if the Equipment is consumed | |||||||||||||||||||||||
purchase_price | no | Decimal | Purchase price of the Equipment | ||||||||||||||||||||||||
received_date | no | String | Date Equipment was received | ||||||||||||||||||||||||
billed_date | no | String | Date Equipment was billed | ||||||||||||||||||||||||
card_number | no | String | Card number of Equipment | ||||||||||||||||||||||||
parent_equipment | no | Integer | Lists Value Lookups:
| Recid of parent Equipment, if applicable | |||||||||||||||||||||||
cabling_equipment_type | no | Integer | Lists Value Lookups:
| Recid of Cabling Equipment type | |||||||||||||||||||||||
ip4_gateway | no | String | IPv4 address of gateway for Equipment | ||||||||||||||||||||||||
ip6_gateway | no | String | IPv6 address of gateway for Equipment | ||||||||||||||||||||||||
lan_name | no | String | Name of LAN Equipment is attached to | ||||||||||||||||||||||||
mac | no | String | MAC address of Equipment | ||||||||||||||||||||||||
ip4 | no | String | IPv4 address of Equipment | ||||||||||||||||||||||||
ip6 | no | String | IPv6 address of Equipment | ||||||||||||||||||||||||
ip4_subnet | no | String | IPv4 address for subnet that Equipment is attached to | ||||||||||||||||||||||||
ip6_subnet | no | String | IPv6 address for subnet that Equipment is attached to | ||||||||||||||||||||||||
ip4_gateway_address | no | String | IPv4 address of gateway | ||||||||||||||||||||||||
ip6_gateway_address | no | String | IPv6 address of gateway | ||||||||||||||||||||||||
host_name | no | String | Host name of Equipment | ||||||||||||||||||||||||
condition | no | Integer | Lists Value Lookups:
| Recid of condition value for Equipment. | |||||||||||||||||||||||
ordered_date | no | String | Date Equipment was ordered | ||||||||||||||||||||||||
units | no | Quantity on hand | |||||||||||||||||||||||||
warranty_end_date | no | String | Date that warranty ends on Equipment. warranty_end_date is automatically set when received_date is provided | ||||||||||||||||||||||||
use_dhcp | yes | Integer | 1 = yes; 0 = no | Designate if the Equipment uses DHCP | |||||||||||||||||||||||
private | yes | Integer | 1 = yes; 0 = no | Designate if this Equipment is private | |||||||||||||||||||||||
vlan | no | Mixed | Recid of VLAN this Equipment belongs to. Multiple Recids can be provided using commas. Example: 23,34 | ||||||||||||||||||||||||
contact | no | Integer | Recid of the contact(s) to associate this Equipment with | ||||||||||||||||||||||||
remarks | no | String | Remarks for the Equipment | ||||||||||||||||||||||||
gla | no | Integer | Lists Value Lookups:
| Recid(s) of GLA record(s) to assign to this Service. If multiple GLAs are to be assigned, separate recids with commas. Example: 874,32. | |||||||||||||||||||||||
gla_percent | no* | String | 100 | Percentage(s) of this Service that should apply to specified GLA(s). *If multiple GLAs are provided, then percent is Conditionally Required and the same count of percentages need to be provided also. Total of all percentages must equal exactly 100. | |||||||||||||||||||||||
gla_type | no* | Integer | Lists Value Lookups:
| Recid(s) of Expense Type(s). |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Equipment VLANs
...
|
Equipment VLANs
Equipment can be assigned to one or more VLANs.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | yes | IntegerRecid of equipment | RECID column from EQUIPMENT table. | ||
vlan | yes | String | One or more Recids of VLANs. If multiple, separate with commas. Example: 23,43 |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 908 |
vlan | 1 |
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Equipment Remarks
Remarks can be added to Equipment.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | yes | IntegerRecid of equipment | RECID column from EQUIPMENT table. | ||
remarks | yes | String | The remark to add to the Equipment |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 456231 |
remarks | This is a Remark from the API |
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Equipment Charges
Charges can be easily added to Equipment. If multiple Charges need to be added to Equipment, then separate POST requests will need to be made.
...
Field | Required | Data Type | Options | Default | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
recid | no* | Integer | *Conditionally Required if attempting to UPDATE an Equipment Charge. RECID column from EQUIPMENT_CHARGES table. | ||||||||||||||
equipment_recid | yes | Integer | The RECID of the Equipment that the Charge is for. | ||||||||||||||
charge_recid | yes | Integer | Lists Value Lookups:
| RECID of the applicable Charge Catalog. | |||||||||||||
description | no | String | The details or Description of the Charge on the Equipment | ||||||||||||||
amount | no* | Decimal | The amount to be charged. *Conditionally Required if charge does not have an amount on it. | ||||||||||||||
quantity | no | Integer | 1 | Quantity of Charge to be used. Only allowed if Charge Catalog allows it. | |||||||||||||
prorate | no | Integer | 1 or 0 | 0 | Should the Charge be prorated when activatedbill. Only allowed if BILL_MRC_CHANGE_FORCE_PRORATE config option is false | ||||||||||||
start_date | no | String | Date the Charge was billed | override_amount | no | Decimal | If allowed by the selected Charge, overrides the default amount from the Charge. | override_gla | no | Integer | Lists Toggle cloak | Cloak | Insert excerpt | | API | API | |
nopanel | true | 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 | StringThe Date the Recurring Charge should stop on. | MCR 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. effective Other formats may give unexpected results. Used for Alternate Recurring Charges | |||||||||||||
transaction_date | no | String | today, backdate | today | Effective flag for the Charge being added/NRC | YYYY-MM-DD format. Other formats may give unexpected results. Used for Non-Recurring Charges | |||||||||||
override_amount | no | Decimal | If allowed by the selected Charge, overrides the default amount from the Charge. | ||||||||||||||
override_gla | no | Integer | Value Lookups:
| RECID of GLA to override default GLA with. The Override GLA Format should match the Billing Group Format of the Equipment. | |||||||||||||
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 APIAlternate Recurring Charges (Quarterly, Semi-Annual and Annual), when updated will always use backdate as the Effective Date.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-Recurring 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
Request Example
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/equipment.json |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 58337 |
charge_recid | 1 |
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Equipment GLA
GLAs can be easily added to Equipment. If multiple Charges need to be added to Equipment, then separate each value with commas.
...
Field | Required | Data Type | Options | Default | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
equipment_recid | yes | IntegerThe | RECID of the Equipment that the Charge is forRECID column from EQUIPMENT table. | ||||||||||||||
gla | yes | String | Lists Value Lookups:
| Record ID(s) of the applicable GLA(s). | |||||||||||||
gla_percent | yes | String | Percentages to apply to each GLA. All percentages must equal exactly 100. | ||||||||||||||
gla_type | yes | String | Lists Value Lookups:
| The type(s) of GLA(s). |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 2345 |
gla | 1 |
gla_percent | 100 |
gla_type | Default |
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Equipment Contacts
Contacts can be easily added to Equipment. If multiple charges need to be added to Equipment, then separate each value with commas.
...
Field | Required | Data Type | Options | Default | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
equipment_recid | yes | IntegerThe | RECID of the Equipment that the Charge is forRECID column from EQUIPMENT table. | ||||||||||||||
contact | yes | String | Lists Value Lookups:
| Record ID(s) of the Contact(s). |
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 2345 |
contact | 1 |
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
|
Equipment UDFs
User Defined Fields can be easily set for Equipment. To get a list of available UDFs for a piece of Equipment, visit Lists.
...
Field | Required | Data Type | Options | Default | Notes |
---|---|---|---|---|---|
equipment_recid | Yes | IntegerThe | RECID of the Equipment that the Charge is forRECID column from EQUIPMENT table. | ||
udf_UDF-RECID | Yes* | Integer | UDF-RECID is the RECID of the UDF to assign the value to. Example: udf_684=value
| ||
udf_UDF-IDENTIFIER | Yes* | Mixed | IDENTIFIER is the unique Identifier of the UDF to assign the value to. Example: udf_LEGACYNUM=value
|
...
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
status | Active |
eqp_catalog | 1 |
billable | 0 |
consumed | 0 |
use_dhcp | 0 |
private | 0 |
equipment_recid | 765 |
udf_UDF-RECID | 1 |
...
If the request is successful, the RECID(s) of the new Equipment UDF records will be returned same order provided:
Toggle cloak |
---|
Cloak | ||
---|---|---|
|
Locating Equipment Data
Within PCR-360, these menu options list a variety of Grids that can be used to help locate any of the required fields.
- Main > Cable
- Main > Services
- Main > Inventory
- Main > Catalog
- Specifically: Services, Equipment, Charges and G/L Accounts (GLA)
...