...
| Field | Value type | Mandatory | Description | Example |
|---|---|---|---|---|
| IDCustomer | string | Unique identifier of the customer. The CustomerID is used for updating or deleting an existing customer. | 7090fad1-c4da-4488-9ceb-55ee9847edcc | |
| CustomerRef | string | Human readable unique identifier of the customer | 2586681 | |
| ExternalRef | string | A reference to an id used in an external system to Crittah. This can be used to link Crittah to internal systems and maintaining the relationship between the two systems. | HSG29373 | |
| IDSite | string | Unique ID for the site the customer belongs to | 20058233-7388-418b-9193-6b57e28604f9 | |
| Site | string | Site Name that customer belongs to | SYD | |
| Types | Types Object | Array of types returned when getting a record | [ { "IDType": "c0fd94f3-2ddd-4eea-bc24-40189480d10f", "Type": "Producer" }, | |
| IDTypes | Array strings | Used when adding or updating the record | "IDTypes": [ "c0fd94f3-2ddd-4eea-bc24-40189480d10f", "eb6bef8f-6f03-49dd-80a4-83a220f6ddc3"] | |
| IDStatus | string | IDStatus of customer | 926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa | |
| Status | string | Indicates the status of the customer. | Pending | |
| IDParent | string | ID of the parent customer. This is used when linking many customer to a single head office customer. | 926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa | |
| CompanyName | string | Name of the customer. | Megga Corp Pty Ltd | |
| CompanyNo | string | Legal registered company number | 28787 876 8876 | |
| Phone | string | Customers phone | (02) 9506 3560 | |
| Mobile | string | Customers Mobile | 0412 544 654 | |
| Fax | string | Customers Fax | (02) 9567 680 | |
| Council | string | Local council customer resides in. | Parramatta | |
| WebSite | string | customers position | Manager | |
| AddressBilling | Address Object | Customers Billing Address | See Address Object | |
| Address | Address Object | Customers Physical Address | See Address Object | |
| Notes | Array of Notes Object | Customers notes. | See Notes Object | |
| AccountOwner | string | Account owner that the customer belongs to. This is a user in Crittah. User list information can be retrieved users from the Helper REST API | 926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa |
...