| Name | Description | Type | Additional information |
|---|---|---|---|
| FullName | string |
None. |
|
| ID |
The unique ID of the customer. This is in the format 000-000000 where the first three digits represent the Shop/Showroom code. This only needs to be specified when updating a record, not when creating. |
string |
Matching regular expression pattern: \d{3}[-]\d{6} String length: inclusive between 10 and 10 |
| Forename |
Customer's first name(s) |
string |
String length: inclusive between 0 and 50 |
| Surname |
Customer's surname |
string |
String length: inclusive between 0 and 50 |
| CompanyName |
The Company Name |
string |
String length: inclusive between 0 and 60 |
| MarketingFlagsID |
A collection of the marketing flag IDs that the customer has opted in for (GDPR). See api/Customers/MarketingFlags |
Collection of integer |
None. |
| AccountBalance |
Used either for saving schemes/customer accounts, this is the customer's current balance. |
decimal number |
None. |
| CustomerType |
The type of customer. |
EskimoClassLibraries.clsCustomer+CustomerTypeEnum |
None. |
| ShopVisibility |
Which shops can see this customer. |
EskimoClassLibraries.clsShopVisibility |
None. |
| ShopCreatedBy |
Optional. If omitted, this will default to the database the API is connected to, but can be specified. |
string |
None. |
| PriceListID |
Readonly. If using Price Lists, this determines which one the customer is linked to. See api/TillMenu/PriceListDump |
integer |
None. |
| PriceLevel |
Readonly. If not using Price Lists, this determines which price level to use for the customer. |
integer |
None. |
| AutomaticDiscountPercentage |
Readonly. Some customers are setup to benefit from a blanket discount on all products. This is the percentage |
integer |
None. |
| Notes |
Any notes about the customer. These can also be edited in the Eskimo software so may NOT be suitable for presenting to end-users. |
string |
None. |
| Telephone |
Customer's telephone number |
string |
String length: inclusive between 0 and 70 |
| Mobile |
Customer's mobile number |
string |
String length: inclusive between 0 and 70 |
| EmailAddress |
The email address of the customer. This is not the unique identifier in the Eskimo software - there may be duplicates although you will not be able to insert a new customer if that email address already exists. |
string |
String length: inclusive between 0 and 100 |
| WebsiteAddress |
The domain of the customer's website |
string |
String length: inclusive between 0 and 100 |
| ActiveAccount |
Current active status of the customer. (On/Off) |
boolean |
Required |
| Address |
Customer's Address minus the postal code. Carriage returns can be specified in JSON with a simple \r\n (i.e. "Address": "123 High Street\r\nLondon" ) |
string |
String length: inclusive between 0 and 400 |
| PostCode |
Customer's postal code |
string |
String length: inclusive between 0 and 16 |
| TitleID |
ID of the Customer's title (i.e. Mr., Mrs., Ms.) Use TitleID from api/Customers/Titles |
integer |
None. |
| CountryCode |
The 2 digit country code, for United Kingdon, use GB http://www.worldatlas.com/aatlas/ctycodes.htm |
string |
Required String length: inclusive between 2 and 2 |
| ExternalID |
Non-Eskimo Identifier. If this customer has also been inserted into another CRM system or Website, this is the PK for this customer entry. |
string |
String length: inclusive between 0 and 50 |
| MainAddress |
Required if running a multiple-addresses per customer system. If running a single address per customer system, use the Address and Postcode fields. |
EskimoClassLibraries.clsAddress |
None. |