Codat List Bank Accounts 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-bank-accounts",
"method": "GET",
"path": "/companies/{companyId}/connections/{connectionId}/data/bankAccounts",
"summary": "List bank accounts",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "Dynamics 365 Business Central",
"example": {
"results": [
{
"id": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b",
"accountName": "55",
"accountType": "Unknown",
"nominalCode": "10500",
"sortCode": "",
"accountNumber": "",
"iBan": "",
"currency": "GBP",
"balance": -352.03,
"modifiedDate": "2023-03-27T14:21:10Z",
"sourceModifiedDate": "2023-02-07T00:00:00",
"overdraftLimit": 0,
"metadata": {
"isDeleted": false
}
},
{
"id": "47020f80-60e6-ec11-82f8-0022481a77f0",
"accountName": "555",
"accountType": "Unknown",
"nominalCode": "40300",
"sortCode": "",
"accountNumber": "",
"iBan": "",
"currency": "PLN",
"balance": 661.79,
"modifiedDate": "2023-03-27T14:21:10Z",
"sourceModifiedDate": "2022-06-07T00:00:00",
"overdraftLimit": 0,
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 28,
"_links": {
"current": {
"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts"
},
"next": {
"href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "FreeAgent",
"example": {
"results": [
{
"id": "738783",
"accountName": "\\w3fw",
"accountType": "Debit",
"sortCode": "236972",
"accountNumber": "A06268209",
"currency": "GBP",
"balance": -10484.65,
"availableBalance": -10484.65,
"modifiedDate": "2023-04-25T14:19:12Z",
"metadata": {
"isDeleted": false
}
},
{
"id": "738778",
"accountName": "2e2bna45hy\\",
"accountType": "Debit",
"sortCode": "236972",
"accountNumber": "D01825250",
"currency": "GBP",
"balance": -114.4,
"availableBalance": -114.4,
"modifiedDate": "2023-04-25T14:19:12Z",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 82,
"_links": {
"current": {
"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts"
},
"next": {
"href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "KashFlow",
"example": {
"results": [
{
"id": "765768",
"accountName": "16th Account",
"accountType": "Unknown",
"nominalCode": "70700",
"currency": "GBP",
"balance": 326,
"availableBalance": 326,
"modifiedDate": "2022-09-30T10:29:16Z"
},
{
"id": "765766",
"accountName": "1a1a",
"accountType": "Unknown",
"nominalCode": "70600",
"currency": "GBP",
"balance": 0,
"availableBalance": 0,
"modifiedDate": "2022-09-30T10:29:16Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 56,
"_links": {
"current": {
"href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts"
},
"next": {
"href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Oracle NetSuite",
"example": {
"results": [
{
"id": "825",
"accountName": "Codat Europe Bank",
"accountType": "Debit",
"nominalCode": "111111122222111",
"currency": "GBP",
"balance": 558.22,
"modifiedDate": "2023-05-02T13:24:36Z",
"sourceModifiedDate": "2022-07-15T11:34:02",
"metadata": {
"isDeleted": false
}
},
{
"id": "826",
"accountName": "Codat Europe Bank USD",
"accountType": "Debit",
"nominalCode": "1133221133",
"currency": "USD",
"modifiedDate": "2023-05-02T13:24:36Z",
"sourceModifiedDate": "2021-03-26T10:31:40",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 4,
"_links": {
"current": {
"href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts"
},
"next": {
"href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "QuickBooks Desktop",
"example": {
"results": [
{
"id": "20000-933270541",
"accountName": "Checking",
"accountType": "Unknown",
"nominalCode": "10100",
"currency": "GBP",
"balance": 46954.1,
"availableBalance": 46954.1,
"modifiedDate": "2023-04-26T09:12:37Z",
"sourceModifiedDate": "2023-12-16T05:06:45",
"metadata": {
"isDeleted": false
}
},
{
"id": "550001-1071509830",
"accountName": "Petty Cash",
"accountType": "Unknown",
"nominalCode": "10400",
"currency": "GBP",
"balance": 500,
"availableBalance": 500,
"modifiedDate": "2023-04-26T09:12:37Z",
"sourceModifiedDate": "2023-12-16T05:06:45",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 3,
"_links": {
"current": {
"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts"
},
"next": {
"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "QuickBooks Online Sandbox",
"example": {
"results": [
{
"id": "164",
"accountName": "00",
"accountType": "Debit",
"nominalCode": "123567",
"currency": "GBP",
"balance": 0,
"availableBalance": 0,
"modifiedDate": "2023-04-26T09:35:57Z",
"sourceModifiedDate": "2022-07-20T14:11:28Z",
"metadata": {
"isDeleted": false
}
},
{
"id": "163",
"accountName": "11",
"accountType": "Debit",
"currency": "GBP",
"balance": 0,
"availableBalance": 0,
"modifiedDate": "2023-04-26T09:35:57Z",
"sourceModifiedDate": "2022-07-20T14:11:28Z",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 57,
"_links": {
"current": {
"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts"
},
"next": {
"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "QuickBooks Online",
"example": {
"results": [
{
"id": "202",
"accountName": "\\aa",
"accountType": "Debit",
"currency": "GBP",
"balance": 123,
"availableBalance": 123,
"modifiedDate": "2023-01-18T11:02:37Z",
"sourceModifiedDate": "2022-11-11T14:15:13Z"
},
{
"id": "193",
"accountName": "1 year ago",
"accountType": "Debit",
"currency": "GBP",
"balance": 5300.02,
"availableBalance": 5300.02,
"modifiedDate": "2023-01-18T11:02:37Z",
"sourceModifiedDate": "2023-01-18T06:05:12Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 140,
"_links": {
"current": {
"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts"
},
"next": {
"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Sage 50 (UK)",
"example": {
"results": [
{
"id": "1200",
"accountName": "Bank Current Account",
"accountType": "Unknown",
"nominalCode": "1200",
"sortCode": "23-34-34",
"accountNumber": "003234234",
"iBan": "",
"currency": "GBP",
"balance": -20091.04,
"availableBalance": -20091.04,
"modifiedDate": "2023-03-30T14:42:37Z",
"sourceModifiedDate": "2022-11-25T09:25:48",
"overdraftLimit": 120000,
"institution": "Lloyds Bank PLC",
"metadata": {
"isDeleted": false
}
},
{
"id": "1210",
"accountName": "Bank Deposit Account",
"accountType": "Unknown",
"nominalCode": "1210",
"sortCode": "45-45-45",
"accountNumber": "9/00474345",
"iBan": "",
"currency": "GBP",
"balance": 3510,
"availableBalance": 3510,
"modifiedDate": "2023-03-30T14:42:37Z",
"sourceModifiedDate": "2022-11-25T09:25:48",
"overdraftLimit": 0,
"institution": "Halifax Building Society",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 6,
"_links": {
"current": {
"href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts"
},
"next": {
"href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Sage Business Cloud Accounting",
"example": {
"results": [
{
"id": "154d05abe9f24c4babe0f6a741dec1b9",
"accountName": "Abdi Internet Bank",
"accountType": "Unknown",
"nominalCode": "1560",
"sortCode": "010101",
"accountNumber": "11111",
"currency": "GBP",
"balance": 49.61,
"availableBalance": 49.61,
"modifiedDate": "2022-10-24T14:52:53Z",
"sourceModifiedDate": "2020-01-27T10:53:26Z"
},
{
"id": "565ce07212bc492c8c2d04f43f9f67e3",
"accountName": "Abdi Live Test",
"accountType": "Unknown",
"nominalCode": "147852",
"sortCode": "123456",
"accountNumber": "1234567",
"currency": "GBP",
"balance": -225830.75,
"availableBalance": -225830.75,
"modifiedDate": "2022-10-24T14:52:53Z",
"sourceModifiedDate": "2020-01-28T14:00:20Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 45,
"_links": {
"current": {
"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts"
},
"next": {
"href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Sage Intacct",
"example": {
"results": [
{
"id": "CREDITCARD:55",
"accountName": "CoT Credit Card",
"accountType": "Credit",
"nominalCode": "10021",
"currency": "GBP",
"modifiedDate": "2023-04-04T16:31:46Z",
"sourceModifiedDate": "2023-03-27T14:11:48",
"metadata": {
"isDeleted": false
}
},
{
"id": "CREDITCARD:58",
"accountName": "Cot Credit Card 2",
"accountType": "Credit",
"nominalCode": "11112",
"currency": "GBP",
"modifiedDate": "2023-04-04T16:31:46Z",
"sourceModifiedDate": "2023-03-27T14:15:11",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 14,
"_links": {
"current": {
"href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts"
},
"next": {
"href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Xero",
"example": {
"results": [
{
"id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
"accountName": "Business Bank Account",
"accountType": "Debit",
"sortCode": "990404",
"accountNumber": "987654321",
"currency": "GBP",
"balance": 6681.79,
"modifiedDate": "2023-03-15T20:36:09Z",
"sourceModifiedDate": "2023-03-15T20:35:07",
"metadata": {
"isDeleted": false
}
},
{
"id": "a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba",
"accountName": "Business Savings Account",
"accountType": "Debit",
"sortCode": "890303",
"accountNumber": "876543210",
"currency": "GBP",
"balance": 0,
"modifiedDate": "2023-03-15T20:36:09Z",
"sourceModifiedDate": "2023-03-15T20:36:06",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 2,
"_links": {
"current": {
"href": "/companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Zoho Books",
"example": {
"results": [
{
"id": "104957000000060010",
"accountName": "Abdi Test",
"accountType": "Unknown",
"sortCode": "112233",
"accountNumber": "xxxx5678",
"currency": "GBP",
"balance": 69858.44,
"modifiedDate": "2022-10-03T08:40:38Z",
"institution": "Test Bank"
},
{
"id": "104957000000065002",
"accountName": "Abdi Test 2",
"accountType": "Unknown",
"sortCode": "",
"accountNumber": "",
"currency": "AED",
"balance": 98.03,
"modifiedDate": "2022-10-03T08:40:38Z",
"institution": ""
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 4,
"_links": {
"current": {
"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=1&pageSize=2"
},
"self": {
"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts"
},
"next": {
"href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=2&pageSize=2"
}
}
}
}
]
}