| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
Caliq internal unique identifier |
integer |
None. |
| AccountNo |
User entered unique customer account number |
string |
Max length: 10 |
| Name |
Customer name |
string |
Max length: 40 |
| Active |
Is this an active customer. Inactive customers should not be allowed to place orders |
boolean |
None. |
| WebContactID |
The internal ID of the contact selected to be the 'website' contact. If this is zero then the account has not been configured correctly in Caliq |
integer |
None. |
| AccountType |
(P)roForma, (A)ccount, (G)roup, (C)ash/Card |
string |
Max length: 1 |
| DirectDespatch |
Is this a direct despatch customer |
boolean |
None. |
| GroupAccountID |
Caliq internal unique identifier of parent account |
integer |
None. |
| GroupAccountNo |
User entered unique customer account number of parent account |
string |
Max length: 10 |
| DeliveryTerms |
User maintainable list value from Caliq |
string |
Max length: 100 |
| Currency |
Currency the customer trades in. Orders in other currencies will not be accepted |
string |
Max length: 3 |
| EORI |
Customer EORI number |
string |
Max length: 20 |
| PaymentTerms |
Description of customers normal payment terms |
string |
Max length: 60 |
| PriceListID |
The price list to be used to derive pricing for this customer |
integer |
None. |
| PriceListName | string |
Max length: 50 |
|
| PriceListStandard |
The price list this customer's price agreement is based on |
integer |
None. |
| PriceListNormalDisc |
The normal discount percentage this customer receives. Price data will have already applied this but supplied for your reference |
decimal number |
None. |
| OnStop |
Is this account 'On Stop' due to non payment |
boolean |
None. |
| CustPurchOrderMandatory |
Is customer p/o number mandatory when sending orders? |
boolean |
None. |
| ServiceLevel | string |
Max length: 80 |
|
| Category | string |
Max length: 40 |
|
| CategoryCode | string |
Max length: 4 |
|
| AccountCreated |
Date account created in YYYYMMDD format |
string |
None. |
| LastOrder |
Date last ordered in YYYYMMDD format |
string |
None. |
| CreditLimit |
Customers credit limit in customer cuurrency |
integer |
None. |
| ApplySurcharges |
Is this customer subject to surcharging? |
boolean |
None. |
| Balance_NotDue |
Customers aged balance - amount not yet due in customer currency |
decimal number |
None. |
| Balance_1to30Overdue |
Customers aged balance - amount 1 to 30 days overdue in customer currency |
decimal number |
None. |
| Balance_31to60Overdue |
Customers aged balance - amount 31 to 60 days overdue in customer currency |
decimal number |
None. |
| Balance_61to90Overdue |
Customers aged balance - amount 61 to 90 days overdue in customer currency |
decimal number |
None. |
| Balance_90PlusOverdue |
Customers aged balance - amount 90 or more days overdue in customer currency |
decimal number |
None. |
| OSOrderValue |
Value of outstanding orders including what may already be in warehouse, including VAT |
decimal number |
None. |
| ValueInWH |
Value of goods moving through the warehouse, including VAT |
decimal number |
None. |
| AvailCredit |
The value of goods which could be taken from back orders and sent to the warehouse without going over credit limit. Credit limit - outstanding invoices - value of what is in the warehouse already |
decimal number |
None. |
| AvailCreditOSOrders |
The value of new orders which could be taken and despatched along with exisiting back orders, without going over credit limit. Credit limit - outstanding invoices - value of all outstanding orders |
decimal number |
None. |
| LastStatementDocID |
Internal ID of the most recent statement PDF. Can be retrieved via DocumentPDF endpoint |
integer |
None. |
| WebCustomerRef |
Website's Internal ID of the Customer |
string |
Max length: 30 |
| UDF1 |
User defined field 1 |
string |
Max length: 40 |
| UDF2 |
User defined field 2 |
string |
Max length: 40 |
| UDF3 |
User defined field 3 |
string |
Max length: 40 |
| UDF4 |
User defined field 4 |
string |
Max length: 40 |
| UDF5 |
User defined field 5 |
string |
Max length: 40 |
| UDF6 |
User defined field 6 |
string |
Max length: 40 |
| UDF7 |
User defined field 7 |
string |
Max length: 40 |
| UDF8 |
User defined field 8 |
string |
Max length: 40 |
| UDF9 |
User defined field 9 |
string |
Max length: 40 |
| Addresses | Collection of Address |
None. |
|
| Contacts | Collection of Contact |
None. |