v2
latestSwagger 2.02026-08-01139174369.1 KBCustomers
Returns information about a single Customer. You may specify that Customer's ledger balance should be calculated.
get/v1/customers/{id}
Path parameters
idinteger required
Id of Customer to return.
Query parameters
needBalanceboolean
If "true" then Customer's ledger balance will be calculated; otherwise balance will be returned as 0.
Response
OK
Example response
{
"id": 10589,
"ownerTypeId": 1,
"code": "12345678",
"accountName": "",
"accountNumber": "12345678",
"authCode": "VATEXCODE222",
"contact": "John Smith",
"eFTReference": "Reference",
"email": "customer@email.com",
"fax": "1234567890",
"mobile": "1234567890",
"name": "Customer Name 1",
"ourCode": "OURCODE111",
"phone": "1234596970",
"vatReg": "VATCODE0001",
"timestamp": "AZhF5vbv3gg=",
"address": [
"Address Line 1",
"Address Line 2"
],
"additionalEmails": [
"email2@example.com",
"email3@example.com"
],
"bank": {
"id": 1,
"name": "bank Name",
"branch": "Bank",
"sortCode": "B01"
},
"vatAnalysisTypeId": 1,
"vatType": 2,
"businessIdentifierCode": "AIBI02",
"internationalBankAccountNumber": "1233432532",
"salesRepId": 1,
"delivery": [
"Delivery 1",
"Delivery 2"
]
}