| Table of Contents | ||||
|---|---|---|---|---|
|
...
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 |
...
Field | Required | Data Type | Options | Default | Notes |
|---|---|---|---|---|---|
equipment_recid | yes | IntegerRecid of equipment. | RECID column from EQUIPMENT _VLANS 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 |
...
Field | Required | Data Type | Options | Default | Notes |
|---|---|---|---|---|---|
equipment_recid | yes | Integer | Recid of equipment. RECID column from EQUIPMENT _REMARKS 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 |
...
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
| 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. | |||||||||||||
prorate | no | Integer | 1 or 0 | 0 | Should the Charge be prorated when activated | ||||||||||||
| 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 | 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. 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 | |||||||||||||
override_amount | no | Decimal | If allowed by the selected Charge, overrides the default amount from the Charge. | ||||||||||||||
override_gla | no | Integer | Lists
| RECID of GLA to override default GLA with. | |||||||||||||
| 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. |
...
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 |
...
Field | Required | Data Type | Options | Default | Notes | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
equipment_recid | yes | Integer | The RECID of the Equipment that the Charge is for. RECID column from EQUIPMENT _EXPENSE_GLA table. | ||||||||||||||
gla | yes | String | Lists
| 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
| 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 |
...
Field | Required | Data Type | Options | Default | Notes | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
equipment_recid | yes | Integer | The RECID of the Equipment that the Charge is for. RECID column from EQUIPMENT _CONTACTS table. | ||||||||||||||
contact | yes | String | Lists
| 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 |
...
Field | Required | Data Type | Options | Default | Notes |
|---|---|---|---|---|---|
equipment_recid | Yes | IntegerThe RECID of the Equipment that the Charge is for. | RECID column from USER_DEFINED_FIELDS_VALSEQUIPMENT 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 |
...