This service provides access to customer account information. The customer has two collections for contacts. The Contacts list is typically used for CRM activity and the Delivery Contacts used to populate delivery contact information on sales orders.
Available Services...
GET PUT POST SEARCH| Property Name | Access | Description |
|---|---|---|
| Code | ReadWrite | The unique account code to identify the customer. This can be used in queries as an alternative to the ID to specify the customer when writing properties of type Customer |
| Name | ReadWrite | The customer's account name |
| Address.AddressLine1 | ReadWrite | Address line 1 |
| Address.AddressLine2 | ReadWrite | Address line 2 |
| Address.AddressLine3 | ReadWrite | Address line 3 |
| Address.AddressLine4 | ReadWrite | Address line 4 |
| Address.City | ReadWrite | The city |
| Address.County | ReadWrite | The county |
| Address.Country | ReadWrite | The country, this can be a valid country ID, country code or name. A list of valid countries can be retrieved from the country service |
| Address.PostCode | ReadWrite | A UK or Irish postcode or eircode |
| DefaultCurrency | ReadWrite | The default processing currency for the account. A list of valid currencies can be retrieved from the currency service. |
| Phone | ReadWrite | Phone |
| Mobile | ReadWrite | Mobile phone number associated with the account. Contacts can also have mobile phone numbers associated with them explicitly. |
| Fax | ReadWrite | Fax number |
| EmailAddress | ReadWrite | The primary account email address. Contacts may alos have specific email addresses associated with them. |
| SalesRep | ReadWrite | The sales rep primarily responsible for the customer account. A list of sales reps can be retrieved from the sales rep service. |
| Statistics.Balance | ReadWrite | The account balance in the account's currency |
| Statistics.OutstandingOrders | ReadWrite | The total value of outstanding sales orders in the account's currency |
| Statistics.UnbilledDeliveries | ReadWrite | The total value of orders that have been deliverd but are yet to be invoiced in the account's currency |
| CreditControlSetup.CreditLimit | ReadWrite | The account credit limit in the account currency |
| Contacts.FirstName | ReadWrite | Contacts.First name |
| Contacts.LastName | ReadWrite | Contacts.Last name |
| Contacts.Address.AddressLine1 | ReadWrite | Address line 1 |
| Contacts.Address.AddressLine2 | ReadWrite | Address line 2 |
| Contacts.Address.AddressLine3 | ReadWrite | Address line 3 |
| Contacts.Address.AddressLine4 | ReadWrite | Address line 4 |
| Contacts.Address.City | ReadWrite | City |
| Contacts.Address.County | ReadWrite | County |
| Contacts.Address.Country | ReadWrite | Country. A list of valid countries can be retrieved from the country service |
| Contacts.Address.PostCode | ReadWrite | A valid UK postcode or Irish eircode |
| DeliveryContacts.FirstName | ReadWriteCreate | Delivery contact first name |
| DeliveryContacts.LastName | ReadWriteCreate | Delivery contact last name |
| DeliveryContacts.Address.AddressLine1 | ReadWriteCreate | Address line 1 |
| DeliveryContacts.Address.AddressLine2 | ReadWriteCreate | Address line 2 |
| DeliveryContacts.Address.AddressLine3 | ReadWriteCreate | Address line 3 |
| DeliveryContacts.Address.AddressLine4 | ReadWriteCreate | Address line 4 |
| DeliveryContacts.Address.City | ReadWriteCreate | City |
| DeliveryContacts.Address.County | ReadWriteCreate | County |
| DeliveryContacts.Address.Country | ReadWriteCreate | Country. A list of valid countries can be retrieved from the country service |
| DeliveryContacts.Address.PostCode | ReadWriteCreate | A valid UK postcode or Irish eircode |
| Category.Code | ReadWrite | Customer Category Code |
| TradingName | ReadWrite | Trading Name |
| G_ItemAuditLastUpdateInformation.DateTime | ReadOnly | AuditLastUpdateInformation.DateTime |
| WorkflowStatus | ReadWrite | Workflow Status |
| BillingAccountType | ReadWrite | Account Type |
| CreditControlSetup.CreditTermDefault.CreditTermsQuantity | ReadWrite | CreditTermsQuantity |
| CreditControlSetup.CreditTermsUnits | ReadWrite | CreditTermsUnits |
| CompanyRegistration | ReadWrite | CompanyRegistration |
| TaxSetup.TaxRegistrationNumber | ReadWrite | TaxSetup.TaxRegistrationNumber |
| PaymentAccount | ReadWrite | PaymentAccount |
| _ID | ReadWrite | ERP_ID |
| CreditControlSetup.InsuranceCoverAmount | ReadWrite | CreditControlSetup.InsuranceCoverAmount |
| TaxSetup.DefaultTaxRate.Rate | ReadWrite | TaxSetup.DefaultTaxRate |
| PricingSetup.DefaultPriceIndex | ReadWrite | PricingSetup.DefaultPriceIndex |
| Category | ReadWrite | Category |
| Region | ReadWrite | Region |
| HomeBranch | ReadWrite | HomeBranch |
| Contacts.EmailAddress | ReadWrite | Contacts.EmailAddress |
| Contacts.G_ObjectID | ReadWrite | Contacts.ID |
| Contacts.Phone | ReadWrite | Contacts.Phone |
| Contacts.Mobile | ReadWrite | Contacts.Mobile |
| Contacts.ContactType | ReadWrite | Contact Type |
| DeliveryContacts.Salutation | ReadWriteCreate | DeliveryContacts.Salutation |
| DeliveryContacts.EmailAddress | ReadWriteCreate | DeliveryContacts.EmailAddress |
| DeliveryContacts.Phone | ReadWriteCreate | DeliveryContacts.Phone |
| DeliveryContacts.Mobile | ReadWriteCreate | DeliveryContacts.Mobile |
| Contacts.Salutation | ReadWrite | Contacts.Salutation |
| DeliveryContacts.G_ObjectID | ReadWriteCreate | DeliveryContacts.ID |
| CreditStatus.Code | ReadWrite | CreditStatus.Code |
| G_ItemAuditCreationInformation.DateTime | ReadOnly | G_ItemAuditCreationInformation.DateTime |
| Options.DefaultDeliveryContact.FirstName | ReadWrite | Options.DefaultDeliveryContact.FirstName |
| Options.DefaultDeliveryContact.G_ObjectID | ReadWrite | Options.DefaultDeliveryContact.G_ObjectID |
| Options.DefaultDeliveryContact.LastName | ReadWrite | Options.DefaultDeliveryContact.LastName |
| Options.DefaultDeliveryContact.Address.AddressLine1 | ReadWrite | Options.DefaultDeliveryContact.Address.AddressLine1 |
| Options.DefaultDeliveryContact.Address.AddressLine2 | ReadWrite | Options.DefaultDeliveryContact.Address.AddressLine2 |
| Options.DefaultDeliveryContact.Address.AddressLine3 | ReadWrite | Options.DefaultDeliveryContact.Address.AddressLine3 |
| Options.DefaultDeliveryContact.Address.AddressLine4 | ReadWrite | Options.DefaultDeliveryContact.Address.AddressLine4 |
| Options.DefaultDeliveryContact.Address.City | ReadWrite | Options.DefaultDeliveryContact.Address.City |
| Options.DefaultDeliveryContact.Address.Country | ReadWrite | Options.DefaultDeliveryContact.Address.Country |
| Options.DefaultDeliveryContact.Address.County | ReadWrite | Options.DefaultDeliveryContact.Address.County |
| Options.DefaultDeliveryContact.Address.PostCode | ReadWrite | Options.DefaultDeliveryContact.Address.PostCode |
| Options.DefaultDeliveryContact.Phone | ReadWrite | Options.DefaultDeliveryContact.Phone |
| Options.DefaultDeliveryContact.Mobile | ReadWrite | Options.DefaultDeliveryContact.Mobile |
| Options.DefaultDeliveryContact.EmailAddress | ReadWrite | Options.DefaultDeliveryContact.EmailAddress |
| Options.DefaultDeliveryContact.LookupCustomer.Code | ReadWrite | Options.DefaultDeliveryContact.LookupCustomer.Code |
| DeliveryContacts.AddressHandling | ReadWrite | DeliveryContacts.AddressHandling |
| Contacts.D_CRM_ID | ReadWrite | Contacts.D_CRM_ID |
| DeliveryContacts.D_CRM_ID | ReadWrite | DeliveryContacts.D_CRM_ID |
| Options.DefaultDeliveryContact.D_CRM_ID | ReadWrite | Options.DefaultDeliveryContact.D_CRM_ID |