Codat List Accounting Customers Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "list-accounting-customers",
"method": "GET",
"path": "/companies/{companyId}/data/customers",
"summary": "List customers",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "Clear Books",
"example": {
"results": [
{
"id": "c8180244-74ac-40cf-a5df-6d83661c44d7",
"customerName": "Arjun Kuvalis",
"contactName": "Werner Langworth",
"emailAddress": "Arjun34@hotmail.com",
"defaultCurrency": "GBP",
"phone": "014605 64820",
"addresses": [
{
"type": "Delivery",
"line1": "Suite 214",
"line2": "8439 Lueilwitz Passage",
"city": "Fernandohaven",
"region": "Northern Ireland",
"country": "United Kingdom",
"postalCode": "JG04 7PV"
},
{
"type": "Delivery",
"line1": "Suite 096",
"line2": "864 Halie Course",
"city": "Juliochester",
"region": "England",
"country": "United Kingdom",
"postalCode": "DZ8 4BF"
},
{
"type": "Delivery",
"line1": "Suite 001",
"line2": "416 Stokes Fords",
"city": "Naderborough",
"region": "Wales",
"country": "United Kingdom",
"postalCode": "XG25 0XX"
}
],
"contacts": [
{
"name": "Werner Langworth",
"email": "Werner_Langworth@hotmail.com",
"phone": [],
"address": {
"type": "Delivery",
"line1": "Apt. 145",
"line2": "317 Williamson Freeway",
"city": "Hortenseville",
"region": "Scotland",
"country": "United Kingdom",
"postalCode": "CV4 2HR"
},
"status": "Active"
},
{
"name": "Belle Glover",
"email": "Belle51@yahoo.com",
"phone": [],
"address": {
"type": "Delivery",
"line1": "Suite 075",
"line2": "9921 Dickens Walk",
"city": "South Ali",
"region": "Scotland",
"country": "United Kingdom",
"postalCode": "TI04 4OO"
},
"status": "Active"
}
],
"registrationNumber": "NI7JEJVM",
"taxNumber": "7505220209.583549",
"status": "Active",
"modifiedDate": "2023-04-26T12:38:16Z",
"sourceModifiedDate": "2022-07-03T01:27:00",
"metadata": {
"isDeleted": false
}
},
{
"id": "6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0",
"customerName": "Breitenberg, Emard and Schiller",
"contactName": "Miguel Hahn",
"emailAddress": "contact@BreitenbergEmardandSchiller.biz",
"defaultCurrency": "GBP",
"phone": "0800 445 6957",
"addresses": [
{
"type": "Billing",
"line1": "Apt. 184",
"line2": "60578 Louie Springs",
"city": "East Khalid",
"region": "Wales",
"country": "United Kingdom",
"postalCode": "XW89 7NT"
}
],
"contacts": [
{
"name": "Miguel Hahn",
"email": "Miguel.Hahn@gmail.com",
"phone": [
{
"number": "018555 09614",
"type": "Landline"
}
],
"address": {
"type": "Delivery",
"line1": "Suite 400",
"line2": "21930 Milan Lane",
"city": "Reingerton",
"region": "Wales",
"country": "United Kingdom",
"postalCode": "QG10 2DL"
},
"status": "Active"
}
],
"registrationNumber": "KME0AMIL",
"taxNumber": "8560920952.553111",
"status": "Archived",
"modifiedDate": "2023-04-26T12:38:16Z",
"sourceModifiedDate": "2022-12-03T11:05:01",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 20,
"_links": {
"current": {
"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers"
},
"next": {
"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Dynamics 365 Business Central",
"example": {
"results": [
{
"id": "0e2f7751-7696-ed11-bff5-6045bd0d2ad6",
"customerName": "",
"contactName": "",
"emailAddress": "",
"defaultCurrency": "GBP",
"phone": "",
"addresses": [
{
"type": "Billing",
"line1": "",
"line2": "",
"city": "",
"region": "",
"country": "",
"postalCode": ""
}
],
"contacts": [
{
"name": "",
"email": "",
"phone": [],
"address": {
"type": "Billing",
"line1": "",
"line2": "",
"city": "",
"region": "",
"country": "",
"postalCode": ""
},
"status": "Active"
}
],
"taxNumber": "",
"status": "Active",
"modifiedDate": "2023-03-27T14:21:25Z",
"sourceModifiedDate": "2023-01-17T14:50:54Z",
"metadata": {
"isDeleted": false
}
},
{
"id": "0ef95175-48c4-eb11-9f0a-0022481b4343",
"customerName": "",
"contactName": "",
"emailAddress": "",
"defaultCurrency": "GBP",
"phone": "",
"addresses": [
{
"type": "Billing",
"line1": "",
"line2": "",
"city": "",
"region": "",
"country": "GB",
"postalCode": ""
}
],
"contacts": [
{
"name": "",
"email": "",
"phone": [],
"address": {
"type": "Billing",
"line1": "",
"line2": "",
"city": "",
"region": "",
"country": "GB",
"postalCode": ""
},
"status": "Active"
}
],
"taxNumber": "",
"status": "Active",
"modifiedDate": "2023-03-27T14:21:25Z",
"sourceModifiedDate": "2021-06-03T08:48:36Z",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 42,
"_links": {
"current": {
"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers"
},
"next": {
"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Exact (Netherlands)",
"example": {
"results": [
{
"id": "555f8251-c65a-433a-a813-5dbe04321d1e",
"customerName": "Ab Netherlands",
"defaultCurrency": "EUR",
"addresses": [
{
"type": "Billing",
"country": "NL"
}
],
"contacts": [],
"status": "Active",
"modifiedDate": "2022-10-26T13:32:05Z",
"sourceModifiedDate": "2021-06-14T15:26:37Z"
},
{
"id": "9fd1f78e-67aa-4af7-8a10-df1fc5fb5841",
"customerName": "anna test 2",
"defaultCurrency": "EUR",
"addresses": [
{
"type": "Billing",
"country": "NL"
}
],
"contacts": [],
"status": "Active",
"modifiedDate": "2022-10-26T13:32:05Z",
"sourceModifiedDate": "2022-05-24T11:53:21Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 71,
"_links": {
"current": {
"href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers"
},
"next": {
"href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Exact (UK)",
"example": {
"results": [
{
"id": "5f20075a-a28e-434d-81a6-2db0dc170e87",
"customerName": "Abdi 99",
"emailAddress": "email@codat.io",
"defaultCurrency": "GBP",
"addresses": [
{
"type": "Billing",
"line1": "Ink Rooms",
"city": "London",
"country": "GB",
"postalCode": "WC1X 0BE"
}
],
"contacts": [],
"registrationNumber": "123456789",
"taxNumber": "GB339 0727 47",
"status": "Active",
"modifiedDate": "2022-10-26T13:33:08Z",
"sourceModifiedDate": "2020-02-26T11:23:50Z"
},
{
"id": "1d9dc1a7-92d6-441b-93fd-42c9fb321b1c",
"customerName": "Abdulbasit Al-haj",
"contactName": "abeee",
"emailAddress": "a.alhaj@codat.io",
"defaultCurrency": "GBP",
"addresses": [
{
"type": "Billing",
"country": "GB"
}
],
"contacts": [
{
"name": "abeee",
"phone": [],
"address": {
"type": "Unknown",
"line1": "",
"country": "GB "
},
"status": "Active",
"modifiedDate": "2020-02-24T12:00:51.027Z"
}
],
"status": "Active",
"modifiedDate": "2022-10-26T13:33:08Z",
"sourceModifiedDate": "2020-02-24T12:00:50Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 53,
"_links": {
"current": {
"href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers"
},
"next": {
"href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "FreeAgent",
"example": {
"results": [
{
"id": "11526230",
"customerName": "-",
"contactName": "Test 1",
"addresses": [
{
"type": "Billing",
"line1": "1 Place House",
"line2": "",
"city": "London",
"country": "United Kingdom",
"postalCode": "WC1X 1AH"
}
],
"contacts": [
{
"name": "Test 1",
"phone": [],
"address": {
"type": "Billing",
"line1": "1 Place House",
"line2": "",
"city": "London",
"country": "United Kingdom",
"postalCode": "WC1X 1AH"
},
"status": "Unknown"
}
],
"status": "Active",
"modifiedDate": "2023-04-25T14:19:12Z",
"sourceModifiedDate": "2023-04-17T06:02:46Z",
"metadata": {
"isDeleted": false
}
},
{
"id": "9677150",
"customerName": "-",
"contactName": "Test 1",
"addresses": [
{
"type": "Billing",
"line1": "1 Place House",
"line2": "",
"city": "London",
"country": "United Kingdom",
"postalCode": "WC1X 1AH"
}
],
"contacts": [
{
"name": "Test 1",
"phone": [],
"address": {
"type": "Billing",
"line1": "1 Place House",
"line2": "",
"city": "London",
"country": "United Kingdom",
"postalCode": "WC1X 1AH"
},
"status": "Unknown"
}
],
"status": "Active",
"modifiedDate": "2023-04-25T14:19:12Z",
"sourceModifiedDate": "2023-04-24T06:19:23Z",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 159,
"_links": {
"current": {
"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers"
},
"next": {
"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "FreshBooks",
"example": {
"results": [
{
"id": "634509",
"customerName": "A test customer 14 (updated)",
"contactName": "test person name",
"emailAddress": "test14@example.com",
"defaultCurrency": "GBP",
"phone": "01876 541245",
"addresses": [
{
"type": "Billing",
"line1": "Line 1",
"line2": "Line 2",
"city": "Some city",
"region": "A region",
"country": "Country 1",
"postalCode": "SW1 2JQ"
}
],
"contacts": [
{
"name": "test person1",
"email": "test14A@example.com",
"phone": [
{
"number": "24681012",
"type": "Primary"
},
{
"number": "121086420",
"type": "Unknown"
}
],
"status": "Active"
},
{
"name": "test person2",
"email": "test14B@example.com",
"phone": [
{
"number": "1234 56789",
"type": "Primary"
},
{
"number": "9876 54321",
"type": "Unknown"
}
],
"status": "Active"
},
{
"name": "test person name",
"email": "test14@example.com",
"phone": [
{
"number": "01876 541245",
"type": "Unknown"
}
],
"status": "Active"
}
],
"status": "Active",
"modifiedDate": "2023-03-24T16:07:23Z",
"sourceModifiedDate": "2022-05-18T09:23:56",
"metadata": {
"isDeleted": false
}
},
{
"id": "634486",
"customerName": "A test customer name 2",
"contactName": "test person name",
"emailAddress": "test8@example.com",
"defaultCurrency": "GBP",
"phone": "01876 541245",
"addresses": [
{
"type": "Billing",
"line1": "Line 1",
"line2": "Line 2",
"city": "Some city",
"region": "A region",
"country": "Country 1",
"postalCode": "SW1 2JQ"
}
],
"contacts": [
{
"name": "test person1",
"email": "test9@example.com",
"phone": [
{
"number": "24681012",
"type": "Primary"
},
{
"number": "121086420",
"type": "Unknown"
}
],
"status": "Active"
},
{
"name": "test person2",
"email": "test10@example.com",
"phone": [
{
"number": "123456789",
"type": "Primary"
},
{
"number": "987654321",
"type": "Unknown"
}
],
"status": "Active"
},
{
"name": "test person name",
"email": "test8@example.com",
"phone": [
{
"number": "01876 541245",
"type": "Unknown"
}
],
"status": "Active"
}
],
"status": "Active",
"modifiedDate": "2023-03-24T16:07:23Z",
"sourceModifiedDate": "2022-05-11T11:39:58",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 39,
"_links": {
"current": {
"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers"
},
"next": {
"href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "KashFlow",
"example": {
"results": [
{
"id": "92227673",
"customerName": "Chekko Customer Test 01",
"contactName": "",
"emailAddress": "",
"phone": "",
"addresses": [],
"contacts": [
{
"name": "",
"email": "",
"phone": [],
"status": "Active"
}
],
"taxNumber": "",
"status": "Active",
"modifiedDate": "2022-09-30T10:29:15Z",
"sourceModifiedDate": "0001-01-01T00:00:00"
},
{
"id": "88459410",
"customerName": "Diogo Sousa",
"contactName": "Mr Diogo Sousa",
"emailAddress": "diogomail@mail.com",
"phone": "123123123",
"addresses": [
{
"type": "Billing",
"line1": "Billing Address",
"line2": "Billing line 2 Billing line 3",
"city": "Billing line 4",
"country": "United Kingdom",
"postalCode": "123321"
},
{
"type": "Delivery",
"line1": "Delivery Address",
"line2": "Delivery line2 Delivery line3",
"city": "Delivery line4",
"country": "United Kingdom",
"postalCode": "123321"
}
],
"contacts": [
{
"name": "Mr Diogo Sousa",
"email": "diogomail@mail.com",
"phone": [
{
"number": "123123123",
"type": "Landline"
},
{
"number": "321321321",
"type": "Mobile"
}
],
"address": {
"type": "Billing",
"line1": "Billing Address",
"line2": "Billing line 2 Billing line 3",
"city": "Billing line 4",
"country": "United Kingdom",
"postalCode": "123321"
},
"status": "Active"
},
{
"name": "Mr Diogo Sousa",
"phone": [],
"address": {
"type": "Delivery",
"line1": "Delivery Address",
"line2": "Delivery line2 Delivery line3",
"city": "Delivery line4",
"country": "United Kingdom",
"postalCode": "123321"
},
"status": "Active"
}
],
"taxNumber": "",
"status": "Active",
"modifiedDate": "2022-09-30T10:29:15Z",
"sourceModifiedDate": "2021-05-04T13:22:19"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 10,
"_links": {
"current": {
"href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers"
},
"next": {
"href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Oracle NetSuite",
"example": {
"results": [
{
"id": "773",
"customerName": "119 Test Customer",
"contactName": "Mr Test Customer",
"defaultCurrency": "GBP",
"addresses": [],
"contacts": [],
"status": "Active",
"modifiedDate": "2023-01-30T14:48:02Z",
"sourceModifiedDate": "2022-01-11T12:28:49"
},
{
"id": "172722",
"customerName": "1248 European Company",
"contactName": "European Company",
"defaultCurrency": "GBP",
"addresses": [],
"contacts": [],
"status": "Active",
"modifiedDate": "2023-01-30T14:48:02Z",
"sourceModifiedDate": "2022-07-27T14:29:16"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 4,
"_links": {
"current": {
"href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers"
},
"next": {
"href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "QuickBooks Desktop",
"example": {
"results": [
{
"id": "150000-933272658",
"customerName": "Abercrombie, Kristy",
"contactName": "Kristy Abercrombie",
"emailAddress": "kristy@samplename.com",
"defaultCurrency": "GBP",
"phone": "415-555-6579",
"addresses": [
{
"type": "Delivery",
"line1": "Kristy Abercrombie",
"line2": "5647 Cypress Hill Rd",
"city": "Bayshore",
"region": "CA",
"postalCode": "94326"
},
{
"type": "Billing",
"line1": "Kristy Abercrombie",
"line2": "5647 Cypress Hill Rd",
"city": "Bayshore",
"region": "CA",
"postalCode": "94326"
}
],
"contacts": [
{
"name": "Abercrombie, Kristy",
"email": "kristy@samplename.com",
"phone": [
{
"number": "415-555-6579",
"type": "Primary"
}
],
"status": "Active"
},
{
"name": "Kristy Abercrombie",
"phone": [],
"status": "Active"
},
{
"name": "Steve Darcangelo",
"phone": [],
"status": "Active"
}
],
"status": "Active",
"modifiedDate": "2023-04-26T09:07:55Z",
"sourceModifiedDate": "2023-12-16T05:06:42",
"metadata": {
"isDeleted": false
}
},
{
"id": "800000D0-1182061376",
"customerName": "Allard, Robert",
"contactName": "Amanda Roberts",
"emailAddress": "rallard@myemail.com",
"defaultCurrency": "GBP",
"phone": "650-555-3422",
"addresses": [
{
"type": "Delivery",
"line1": "Robert Allard",
"line2": "92834 Chandler St.",
"city": "Millbrae",
"region": "CA",
"postalCode": "94030"
},
{
"type": "Billing",
"line1": "Robert Allard",
"line2": "92834 Chandler St.",
"city": "Millbrae",
"region": "CA",
"postalCode": "94030"
}
],
"contacts": [
{
"name": "Allard, Robert",
"email": "rallard@myemail.com",
"phone": [
{
"number": "650-555-3422",
"type": "Primary"
},
{
"number": "650-555-9804",
"type": "Fax"
},
{
"number": "650-555-8349",
"type": "Unknown"
}
],
"status": "Active"
},
{
"name": "Robert Allard",
"phone": [],
"status": "Active"
},
{
"name": "Rachel Fisher",
"phone": [],
"status": "Active"
}
],
"status": "Active",
"modifiedDate": "2023-04-26T09:07:55Z",
"sourceModifiedDate": "2023-12-16T05:06:42",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 64,
"_links": {
"current": {
"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers"
},
"next": {
"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "QuickBooks Online",
"example": {
"results": [
{
"id": "9",
"customerName": "Abe",
"contactName": "Abraham's Company",
"emailAddress": "ab@email.com",
"defaultCurrency": "GBP",
"addresses": [],
"contacts": [
{
"name": "Abe",
"email": "ab@email.com",
"phone": [
{
"number": "01111111111",
"type": "Mobile"
}
],
"status": "Active"
}
],
"registrationNumber": "XXXX9900001",
"taxNumber": "XXXX9900001",
"status": "Active",
"modifiedDate": "2023-01-18T11:02:35Z",
"sourceModifiedDate": "2022-12-08T15:42:59Z"
},
{
"id": "49",
"customerName": "adeel qbo child test",
"contactName": "Adeel test",
"emailAddress": "adeel@adeel.com",
"defaultCurrency": "GBP",
"phone": "123456789",
"addresses": [
{
"type": "Billing",
"line1": "4 Privet Drive",
"city": "London",
"country": "United Kingdom",
"postalCode": "WD25 7LR"
},
{
"type": "Delivery",
"line1": "4 Privet Drive",
"city": "London",
"country": "United Kingdom",
"postalCode": "WD25 7LR"
}
],
"contacts": [
{
"name": "Adeel test",
"email": "adeel@adeel.com",
"phone": [
{
"number": "123456789",
"type": "Primary"
},
{
"number": "07546543216",
"type": "Mobile"
}
],
"address": {
"type": "Billing",
"line1": "4 Privet Drive",
"city": "London",
"country": "United Kingdom",
"postalCode": "WD25 7LR"
},
"status": "Active"
}
],
"status": "Active",
"modifiedDate": "2023-01-18T11:02:35Z",
"sourceModifiedDate": "2022-08-22T09:21:09Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 40,
"_links": {
"current": {
"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=1&pageSize=2"
},
"self": {
"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers"
},
"next": {
"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "QuickBooks Online Sandbox",
"example": {
"results": [
{
"id": "66",
"customerNam
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codat/refs/heads/main/examples/codat-list-accounting-customers-example.json