Site Definition
| Attribute | Type | Required | Description |
|---|---|---|---|
| id | int | On updates. | JSON block ID |
| accountId | int | Yes | Account ID that the Site belongs to. Must be greater than zero. |
| orgId | int | Yes | Organization ID that the Site belongs to. Must be greater than zero. |
| name | string | Yes | Name of the Site. Must be 100 or fewer characters in length. |
| contact | string | No | Name of the Point of Contact for the Site |
| commissionPercentage | int | No | For internal use. Must be greater than or equal to zero. |
| isActive | bool | Yes | Indicates whether the Site is active or inactive. |
| timeZone | string | No | Time zone that the Site is set to. Must be 50 or fewer characters in length. |
| isEnabled | bool | Yes | Indicates whether the Site is enabled in Client UI. This is readonly, please use the delete/undelete routes. |
| maxChargePrice | int | Yes | Maximum charge anticipated for machines assigned to Site. Must be greater than or equal to zero. |
| billingAddress | string | No | Billing address for the Site. Must be 300 or fewer characters in length. |
| shippingAddress | string | No | Shipping address for the Site. Must be 300 or fewer characters in length. |
| maximumMeterSalesJumpAllowed | int | Yes | Maximum meter sales jump allowed. Must be greater than or equal to zero. |
| commissionTerms | string | Yes | Commission terms period. See below for valid options. |
| externalAccountTerminalId | string | No | ID to configure Site with external POS system. Must be 50 or fewer characters in length. |
| chargeKeyId | int? | No | The ID of the charge key used at this site. If specified, must be greater than zero. |
Info
Valid CommissionTerms values:
- PrePaid
- Net10
- Net15
- Net30
- Net45
- Net60