latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Customers
Gets the latest customers for a business.
get/customers
Query parameters
businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' required
offsetnumber
The offset is the position in the dataset of a particular record.
limitnumber
This is the size of the results set you would like (default: 100).
orderBystring
Response
Example response
{
"count": 1,
"meta": {
"reportId": [
"5fad8a342a88364234392fb5",
"5fad8a342a88364234392fb6"
],
"serviceName": "xero",
"businessName": "Railz",
"createdAt": "2020-11-25T01:02:03Z",
"updatedAt": "2020-11-30T01:02:03Z"
},
"data": [
{
"id": "1",
"customerName": "ACME Inc.",
"contactName": "Jane Smith",
"emailAddress": "email@acme.com",
"website": "www.acme.com",
"phone": "8889990000",
"taxNumber": "987654321",
"subsidiaryRefs": [
{
"id": "1",
"name": "Railz Financial"
}
],
"sourceModifiedDate": "2021-03-09T08:49:36.035Z",
"parentRef": {
"id": "434",
"name": "Region"
},
"contacts": [
{
"name": "John Smith",
"email": "jsmith@company.com",
"phone": "8887779999",
"address": {
"line1": "1234 Park Street",
"line2": "Suite 1000",
"city": "Toronto",
"region": "ON",
"country": "CAN",
"postalCode": "A0B1C2"
},
"modifiedDate": "2021-03-09T08:49:36.035Z"
}
],
"defaultCurrency": {
"id": "CAD",
"name": "Canadian Dollar",
"symbol": "USD,CAD"
},
"addresses": [
{
"line1": "1234 Park Street",
"line2": "Suite 1000",
"city": "Toronto",
"region": "ON",
"country": "CAN",
"postalCode": "A0B1C2"
}
]
}
]
}