Corrigo: Customer schemas
1 Corrigo schema with complete fields and constraints.
← Customer operations · All schemas
Create customer — request body — body entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | integer | Optional | Format: int32 |
isNew | boolean | Optional | Read only: true |
limitMultipleEntitiesNumberBehaviour | boolean | Optional | |
performDeletion | boolean | Optional | |
properties | JSON | Optional | |
properties (anyOf 1) | array | Alternative | |
properties (anyOf 1)[] | JSON | Each item | |
properties (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo PropertyTreeNode. |
properties (anyOf 1)[] (anyOf 2) | null | Alternative | |
properties (anyOf 2) | null | Alternative | |
concurrencyId | integer | Optional | Format: int32 |
isRemoved | boolean | Optional | |
addresses | JSON | Optional | |
addresses (anyOf 1) | array | Alternative | |
addresses (anyOf 1)[] | JSON | Each item | |
addresses (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo Address2. |
addresses (anyOf 1)[] (anyOf 2) | null | Alternative | |
addresses (anyOf 2) | null | Alternative | |
approvalScopes | JSON | Optional | |
approvalScopes (anyOf 1) | array | Alternative | |
approvalScopes (anyOf 1)[] | JSON | Each item | |
approvalScopes (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo ApprovalScope. |
approvalScopes (anyOf 1)[] (anyOf 2) | null | Alternative | |
approvalScopes (anyOf 2) | null | Alternative | |
contacts | JSON | Optional | |
contacts (anyOf 1) | array | Alternative | |
contacts (anyOf 1)[] | JSON | Each item | |
contacts (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo Contact. |
contacts (anyOf 1)[] (anyOf 2) | null | Alternative | |
contacts (anyOf 2) | null | Alternative | |
contract | JSON | Optional | |
contract (anyOf 1) | object | Alternative | A Corrigo Contract. |
contract (anyOf 2) | null | Alternative | |
customFields | JSON | Optional | |
customFields (anyOf 1) | array | Alternative | |
customFields (anyOf 1)[] | JSON | Each item | |
customFields (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo CustomField2. |
customFields (anyOf 1)[] (anyOf 2) | null | Alternative | |
customFields (anyOf 2) | null | Alternative | |
dba | JSON | Optional | |
dba (anyOf 1) | string | Alternative | |
dba (anyOf 2) | null | Alternative | |
displayAs | JSON | Optional | |
displayAs (anyOf 1) | string | Alternative | |
displayAs (anyOf 2) | null | Alternative | |
groupsBridge | JSON | Optional | |
groupsBridge (anyOf 1) | array | Alternative | |
groupsBridge (anyOf 1)[] | JSON | Each item | |
groupsBridge (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo LinkCustomerAndGroup. |
groupsBridge (anyOf 1)[] (anyOf 2) | null | Alternative | |
groupsBridge (anyOf 2) | null | Alternative | |
instructions | JSON | Optional | |
instructions (anyOf 1) | string | Alternative | |
instructions (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
notes | JSON | Optional | |
notes (anyOf 1) | array | Alternative | |
notes (anyOf 1)[] | JSON | Each item | |
notes (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo Note. |
notes (anyOf 1)[] (anyOf 2) | null | Alternative | |
notes (anyOf 2) | null | Alternative | |
spaces | JSON | Optional | |
spaces (anyOf 1) | array | Alternative | |
spaces (anyOf 1)[] | JSON | Each item | |
spaces (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo Space. |
spaces (anyOf 1)[] (anyOf 2) | null | Alternative | |
spaces (anyOf 2) | null | Alternative | |
taxExempt | boolean | Optional | |
tenantCode | JSON | Optional | |
tenantCode (anyOf 1) | string | Alternative | |
tenantCode (anyOf 2) | null | Alternative | |
workZone | JSON | Optional | |
workZone (anyOf 1) | object | Alternative | A Corrigo WorkZone. |
workZone (anyOf 2) | null | Alternative |