GET Customer/Get/{id}

Gets the specified Customer based on the identifier. Excludes records where Personal Information was cleared.

Request Information

URI Parameters

Name	Type	Additional information	Description
id	integer	Required	The Customer Id.

Body Parameters

None.

Response Information

Resource Description

Customer

Name	Type	Additional information	Description
ID	integer	None.
Name	string	Required String length: inclusive between 0 and 100
Category	Customer Category	None.
SalesRepresentativeId	nullable integer	None.
SalesRepresentative	Sales Representative	None.
TaxReference	string	String length: inclusive between 0 and 30
ContactName	string	String length: inclusive between 0 and 100
Telephone	string	String length: inclusive between 0 and 30
Fax	string	String length: inclusive between 0 and 30
Mobile	string	String length: inclusive between 0 and 30
Email	string	None.
WebAddress	string	String length: inclusive between 0 and 100
Active	bool	None.
IsObfuscated	bool	None.
Balance	decimal	Read Only / System Generated
CreditLimit	decimal	None.
CommunicationMethod	nullable integer	None.	Gets or sets the communication method. Optional. None = 0, Print = 1, Email = 2, Print and Email = 3
PostalAddress01	string	String length: inclusive between 0 and 100
PostalAddress02	string	String length: inclusive between 0 and 100
PostalAddress03	string	String length: inclusive between 0 and 100
PostalAddress04	string	String length: inclusive between 0 and 100
PostalAddress05	string	String length: inclusive between 0 and 100
DeliveryAddress01	string	String length: inclusive between 0 and 100
DeliveryAddress02	string	String length: inclusive between 0 and 100
DeliveryAddress03	string	String length: inclusive between 0 and 100
DeliveryAddress04	string	String length: inclusive between 0 and 100
DeliveryAddress05	string	String length: inclusive between 0 and 100
AutoAllocateToOldestInvoice	nullable bool	None.
EnableCustomerZone	bool	None.
CustomerZoneGuid	globally unique identifier	Read Only / System Generated
CashSale	nullable bool	None.
TextField1	string	String length: inclusive between 0 and 100
TextField2	string	String length: inclusive between 0 and 100
TextField3	string	String length: inclusive between 0 and 100
NumericField1	nullable decimal	None.
NumericField2	nullable decimal	None.
NumericField3	nullable decimal	None.
YesNoField1	bool	None.
YesNoField2	bool	None.
YesNoField3	bool	None.
DateField1	nullable date	None.
DateField2	nullable date	None.
DateField3	nullable date	None.
DefaultPriceListId	nullable integer	None.
DefaultPriceList	Additional Price List	None.
DefaultPriceListName	string	None.
AcceptsElectronicInvoices	bool	None.
Modified	nullable date	Read Only / System Generated
Created	date	Read Only / System Generated
BusinessRegistrationNumber	string	None.
TaxStatusVerified	nullable date	None.
CurrencyId	nullable integer	None.
CurrencySymbol	string	None.
HasActivity	bool	Read Only / System Generated
DefaultDiscountPercentage	nullable decimal	None.
DefaultTaxTypeId	nullable integer	None.
DefaultTaxType	Tax Type	None.
DueDateMethodId	nullable integer	None.	Specifies which method should be used to determine the invoice due date. Days from date of Invoice = 0, Day of the current Month = 1, Day of the following Month = 2, End of the current Month = 3, Days from the end of the Invoice Month = 4
DueDateMethodValue	nullable integer	None.
CityId	nullable integer	None.
AccountingAgreement	nullable bool	None.
HasSpecialCountryTaxActivity	bool	Read Only / System Generated
OutstandingInvoices	nullable bool	None.
OverdueInvoices	nullable bool	None.
OnHold	nullable bool	None.
ExcludeFromDebtorsManager	nullable bool	None.
SubjectToDRCVat	bool	None.	This will only be used by Customers in South Africa. DRC Vat is only subject to Registered Vat Vendors.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Category": {
    "Description": "sample string 1",
    "ID": 2,
    "Modified": "2024-11-15",
    "Created": "2024-11-15"
  },
  "SalesRepresentativeId": 1,
  "SalesRepresentative": {
    "ID": 1,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Name": "sample string 2 sample string 3",
    "Active": true,
    "Email": "sample string 6",
    "Mobile": "sample string 7",
    "Telephone": "sample string 8",
    "Created": "2024-11-15",
    "Modified": "2024-11-15"
  },
  "TaxReference": "sample string 2",
  "ContactName": "sample string 3",
  "Telephone": "sample string 4",
  "Fax": "sample string 5",
  "Mobile": "sample string 6",
  "Email": "sample string 7",
  "WebAddress": "sample string 8",
  "Active": true,
  "IsObfuscated": true,
  "Balance": 11.0,
  "CreditLimit": 12.0,
  "CommunicationMethod": 1,
  "PostalAddress01": "sample string 13",
  "PostalAddress02": "sample string 14",
  "PostalAddress03": "sample string 15",
  "PostalAddress04": "sample string 16",
  "PostalAddress05": "sample string 17",
  "DeliveryAddress01": "sample string 18",
  "DeliveryAddress02": "sample string 19",
  "DeliveryAddress03": "sample string 20",
  "DeliveryAddress04": "sample string 21",
  "DeliveryAddress05": "sample string 22",
  "AutoAllocateToOldestInvoice": true,
  "EnableCustomerZone": true,
  "CustomerZoneGuid": "9ab77b59-674b-4479-939a-6efb45c3ba69",
  "CashSale": true,
  "TextField1": "sample string 25",
  "TextField2": "sample string 26",
  "TextField3": "sample string 27",
  "NumericField1": 1.0,
  "NumericField2": 1.0,
  "NumericField3": 1.0,
  "YesNoField1": true,
  "YesNoField2": true,
  "YesNoField3": true,
  "DateField1": "2024-11-15",
  "DateField2": "2024-11-15",
  "DateField3": "2024-11-15",
  "DefaultPriceListId": 1,
  "DefaultPriceList": {
    "ID": 1,
    "Description": "sample string 2",
    "IsDefault": true
  },
  "DefaultPriceListName": "sample string 2",
  "AcceptsElectronicInvoices": true,
  "Modified": "2024-11-15",
  "Created": "2024-11-15",
  "BusinessRegistrationNumber": "sample string 34",
  "TaxStatusVerified": "2024-11-15",
  "CurrencyId": 1,
  "CurrencySymbol": "sample string 35",
  "HasActivity": true,
  "DefaultDiscountPercentage": 1.0,
  "DefaultTaxTypeId": 1,
  "DefaultTaxType": {
    "ID": 1,
    "Name": "sample string 2",
    "Percentage": 3.1,
    "IsDefault": true,
    "HasActivity": true,
    "IsManualTax": true,
    "Active": true,
    "Created": "2024-11-15",
    "Modified": "2024-11-15",
    "TaxTypeDefaultUID": "e65f5cbc-11f9-475a-9398-fb27eb2bb854",
    "CompanyId": 9
  },
  "DueDateMethodId": 1,
  "DueDateMethodValue": 1,
  "CityId": 1,
  "AccountingAgreement": true,
  "HasSpecialCountryTaxActivity": true,
  "OutstandingInvoices": true,
  "OverdueInvoices": true,
  "OnHold": true,
  "ExcludeFromDebtorsManager": true,
  "SubjectToDRCVat": true,
  "ID": 40
}