Codat List Accounting Account Transactions 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-account-transactions",
"method": "GET",
"path": "/companies/{companyId}/connections/{connectionId}/data/accountTransactions",
"summary": "List account transactions",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "Clear Books",
"example": {
"results": [
{
"id": "062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285",
"transactionId": "356deb9f-98e6-4d6f-8db3-b378241895a1",
"note": "Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197",
"bankAccountRef": {
"id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3",
"name": "Undeposited Funds"
},
"date": "2022-04-19T00:00:00",
"status": "Unreconciled",
"currency": "GBP",
"currencyRate": 1,
"lines": [
{
"description": "Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197",
"recordRef": {
"id": "38e8c917-0afc-4583-8ffe-1b53ad601197",
"dataType": "directIncomes"
},
"amount": 188.33
}
],
"totalAmount": 188.33,
"modifiedDate": "2023-04-26T12:38:18",
"sourceModifiedDate": "2022-05-13T01:06:00",
"metadata": {
"isDeleted": false
}
},
{
"id": "f2656119-9521-4d51-a24d-003b44c1410b",
"transactionId": "1fde4f8f-68ca-48fc-8fe7-79ac467d2946",
"note": "Direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8",
"bankAccountRef": {
"id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3",
"name": "Undeposited Funds"
},
"date": "2022-04-19T00:00:00",
"status": "Void",
"currency": "GBP",
"currencyRate": 1,
"lines": [
{
"description": "Payment for direct income $c31a3778-e3ea-4d01-9281-dd2f291c8cb8",
"recordRef": {
"id": "c31a3778-e3ea-4d01-9281-dd2f291c8cb8",
"dataType": "directIncomes"
},
"amount": 32095.91
}
],
"totalAmount": 32095.91,
"modifiedDate": "2023-04-26T12:38:18",
"sourceModifiedDate": "2023-02-13T00:34:00",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 1745,
"_links": {
"current": {
"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=1&pageSize=2"
},
"self": {
"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions"
},
"next": {
"href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "QuickBooks Desktop",
"example": {
"results": [
{
"id": "D7B-933784104",
"transactionId": "D7B-933784104",
"bankAccountRef": {
"id": "20000-933270541",
"name": "Checking"
},
"date": "2022-12-01T00:00:00",
"status": "Unknown",
"currency": "GBP",
"currencyRate": 1,
"lines": [
{
"recordRef": {
"id": "D7B-933784104",
"dataType": "directCosts"
},
"amount": -1200
}
],
"totalAmount": -1200,
"modifiedDate": "2023-04-26T09:13:23",
"sourceModifiedDate": "2023-12-16T05:04:10",
"metadata": {
"isDeleted": false
}
},
{
"id": "DFA-933785132",
"transactionId": "DFA-933785132",
"bankAccountRef": {
"id": "20000-933270541",
"name": "Checking"
},
"date": "2022-12-05T00:00:00",
"status": "Unknown",
"currency": "GBP",
"currencyRate": 1,
"lines": [
{
"recordRef": {
"id": "DFA-933785132",
"dataType": "directCosts"
},
"amount": -35
}
],
"totalAmount": -35,
"modifiedDate": "2023-04-26T09:13:23",
"sourceModifiedDate": "2023-12-16T05:04:11",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 652,
"_links": {
"current": {
"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=1&pageSize=2"
},
"self": {
"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions"
},
"next": {
"href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "QuickBooks Online Sandbox",
"example": {
"results": [
{
"id": "85",
"transactionId": "85",
"note": "Opening Balance from Bank",
"bankAccountRef": {
"id": "57",
"name": "Visa Credit Card"
},
"date": "2015-08-12T00:00:00",
"status": "Unknown",
"currency": "GBP",
"currencyRate": 1,
"lines": [
{
"description": "Opening Balance from Bank",
"recordRef": {
"id": "PUR-85",
"dataType": "directCosts"
},
"amount": -3831.8
}
],
"totalAmount": -3831.8,
"modifiedDate": "2023-04-26T09:37:16",
"sourceModifiedDate": "2016-09-12T18:13:07Z",
"metadata": {
"isDeleted": false
}
},
{
"id": "5",
"transactionId": "5",
"bankAccountRef": {
"id": "81",
"name": "Current"
},
"date": "2015-11-24T00:00:00",
"status": "Unknown",
"currency": "GBP",
"currencyRate": 1,
"lines": [
{
"description": "contribution to start business",
"recordRef": {
"id": "5-1",
"dataType": "directIncomes"
},
"amount": 10000
},
{
"description": "funds borrowed to start business",
"recordRef": {
"id": "5-2",
"dataType": "directIncomes"
},
"amount": 25000
}
],
"totalAmount": 35000,
"modifiedDate": "2023-04-26T09:37:17",
"sourceModifiedDate": "2016-09-12T15:26:26Z",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 9141,
"_links": {
"current": {
"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=1&pageSize=2"
},
"self": {
"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions"
},
"next": {
"href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "QuickBooks Online",
"example": {
"results": [
{
"id": "1",
"transactionId": "1",
"note": "Opening Balance from Bank",
"bankAccountRef": {
"id": "61",
"name": "Dave PP Current"
},
"date": "2018-09-21T00:00:00",
"status": "Unknown",
"currency": "GBP",
"currencyRate": 1,
"lines": [
{
"recordRef": {
"id": "1",
"dataType": "directIncomes"
},
"amount": 170.23
}
],
"totalAmount": 170.23,
"modifiedDate": "2023-01-18T11:03:12",
"sourceModifiedDate": "2018-12-17T14:56:20Z"
},
{
"id": "15",
"transactionId": "15",
"note": "Payment to Google",
"bankAccountRef": {
"id": "61",
"name": "Dave PP Current"
},
"date": "2018-09-21T00:00:00",
"status": "Unknown",
"currency": "GBP",
"currencyRate": 1,
"lines": [
{
"description": "Payment to Google",
"recordRef": {
"id": "PUR-15",
"dataType": "directCosts"
},
"amount": -1.59
}
],
"totalAmount": -1.59,
"modifiedDate": "2023-01-18T11:03:11",
"sourceModifiedDate": "2018-12-17T14:56:44Z"
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 5984,
"_links": {
"current": {
"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=1&pageSize=2"
},
"self": {
"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions"
},
"next": {
"href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=2&pageSize=2"
}
}
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Xero",
"example": {
"results": [
{
"id": "74004690-82a1-4810-aaca-6ce575af94b4",
"transactionId": "74004690-82a1-4810-aaca-6ce575af94b4",
"bankAccountRef": {
"id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
"name": "Business Bank Account"
},
"date": "2021-12-20T00:00:00",
"status": "Reconciled",
"currency": "GBP",
"currencyRate": 1,
"lines": [
{
"recordRef": {
"id": "74004690-82a1-4810-aaca-6ce575af94b4",
"dataType": "billPayments"
},
"amount": -7267.2
}
],
"totalAmount": -7267.2,
"modifiedDate": "2023-03-15T20:37:10",
"sourceModifiedDate": "2021-01-02T22:51:40",
"metadata": {
"isDeleted": false
}
},
{
"id": "65b746c8-9a5d-4a95-8096-d2316fcff592",
"transactionId": "65b746c8-9a5d-4a95-8096-d2316fcff592",
"bankAccountRef": {
"id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4",
"name": "Business Bank Account"
},
"date": "2022-02-17T00:00:00",
"status": "Reconciled",
"currency": "GBP",
"currencyRate": 1,
"lines": [
{
"recordRef": {
"id": "65b746c8-9a5d-4a95-8096-d2316fcff592",
"dataType": "payments"
},
"amount": 4200
}
],
"totalAmount": 4200,
"modifiedDate": "2023-03-15T20:37:10",
"sourceModifiedDate": "2021-01-02T22:50:58",
"metadata": {
"isDeleted": false
}
}
],
"pageNumber": 1,
"pageSize": 2,
"totalResults": 70,
"_links": {
"current": {
"href": "/companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=1&pageSize=2"
},
"self": {
"href": "/companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions"
},
"next": {
"href": "/companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=2&pageSize=2"
}
}
}
}
]
}