{ "openapi": "3.1.0", "servers": [ { "description": "Production", "url": "https://api.codat.io" } ], "info": { "title": "Accounting API", "version": "3.0.0", "contact": { "email": "support@codat.io", "name": "Codat" }, "description": "> ### New to Codat?\n>\n> Our Accounting API reference is relevant only to our existing clients.\n> Please reach out to your Codat contact so that we can find the right product for you.\n\nA flexible API for pulling accounting data, normalized and aggregated from 20 accounting integrations.\n\nStandardize how you connect to your customers’ accounting software. View, create, update, and delete data in the same way for all the leading accounting software.\n\n\n## Endpoints\n\n| Endpoints | Description |\n| :- |:- |\n| Accounts | Access standardized Accounts from linked accounting software. |\n| Account transactions | Access standardized Account transactions from linked accounting software. |\n| Bank accounts | Access standardized Bank accounts from linked accounting software. |\n| Bank account transactions | Access standardized Bank transactions for bank accounts from linked accounting software. |\n| Bills | Access standardized Bills from linked accounting software. |\n| Bill credit notes | Access standardized Bill credit notes from linked accounting software. |\n| Bill payments | Access standardized Bill payments from linked accounting software. |\n| Credit notes | Access standardized Credit notes from linked accounting software. |\n| Customers | Access standardized Customers from linked accounting software. |\n| Direct costs | Access standardized Direct costs from linked accounting software. |\n| Direct incomes | Access standardized Direct incomes from linked accounting software. |\n| Company info | Access standardized Company info from linked accounting software. |\n| Invoices | Access standardized Invoices from linked accounting software. |\n| Item receipts | Access standardized Item receipts from linked accounting software. |\n| Items | Access standardized Items from linked accounting software. |\n| Journals | Access standardized Journals from linked accounting software. |\n| Journal entries | Access standardized Journal entries from linked accounting software. |\n| Payments | Access standardized Payments from linked accounting software. |\n| Payment methods | Access standardized Payment methods from linked accounting software. |\n| Purchase orders | Access standardized Purchase orders from linked accounting software. |\n| Sales orders | Access standardized Sales orders from linked accounting software. |\n| Suppliers | Access standardized Suppliers from linked accounting software. |\n| Tax rates | Access standardized Tax rates from linked accounting software. |\n| Tracking categories | Access standardized Tracking categories from linked accounting software. |\n| Transfers | Access standardized Transfers from linked accounting software. |\n| Reports | Access standardized Reports from linked accounting software. |\n\n\n[Read more...](https://docs.codat.io/accounting-api/overview)\n\n[See our OpenAPI spec](https://github.com/codatio/oas)", "termsOfService": "https://www.codat.io/legals/" }, "security": [ { "auth_header": [] } ], "x-speakeasy-retries": { "strategy": "backoff", "backoff": { "initialInterval": 500, "maxInterval": 60000, "maxElapsedTime": 3600000, "exponent": 1.5 }, "statusCodes": [ 408, 429, "5XX" ], "retryConnectionErrors": true }, "x-speakeasy-name-override": [ { "operationId": "^list-.*?", "methodNameOverride": "list" }, { "operationId": "^list-.*?-attachments", "methodNameOverride": "list-attachments" }, { "operationId": "^get-.*?", "methodNameOverride": "get" }, { "operationId": "^get-create-.*?-model", "methodNameOverride": "get-create-model" }, { "operationId": "^get-create-update.*?-model", "methodNameOverride": "get-create-update-model" }, { "operationId": "^get-.*?-attachment", "methodNameOverride": "get-attachment" }, { "operationId": "^update-.*?", "methodNameOverride": "update" }, { "operationId": "^create-.*?", "methodNameOverride": "create" }, { "operationId": "^delete-.*?", "methodNameOverride": "delete" }, { "operationId": "^delete-.*?-attachment", "methodNameOverride": "delete-attachment" }, { "operationId": "^download-.*?-attachment", "methodNameOverride": "download-attachment" }, { "operationId": "^upload-.*?-attachment", "methodNameOverride": "upload-attachment" } ], "x-codat-docs-path": "codat-api", "x-codat-speakeasy-pagination": { "type": "offsetLimit", "inputs": [ { "name": "page", "in": "parameters", "type": "page" } ], "outputs": { "results": "$.results" } }, "tags": [ { "name": "Accounts", "description": "Access standardized Accounts from linked accounting software." }, { "name": "Account transactions", "description": "Access standardized Account transactions from linked accounting software." }, { "name": "Bank accounts", "description": "Access standardized Bank accounts from linked accounting software." }, { "name": "Bank account transactions", "description": "Access standardized Bank transactions for bank accounts from linked accounting software." }, { "name": "Bills", "description": "Access standardized Bills from linked accounting software." }, { "name": "Bill credit notes", "description": "Access standardized Bill credit notes from linked accounting software." }, { "name": "Bill payments", "description": "Access standardized Bill payments from linked accounting software." }, { "name": "Credit notes", "description": "Access standardized Credit notes from linked accounting software." }, { "name": "Customers", "description": "Access standardized Customers from linked accounting software." }, { "name": "Direct costs", "description": "Access standardized Direct costs from linked accounting software." }, { "name": "Direct incomes", "description": "Access standardized Direct incomes from linked accounting software." }, { "name": "Company info", "description": "Access standardized Company info from linked accounting software." }, { "name": "Invoices", "description": "Access standardized Invoices from linked accounting software." }, { "name": "Item receipts", "description": "Access standardized Item receipts from linked accounting software." }, { "name": "Items", "description": "Access standardized Items from linked accounting software." }, { "name": "Journals", "description": "Access standardized Journals from linked accounting software." }, { "name": "Journal entries", "description": "Access standardized Journal entries from linked accounting software." }, { "name": "Payments", "description": "Access standardized Payments from linked accounting software." }, { "name": "Payment methods", "description": "Access standardized Payment methods from linked accounting software." }, { "name": "Purchase orders", "description": "Access standardized Purchase orders from linked accounting software." }, { "name": "Sales orders", "description": "Access standardized Sales orders from linked accounting software." }, { "name": "Suppliers", "description": "Access standardized Suppliers from linked accounting software." }, { "name": "Tax rates", "description": "Access standardized Tax rates from linked accounting software." }, { "name": "Tracking categories", "description": "Access standardized Tracking categories from linked accounting software." }, { "name": "Transfers", "description": "Access standardized Transfers from linked accounting software." }, { "name": "Reports", "description": "Access standardized Reports from linked accounting software." } ], "paths": { "/companies/{companyId}/connections/{connectionId}/data/accountTransactions": { "get": { "summary": "List account transactions", "description": "The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) for a given company's connection.\n\n[Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-account-transactions", "tags": [ "Account transactions" ], "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountTransactions" }, "examples": { "Clear Books": { "value": { "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" } } } }, "QuickBooks Desktop": { "value": { "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" } } } }, "QuickBooks Online Sandbox": { "value": { "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" } } } }, "QuickBooks Online": { "value": { "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" } } } }, "Xero": { "value": { "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" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId}": { "get": { "tags": [ "Account transactions" ], "summary": "Get account transaction", "operationId": "get-account-transaction", "description": "The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId.\n\n[Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=accountTransactions) for integrations that support getting a specific account transaction.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "name": "accountTransactionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for an account transaction." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountTransaction" }, "examples": { "Clear Books": { "value": { "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 } } }, "QuickBooks Desktop": { "value": { "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 } } }, "QuickBooks Online Sandbox": { "value": { "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 } } }, "QuickBooks Online": { "value": { "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" } }, "Xero": { "value": { "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 } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/data/accounts": { "get": { "tags": [ "Accounts" ], "summary": "List accounts", "description": "The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).", "operationId": "list-accounts", "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "x-speakeasy-usage-example": true, "schema": { "$ref": "#/components/schemas/Accounts" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "1b6266d1-1e44-46c5-8eb5-a8f98e03124e", "nominalCode": "610", "name": "Accounts Receivable", "description": "Invoices the business has issued but has not yet collected payment on.", "fullyQualifiedCategory": "Asset.Current", "fullyQualifiedName": "Asset.Current.Accounts Receivable", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T12:38:15Z", "sourceModifiedDate": "2022-12-10T16:39:00", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "76d5f23b-9623-4e3b-89cd-da57228764d3", "nominalCode": "611", "name": "Accounts Receivable", "description": "A provision anticipating that a portion of accounts receivable will never be collected.", "fullyQualifiedCategory": "Asset.Current", "fullyQualifiedName": "Asset.Current.Accounts Receivable", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T12:38:15Z", "sourceModifiedDate": "2022-10-19T05:49:00", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 98, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "8eaed16d-c69f-ec11-80f1-0022481b4546", "nominalCode": "45422026-68CA-4EF2-9", "name": "", "fullyQualifiedCategory": " .", "fullyQualifiedName": "..", "currency": "GBP", "currentBalance": 0, "type": "Unknown", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-27T14:21:18Z", "sourceModifiedDate": "2022-03-09T16:31:54Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "DirectCost.LineItems.AccountRef.Id" ] } ], "metadata": { "isDeleted": false } }, { "id": "c0861a65-c69f-ec11-80f1-0022481b4546", "nominalCode": "10", "name": "Account no cat Balance Sheet", "fullyQualifiedCategory": " .", "fullyQualifiedName": "..Account no cat Balance Sheet", "currency": "GBP", "currentBalance": 27.34, "type": "Unknown", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-27T14:21:18Z", "sourceModifiedDate": "2022-09-13T14:45:01Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "DirectCost.LineItems.AccountRef.Id" ] } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 122, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "ef2fde36-4416-4bc5-b239-315b2929348c", "nominalCode": "1300", "name": "Debiteuren", "description": "Debiteuren", "fullyQualifiedCategory": "Asset.Assets.AccountsReceivable", "fullyQualifiedName": "Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled", "currency": "EUR", "currentBalance": 864435.44, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-26T13:36:17Z", "sourceModifiedDate": "2020-01-08T09:42:54Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Transfer.To.AccountRef.Id", "Transfer.From.AccountRef.Id", "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] }, { "id": "2052b65b-20e9-4da1-85d8-fd5ca0ea3d38", "nominalCode": "888777888", "name": "One more AR account", "description": "One more AR account", "fullyQualifiedCategory": "Asset.Assets.AccountsReceivable", "fullyQualifiedName": "Asset.Assets.AccountsReceivable.One more AR account.PaymentsEnabled", "currency": "EUR", "currentBalance": 2174.82, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-26T13:36:17Z", "sourceModifiedDate": "2021-06-10T11:00:20Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Transfer.To.AccountRef.Id", "Transfer.From.AccountRef.Id", "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 230, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40", "nominalCode": "THING", "name": "Some thing account", "description": "Some thing account", "fullyQualifiedCategory": "Asset.Assets.AccountsReceivable", "fullyQualifiedName": "Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-26T13:35:15Z", "sourceModifiedDate": "2017-08-01T17:31:12Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Transfer.To.AccountRef.Id", "Transfer.From.AccountRef.Id", "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] }, { "id": "cf9572e7-8afa-4339-9113-af32a66d9df9", "nominalCode": "15400", "name": "Trade Debtors", "description": "Trade Debtors", "fullyQualifiedCategory": "Asset.Assets.AccountsReceivable", "fullyQualifiedName": "Asset.Assets.AccountsReceivable.Trade Debtors.PaymentsEnabled", "currency": "GBP", "currentBalance": 4484655.39, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-26T13:35:15Z", "sourceModifiedDate": "2020-01-08T13:48:38Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Transfer.To.AccountRef.Id", "Transfer.From.AccountRef.Id", "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 121, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "601", "nominalCode": "601", "name": "Capital Asset Brought Forward", "fullyQualifiedCategory": "Asset.Capital", "fullyQualifiedName": "Asset.Capital.Capital Asset Brought Forward", "currency": "GBP", "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-25T14:19:12Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "605", "nominalCode": "605", "name": "Capital Asset Depreciation Brought Forward", "fullyQualifiedCategory": "Asset.Capital", "fullyQualifiedName": "Asset.Capital.Capital Asset Depreciation Brought Forward", "currency": "GBP", "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-25T14:19:12Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 292, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "67357", "nominalCode": "1200", "name": "Accounts Receivable", "fullyQualifiedCategory": "Asset", "fullyQualifiedName": "Asset.Accounts Receivable", "currency": "GBP", "currentBalance": 51445.53, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-24T16:07:24Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "128611", "nominalCode": "1200-1", "name": "Accounts Receivable", "fullyQualifiedCategory": "Asset.Accounts Receivable", "fullyQualifiedName": "Asset.Accounts Receivable.Accounts Receivable", "currency": "GBP", "currentBalance": 51445.53, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-24T16:07:24Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 96, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=2&pageSize=2" } } } }, "KashFlow": { "value": { "results": [ { "id": "27840056", "nominalCode": "70700", "name": "16th Account", "fullyQualifiedCategory": "Asset.BankAccount", "fullyQualifiedName": "Asset.BankAccount.16th Account", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-09-30T10:29:16Z", "validDatatypeLinks": [] }, { "id": "27840049", "nominalCode": "70600", "name": "1a1a", "fullyQualifiedCategory": "Asset.BankAccount", "fullyQualifiedName": "Asset.BankAccount.1a1a", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-09-30T10:29:16Z", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 157, "_links": { "current": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts" }, "next": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "111", "name": "Accounts Payable", "fullyQualifiedCategory": "AcctPay.AcctPay", "fullyQualifiedName": "AcctPay.AcctPay.Accounts Payable", "currentBalance": -635.55, "type": "Liability", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-01-30T14:48:33Z", "sourceModifiedDate": "2021-08-11T12:51:21", "validDatatypeLinks": [] }, { "id": "119", "name": "Accounts Receivable", "fullyQualifiedCategory": "AcctRec.AcctRec", "fullyQualifiedName": "AcctRec.AcctRec.Accounts Receivable", "currentBalance": -565, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-01-30T14:48:33Z", "sourceModifiedDate": "2021-09-08T15:23:31", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 44, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts" }, "next": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "40000-933270541", "nominalCode": "11000", "name": "Accounts Receivable", "description": "Accounts Receivable", "fullyQualifiedCategory": "Asset.CurrentAsset.AccountsReceivable", "fullyQualifiedName": "Asset.CurrentAsset.AccountsReceivable.Accounts Receivable", "currency": "GBP", "currentBalance": 93007.93, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T09:06:23Z", "sourceModifiedDate": "2023-12-16T05:06:45", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "20000-933270541", "nominalCode": "10100", "name": "Checking", "description": "Cash", "fullyQualifiedCategory": "Asset.CurrentAsset.Bank", "fullyQualifiedName": "Asset.CurrentAsset.Bank.Checking", "currency": "GBP", "currentBalance": 46954.1, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2023-04-26T09:06:23Z", "sourceModifiedDate": "2023-12-16T05:06:45", "validDatatypeLinks": [ { "property": "Id", "links": [ "BillLineItem.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 116, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "62", "nominalCode": "246", "name": "Debtors", "fullyQualifiedCategory": "Asset.Accounts Receivable.AccountsReceivable", "fullyQualifiedName": "Asset.Accounts Receivable.AccountsReceivable.Debtors", "currency": "GBP", "currentBalance": 41289.37, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-01-18T11:02:34Z", "sourceModifiedDate": "2022-12-08T15:42:59Z", "validDatatypeLinks": [] }, { "id": "92", "nominalCode": "247", "name": "Debtors - AED", "fullyQualifiedCategory": "Asset.Accounts Receivable.AccountsReceivable", "fullyQualifiedName": "Asset.Accounts Receivable.AccountsReceivable.Debtors - AED", "currency": "AED", "currentBalance": -1533.44, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-01-18T11:02:34Z", "sourceModifiedDate": "2021-02-19T14:04:45Z", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 234, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "70", "name": "Debtors", "fullyQualifiedCategory": "Asset.Accounts Receivable.AccountsReceivable", "fullyQualifiedName": "Asset.Accounts Receivable.AccountsReceivable.Debtors", "currency": "GBP", "currentBalance": 3041173.77, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T09:35:55Z", "sourceModifiedDate": "2023-04-26T01:18:15Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "80", "name": "Debtors - USD", "fullyQualifiedCategory": "Asset.Accounts Receivable.AccountsReceivable", "fullyQualifiedName": "Asset.Accounts Receivable.AccountsReceivable.Debtors - USD", "currency": "USD", "currentBalance": 54822.37, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T09:35:55Z", "sourceModifiedDate": "2023-04-12T15:10:38Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 186, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "2864", "nominalCode": "1200", "name": "Bank Account", "description": "Bank Account", "fullyQualifiedCategory": "Asset.Bank Account", "fullyQualifiedName": "Asset.Bank Account.Bank Account", "type": "Asset", "status": "Archived", "isBankAccount": false, "modifiedDate": "2022-10-14T09:35:52Z", "validDatatypeLinks": [], "metadata": { "isDeleted": true } }, { "id": "2368", "nominalCode": "1200", "name": "Bank Current Account", "description": "Bank Current Account", "fullyQualifiedCategory": "Asset.Bank Account", "fullyQualifiedName": "Asset.Bank Account.Bank Current Account", "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-10-14T09:35:52Z", "sourceModifiedDate": "2020-09-11T13:53:12Z", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 344, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "1100", "nominalCode": "1100", "name": "Debtors Control Account", "fullyQualifiedCategory": "Asset.CurrentAssets.Debtors", "fullyQualifiedName": "Asset.CurrentAssets.Debtors.Debtors Control Account", "currency": "GBP", "currentBalance": 90640.61, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "1102", "nominalCode": "1102", "name": "Other Debtors", "fullyQualifiedCategory": "Asset.CurrentAssets.Debtors", "fullyQualifiedName": "Asset.CurrentAssets.Debtors.Other Debtors", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 155, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "e5889b459f544926ac5b8e6756df2ad4", "nominalCode": "1560", "name": "Abdi Internet Bank", "fullyQualifiedCategory": "Asset.Bank", "fullyQualifiedName": "Asset.Bank.Abdi Internet Bank", "currency": "GBP", "currentBalance": 49.61, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-10-24T14:52:53Z", "sourceModifiedDate": "2020-01-27T10:53:26Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] }, { "id": "b17083bc9b2748b4ab321b024e260eda", "nominalCode": "147852", "name": "Abdi Live Test", "fullyQualifiedCategory": "Asset.Bank", "fullyQualifiedName": "Asset.Bank.Abdi Live Test", "currency": "GBP", "currentBalance": 225830.75, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-10-24T14:52:53Z", "sourceModifiedDate": "2020-01-28T14:00:20Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 283, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "2", "nominalCode": "12100", "name": "Accounts Receivable", "fullyQualifiedCategory": "Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable", "fullyQualifiedName": "Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.Accounts Receivable", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-04T16:31:51Z", "sourceModifiedDate": "2020-01-29T01:42:43", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "155", "nominalCode": "12710", "name": "AR - Retainage", "fullyQualifiedCategory": "Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable", "fullyQualifiedName": "Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.AR - Retainage", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-04T16:31:51Z", "sourceModifiedDate": "2020-10-15T15:33:15", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 181, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts" }, "next": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts?page=2&pageSize=2" } } } }, "Wave": { "value": { "results": [ { "id": "QWNjb3VudDo5MjIzNDE3NjkzMzk3NjA2MzM7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2", "name": "Abdi Bank", "description": "Test Balance Sheet", "fullyQualifiedCategory": "Asset.CashAndBank", "fullyQualifiedName": "Asset.CashAndBank.Abdi Bank", "currency": "GBP", "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-11-16T18:15:17Z", "validDatatypeLinks": [] }, { "id": "QWNjb3VudDo3OTE3NTA1OTcwOTQxNzQ3MTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2", "name": "Cash on Hand", "description": "Cash you haven�t deposited in the bank. Add your bank and credit card accounts to accurately categorize transactions that aren't cash.", "fullyQualifiedCategory": "Asset.CashAndBank", "fullyQualifiedName": "Asset.CashAndBank.Cash on Hand", "currency": "GBP", "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-11-16T18:15:17Z", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 85, "_links": { "current": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts" }, "next": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "nominalCode": "A090", "name": "Business Bank Account", "fullyQualifiedCategory": "Asset.Bank", "fullyQualifiedName": "Asset.Bank.Business Bank Account", "currency": "GBP", "currentBalance": 924.25, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2023-03-15T20:35:08Z", "sourceModifiedDate": "2023-02-17T11:10:49", "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id", "DirectIncome.LineItems.AccountRef.Id", "DirectCost.LineItems.AccountRef.Id" ] } ], "metadata": { "isDeleted": false } }, { "id": "a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba", "nominalCode": "A091", "name": "Business Savings Account", "fullyQualifiedCategory": "Asset.Bank", "fullyQualifiedName": "Asset.Bank.Business Savings Account", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2023-03-15T20:35:08Z", "sourceModifiedDate": "2023-02-17T11:10:49", "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id", "DirectIncome.LineItems.AccountRef.Id", "DirectCost.LineItems.AccountRef.Id" ] } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 90, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/accounts" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/accounts?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000000352", "nominalCode": "", "name": "Accounts Receivable", "description": "The money that customers owe you becomes the accounts receivable. A good example of this is a payment expected from an invoice sent to your customer.", "fullyQualifiedCategory": "Asset.accounts_receivable", "fullyQualifiedName": "Asset.accounts_receivable.Accounts Receivable", "currency": "GBP", "currentBalance": -959.64, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-03T08:40:43Z", "sourceModifiedDate": "2020-02-05T14:58:44", "validDatatypeLinks": [] }, { "id": "104957000000060010", "nominalCode": "", "name": "Abdi Test", "description": "", "fullyQualifiedCategory": "Asset.bank", "fullyQualifiedName": "Asset.bank.Abdi Test", "currency": "GBP", "currentBalance": 69858.44, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-10-03T08:40:43Z", "sourceModifiedDate": "2020-02-17T12:19:47", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 68, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/data/accounts/{accountId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/accountId" } ], "get": { "tags": [ "Accounts" ], "summary": "Get account", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "examples": { "Clear Books": { "value": { "id": "1b6266d1-1e44-46c5-8eb5-a8f98e03124e", "nominalCode": "610", "name": "Accounts Receivable", "description": "Invoices the business has issued but has not yet collected payment on.", "fullyQualifiedCategory": "Asset.Current", "fullyQualifiedName": "Asset.Current.Accounts Receivable", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T12:38:15Z", "sourceModifiedDate": "2022-12-10T16:39:00", "validDatatypeLinks": [] } }, "Dynamics 365 Business Central": { "value": { "id": "8eaed16d-c69f-ec11-80f1-0022481b4546", "nominalCode": "45422026-68CA-4EF2-9", "name": "", "fullyQualifiedCategory": " .", "fullyQualifiedName": "..", "currency": "GBP", "currentBalance": 0, "type": "Unknown", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-27T14:21:18Z", "sourceModifiedDate": "2022-03-09T16:31:54Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "DirectCost.LineItems.AccountRef.Id" ] } ] } }, "Exact (Netherlands)": { "value": { "id": "ef2fde36-4416-4bc5-b239-315b2929348c", "nominalCode": "1300", "name": "Debiteuren", "description": "Debiteuren", "fullyQualifiedCategory": "Asset.Assets.AccountsReceivable", "fullyQualifiedName": "Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled", "currency": "EUR", "currentBalance": 864435.44, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-26T13:36:17Z", "sourceModifiedDate": "2020-01-08T09:42:54Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Transfer.To.AccountRef.Id", "Transfer.From.AccountRef.Id", "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] } }, "Exact (UK)": { "value": { "id": "ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40", "nominalCode": "THING", "name": "Some thing account", "description": "Some thing account", "fullyQualifiedCategory": "Asset.Assets.AccountsReceivable", "fullyQualifiedName": "Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-26T13:35:15Z", "sourceModifiedDate": "2017-08-01T17:31:12Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Transfer.To.AccountRef.Id", "Transfer.From.AccountRef.Id", "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] } }, "FreeAgent": { "value": { "id": "601", "nominalCode": "601", "name": "Capital Asset Brought Forward", "fullyQualifiedCategory": "Asset.Capital", "fullyQualifiedName": "Asset.Capital.Capital Asset Brought Forward", "currency": "GBP", "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-25T14:19:12Z", "validDatatypeLinks": [] } }, "FreshBooks": { "value": { "id": "67357", "nominalCode": "1200", "name": "Accounts Receivable", "fullyQualifiedCategory": "Asset", "fullyQualifiedName": "Asset.Accounts Receivable", "currency": "GBP", "currentBalance": 51445.53, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-24T16:07:24Z", "validDatatypeLinks": [] } }, "KashFlow": { "value": { "id": "27840056", "nominalCode": "70700", "name": "16th Account", "fullyQualifiedCategory": "Asset.BankAccount", "fullyQualifiedName": "Asset.BankAccount.16th Account", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-09-30T10:29:16Z", "validDatatypeLinks": [] } }, "Oracle NetSuite": { "value": { "id": "111", "name": "Accounts Payable", "fullyQualifiedCategory": "AcctPay.AcctPay", "fullyQualifiedName": "AcctPay.AcctPay.Accounts Payable", "currentBalance": -635.55, "type": "Liability", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-01-30T14:48:33Z", "sourceModifiedDate": "2021-08-11T12:51:21", "validDatatypeLinks": [] } }, "QuickBooks Desktop": { "value": { "id": "40000-933270541", "nominalCode": "11000", "name": "Accounts Receivable", "description": "Accounts Receivable", "fullyQualifiedCategory": "Asset.CurrentAsset.AccountsReceivable", "fullyQualifiedName": "Asset.CurrentAsset.AccountsReceivable.Accounts Receivable", "currency": "GBP", "currentBalance": 93007.93, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T09:06:23Z", "sourceModifiedDate": "2023-12-16T05:06:45", "validDatatypeLinks": [] } }, "QuickBooks Online": { "value": { "id": "62", "nominalCode": "246", "name": "Debtors", "fullyQualifiedCategory": "Asset.Accounts Receivable.AccountsReceivable", "fullyQualifiedName": "Asset.Accounts Receivable.AccountsReceivable.Debtors", "currency": "GBP", "currentBalance": 41289.37, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-01-18T11:02:34Z", "sourceModifiedDate": "2022-12-08T15:42:59Z", "validDatatypeLinks": [] } }, "QuickBooks Online Sandbox": { "value": { "id": "70", "name": "Debtors", "fullyQualifiedCategory": "Asset.Accounts Receivable.AccountsReceivable", "fullyQualifiedName": "Asset.Accounts Receivable.AccountsReceivable.Debtors", "currency": "GBP", "currentBalance": 3041173.77, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-26T09:35:55Z", "sourceModifiedDate": "2023-04-26T01:18:15Z", "validDatatypeLinks": [] } }, "Sage 200cloud": { "value": { "id": "2864", "nominalCode": "1200", "name": "Bank Account", "description": "Bank Account", "fullyQualifiedCategory": "Asset.Bank Account", "fullyQualifiedName": "Asset.Bank Account.Bank Account", "type": "Asset", "status": "Archived", "isBankAccount": false, "modifiedDate": "2022-10-14T09:35:52Z", "validDatatypeLinks": [] } }, "Sage 50 (UK)": { "value": { "id": "1100", "nominalCode": "1100", "name": "Debtors Control Account", "fullyQualifiedCategory": "Asset.CurrentAssets.Debtors", "fullyQualifiedName": "Asset.CurrentAssets.Debtors.Debtors Control Account", "currency": "GBP", "currentBalance": 90640.61, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54", "validDatatypeLinks": [] } }, "Sage Business Cloud Accounting": { "value": { "id": "e5889b459f544926ac5b8e6756df2ad4", "nominalCode": "1560", "name": "Abdi Internet Bank", "fullyQualifiedCategory": "Asset.Bank", "fullyQualifiedName": "Asset.Bank.Abdi Internet Bank", "currency": "GBP", "currentBalance": 49.61, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-10-24T14:52:53Z", "sourceModifiedDate": "2020-01-27T10:53:26Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id" ] } ] } }, "Sage Intacct": { "value": { "id": "2", "nominalCode": "12100", "name": "Accounts Receivable", "fullyQualifiedCategory": "Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable", "fullyQualifiedName": "Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.Accounts Receivable", "currency": "GBP", "currentBalance": 0, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2023-04-04T16:31:51Z", "sourceModifiedDate": "2020-01-29T01:42:43", "validDatatypeLinks": [] } }, "Wave": { "value": { "id": "QWNjb3VudDo5MjIzNDE3NjkzMzk3NjA2MzM7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2", "name": "Abdi Bank", "description": "Test Balance Sheet", "fullyQualifiedCategory": "Asset.CashAndBank", "fullyQualifiedName": "Asset.CashAndBank.Abdi Bank", "currency": "GBP", "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2022-11-16T18:15:17Z", "validDatatypeLinks": [] } }, "Xero": { "value": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "nominalCode": "A090", "name": "Business Bank Account", "fullyQualifiedCategory": "Asset.Bank", "fullyQualifiedName": "Asset.Bank.Business Bank Account", "currency": "GBP", "currentBalance": 924.25, "type": "Asset", "status": "Active", "isBankAccount": true, "modifiedDate": "2023-03-15T20:35:08Z", "sourceModifiedDate": "2023-02-17T11:10:49", "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id", "DirectIncome.LineItems.AccountRef.Id", "DirectCost.LineItems.AccountRef.Id" ] } ] } }, "Zoho Books": { "value": { "id": "104957000000000352", "nominalCode": "", "name": "Accounts Receivable", "description": "The money that customers owe you becomes the accounts receivable. A good example of this is a payment expected from an invoice sent to your customer.", "fullyQualifiedCategory": "Asset.accounts_receivable", "fullyQualifiedName": "Asset.accounts_receivable.Accounts Receivable", "currency": "GBP", "currentBalance": -959.64, "type": "Asset", "status": "Active", "isBankAccount": false, "modifiedDate": "2022-10-03T08:40:43Z", "sourceModifiedDate": "2020-02-05T14:58:44", "validDatatypeLinks": [] } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get account* endpoint returns a single account for a given accountId.\n\n[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support getting a specific account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-account" } }, "/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create account model", "tags": [ "Accounts" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Exact (Netherlands)": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [], "information": [ { "field": "NominalCode", "details": "Must be provided." } ] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "Name", "details": "Must be provided." } ] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "Asset.Assets.Cash", "type": "String", "displayName": "Asset.Assets.Cash", "required": false }, { "value": "Asset.Assets.Bank", "type": "String", "displayName": "Asset.Assets.Bank", "required": false }, { "value": "Asset.Assets.PaymentServices", "type": "String", "displayName": "Asset.Assets.PaymentServices", "required": false }, { "value": "Asset.Assets.AccountsReceivable", "type": "String", "displayName": "Asset.Assets.AccountsReceivable", "required": false }, { "value": "Liability.EquityAndLiabilities.AccountsPayable", "type": "String", "displayName": "Liability.EquityAndLiabilities.AccountsPayable", "required": false }, { "value": "Asset.Assets.VAT", "type": "String", "displayName": "Asset.Assets.VAT", "required": false }, { "value": "Liability.EquityAndLiabilities.EmployeesPayable", "type": "String", "displayName": "Liability.EquityAndLiabilities.EmployeesPayable", "required": false }, { "value": "Asset.Assets.PrepaidExpenses", "type": "String", "displayName": "Asset.Assets.PrepaidExpenses", "required": false }, { "value": "Liability.EquityAndLiabilities.AccruedExpenses", "type": "String", "displayName": "Liability.EquityAndLiabilities.AccruedExpenses", "required": false }, { "value": "Liability.EquityAndLiabilities.IncomeTaxesPayable", "type": "String", "displayName": "Liability.EquityAndLiabilities.IncomeTaxesPayable", "required": false }, { "value": "Asset.Assets.FixedAssets", "type": "String", "displayName": "Asset.Assets.FixedAssets", "required": false }, { "value": "Asset.Assets.OtherAssets", "type": "String", "displayName": "Asset.Assets.OtherAssets", "required": false }, { "value": "Asset.Assets.AccumulatedDeprecation", "type": "String", "displayName": "Asset.Assets.AccumulatedDeprecation", "required": false }, { "value": "Asset.Assets.Inventory", "type": "String", "displayName": "Asset.Assets.Inventory", "required": false }, { "value": "Equity.EquityAndLiabilities.CapitalStock", "type": "String", "displayName": "Equity.EquityAndLiabilities.CapitalStock", "required": false }, { "value": "Equity.EquityAndLiabilities.RetainedEarnings", "type": "String", "displayName": "Equity.EquityAndLiabilities.RetainedEarnings", "required": false }, { "value": "Liability.EquityAndLiabilities.LongTermDebt", "type": "String", "displayName": "Liability.EquityAndLiabilities.LongTermDebt", "required": false }, { "value": "Liability.EquityAndLiabilities.CurrentPortionOfDebt", "type": "String", "displayName": "Liability.EquityAndLiabilities.CurrentPortionOfDebt", "required": false }, { "value": "Unknown.EquityAndLiabilities.Intercompany", "type": "String", "displayName": "Unknown.EquityAndLiabilities.Intercompany", "required": false }, { "value": "Unknown.General.General", "type": "String", "displayName": "Unknown.General.General", "required": false }, { "value": "Income.NetIncome.Revenue", "type": "String", "displayName": "Income.NetIncome.Revenue", "required": false }, { "value": "Expense.NetIncome.CostOfGoods", "type": "String", "displayName": "Expense.NetIncome.CostOfGoods", "required": false }, { "value": "Expense.NetIncome.OtherCosts", "type": "String", "displayName": "Expense.NetIncome.OtherCosts", "required": false }, { "value": "Expense.NetIncome.SalesGeneralAdministrativeExpenses", "type": "String", "displayName": "Expense.NetIncome.SalesGeneralAdministrativeExpenses", "required": false }, { "value": "Expense.NetIncome.DeprecationCosts", "type": "String", "displayName": "Expense.NetIncome.DeprecationCosts", "required": false }, { "value": "Expense.NetIncome.ResearchAndDevelopment", "type": "String", "displayName": "Expense.NetIncome.ResearchAndDevelopment", "required": false }, { "value": "Expense.NetIncome.EmployeeCosts", "type": "String", "displayName": "Expense.NetIncome.EmployeeCosts", "required": false }, { "value": "Expense.NetIncome.EmploymentCosts", "type": "String", "displayName": "Expense.NetIncome.EmploymentCosts", "required": false }, { "value": "Expense.ExceptionalIncome.ExceptionalCosts", "type": "String", "displayName": "Expense.ExceptionalIncome.ExceptionalCosts", "required": false }, { "value": "Income.ExceptionalIncome.ExceptionalIncome", "type": "String", "displayName": "Income.ExceptionalIncome.ExceptionalIncome", "required": false }, { "value": "Expense.ExceptionalIncome.IncomeTaxes", "type": "String", "displayName": "Expense.ExceptionalIncome.IncomeTaxes", "required": false }, { "value": "Income.ExceptionalIncome.InterestIncome", "type": "String", "displayName": "Income.ExceptionalIncome.InterestIncome", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "FullyQualifiedCategory", "details": "Must be provided." } ] } }, "status": { "type": "String", "displayName": "Account Status", "description": "The status of the account", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Pending", "type": "String", "displayName": "Pending", "required": false }, { "value": "Unknown", "type": "String", "displayName": "Unknown", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "Must be provided." } ] } } }, "required": true } }, "Exact (UK)": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [], "information": [ { "field": "NominalCode", "details": "Must be provided." } ] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "Name", "details": "Must be provided." } ] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "Asset.Assets.Cash", "type": "String", "displayName": "Asset.Assets.Cash", "required": false }, { "value": "Asset.Assets.Bank", "type": "String", "displayName": "Asset.Assets.Bank", "required": false }, { "value": "Asset.Assets.PaymentServices", "type": "String", "displayName": "Asset.Assets.PaymentServices", "required": false }, { "value": "Asset.Assets.AccountsReceivable", "type": "String", "displayName": "Asset.Assets.AccountsReceivable", "required": false }, { "value": "Liability.EquityAndLiabilities.AccountsPayable", "type": "String", "displayName": "Liability.EquityAndLiabilities.AccountsPayable", "required": false }, { "value": "Asset.Assets.VAT", "type": "String", "displayName": "Asset.Assets.VAT", "required": false }, { "value": "Liability.EquityAndLiabilities.EmployeesPayable", "type": "String", "displayName": "Liability.EquityAndLiabilities.EmployeesPayable", "required": false }, { "value": "Asset.Assets.PrepaidExpenses", "type": "String", "displayName": "Asset.Assets.PrepaidExpenses", "required": false }, { "value": "Liability.EquityAndLiabilities.AccruedExpenses", "type": "String", "displayName": "Liability.EquityAndLiabilities.AccruedExpenses", "required": false }, { "value": "Liability.EquityAndLiabilities.IncomeTaxesPayable", "type": "String", "displayName": "Liability.EquityAndLiabilities.IncomeTaxesPayable", "required": false }, { "value": "Asset.Assets.FixedAssets", "type": "String", "displayName": "Asset.Assets.FixedAssets", "required": false }, { "value": "Asset.Assets.OtherAssets", "type": "String", "displayName": "Asset.Assets.OtherAssets", "required": false }, { "value": "Asset.Assets.AccumulatedDeprecation", "type": "String", "displayName": "Asset.Assets.AccumulatedDeprecation", "required": false }, { "value": "Asset.Assets.Inventory", "type": "String", "displayName": "Asset.Assets.Inventory", "required": false }, { "value": "Equity.EquityAndLiabilities.CapitalStock", "type": "String", "displayName": "Equity.EquityAndLiabilities.CapitalStock", "required": false }, { "value": "Equity.EquityAndLiabilities.RetainedEarnings", "type": "String", "displayName": "Equity.EquityAndLiabilities.RetainedEarnings", "required": false }, { "value": "Liability.EquityAndLiabilities.LongTermDebt", "type": "String", "displayName": "Liability.EquityAndLiabilities.LongTermDebt", "required": false }, { "value": "Liability.EquityAndLiabilities.CurrentPortionOfDebt", "type": "String", "displayName": "Liability.EquityAndLiabilities.CurrentPortionOfDebt", "required": false }, { "value": "Unknown.EquityAndLiabilities.Intercompany", "type": "String", "displayName": "Unknown.EquityAndLiabilities.Intercompany", "required": false }, { "value": "Unknown.General.General", "type": "String", "displayName": "Unknown.General.General", "required": false }, { "value": "Income.NetIncome.Revenue", "type": "String", "displayName": "Income.NetIncome.Revenue", "required": false }, { "value": "Expense.NetIncome.CostOfGoods", "type": "String", "displayName": "Expense.NetIncome.CostOfGoods", "required": false }, { "value": "Expense.NetIncome.OtherCosts", "type": "String", "displayName": "Expense.NetIncome.OtherCosts", "required": false }, { "value": "Expense.NetIncome.SalesGeneralAdministrativeExpenses", "type": "String", "displayName": "Expense.NetIncome.SalesGeneralAdministrativeExpenses", "required": false }, { "value": "Expense.NetIncome.DeprecationCosts", "type": "String", "displayName": "Expense.NetIncome.DeprecationCosts", "required": false }, { "value": "Expense.NetIncome.ResearchAndDevelopment", "type": "String", "displayName": "Expense.NetIncome.ResearchAndDevelopment", "required": false }, { "value": "Expense.NetIncome.EmployeeCosts", "type": "String", "displayName": "Expense.NetIncome.EmployeeCosts", "required": false }, { "value": "Expense.NetIncome.EmploymentCosts", "type": "String", "displayName": "Expense.NetIncome.EmploymentCosts", "required": false }, { "value": "Expense.ExceptionalIncome.ExceptionalCosts", "type": "String", "displayName": "Expense.ExceptionalIncome.ExceptionalCosts", "required": false }, { "value": "Income.ExceptionalIncome.ExceptionalIncome", "type": "String", "displayName": "Income.ExceptionalIncome.ExceptionalIncome", "required": false }, { "value": "Expense.ExceptionalIncome.IncomeTaxes", "type": "String", "displayName": "Expense.ExceptionalIncome.IncomeTaxes", "required": false }, { "value": "Income.ExceptionalIncome.InterestIncome", "type": "String", "displayName": "Income.ExceptionalIncome.InterestIncome", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "FullyQualifiedCategory", "details": "Must be provided." } ] } }, "status": { "type": "String", "displayName": "Account Status", "description": "The status of the account", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Pending", "type": "String", "displayName": "Pending", "required": false }, { "value": "Unknown", "type": "String", "displayName": "Unknown", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "Must be provided." } ] } } }, "required": true } }, "MYOB AccountRight and Essentials": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [ { "field": "NominalCode", "details": "If alphanumeric is supported, must be between 1 and 10 characters. Otherwise format is x-xxxx" } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": false, "validation": { "warnings": [ { "field": "Name", "details": "Must have a length between 1 and 60 characters" } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "Description of the account", "required": false, "validation": { "warnings": [ { "field": "Description", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "Asset.Bank", "type": "String", "displayName": "Bank", "required": false }, { "value": "Asset.AccountReceivable", "type": "String", "displayName": "Accounts Receivable", "required": false }, { "value": "Asset.OtherCurrentAsset", "type": "String", "displayName": "Other Current Asset", "required": false }, { "value": "Asset.FixedAsset", "type": "String", "displayName": "Fixed Asset", "required": false }, { "value": "Asset.OtherAsset", "type": "String", "displayName": "Other Asset", "required": false }, { "value": "Asset.CashAndBank", "type": "String", "displayName": "Cash", "required": false }, { "value": "Asset.Property Plant and Equipment", "type": "String", "displayName": "Equipment Machinery", "required": false }, { "value": "Liability.CreditCard", "type": "String", "displayName": "Credit Card", "required": false }, { "value": "Liability.AccountsPayable", "type": "String", "displayName": "Accounts Payable", "required": false }, { "value": "Liability.OtherCurrentLiability", "type": "String", "displayName": "Other Current Liability", "required": false }, { "value": "Liability.LongTermLiability", "type": "String", "displayName": "Long Term Liability", "required": false }, { "value": "Liability.OtherLiability", "type": "String", "displayName": "Other Liability", "required": false }, { "value": "Equity", "type": "String", "displayName": "Equity", "required": false }, { "value": "Equity.Equity", "type": "String", "displayName": "Retained Earnings", "required": false }, { "value": "Equity.Equity.RetainedEarnings", "type": "String", "displayName": "Retained Earnings", "required": false }, { "value": "Equity.Owner's Equity", "type": "String", "displayName": "Retained Earnings", "required": false }, { "value": "Income", "type": "String", "displayName": "Income", "required": false }, { "value": "OtherIncome", "type": "String", "displayName": "Other Income", "required": false }, { "value": "Expense", "type": "String", "displayName": "Expense", "required": false }, { "value": "Expense.Expense", "type": "String", "displayName": "Sales Marketing", "required": false }, { "value": "Expense.Expense.Insurance", "type": "String", "displayName": "General Administrative", "required": false }, { "value": "Expense.Overhead", "type": "String", "displayName": "General Administrative", "required": false }, { "value": "Expense.Expense.RepairMaintenance", "type": "String", "displayName": "Repairs Maintenance", "required": false }, { "value": "OtherExpense", "type": "String", "displayName": "Other Expense", "required": false }, { "value": "CostOfSales", "type": "String", "displayName": "Cost of Sales", "required": false }, { "value": "Cost Of Goods Sold.Cost of Sales", "type": "String", "displayName": "Other", "required": false } ], "required": true }, "status": { "type": "String", "displayName": "Account Status", "description": "The status of the account", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [ { "field": "NominalCode", "details": "Max length of 7 characters." } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true, "validation": { "warnings": [ { "field": "Name", "details": "Max length of 31 characters." } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "Description of the account", "required": false, "validation": { "warnings": [ { "field": "Description", "details": "Max length of 200 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the account", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is 'Asset.AccountsReceivable','Liability.AccountsPayable' or 'Liability.CreditCard'" }, { "field": "Currency", "details": "Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company" }, { "field": "Currency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "Currency", "details": "If not set, will default to the base currency of the QuickBooks Desktop company" } ] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "Asset.AccountsReceivable", "type": "String", "displayName": "Account Receivable", "required": false }, { "value": "Asset.FixedAsset", "type": "String", "displayName": "Fixed Asset", "required": false }, { "value": "Asset.OtherCurrentAsset", "type": "String", "displayName": "Other Current Asset", "required": false }, { "value": "Asset.OtherAsset", "type": "String", "displayName": "Other Asset", "required": false }, { "value": "Income.Income", "type": "String", "displayName": "Income", "required": false }, { "value": "Income.OtherIncome", "type": "String", "displayName": "Other Income", "required": false }, { "value": "Liability.AccountsPayable", "type": "String", "displayName": "Accounts Payable", "required": false }, { "value": "Liability.CreditCard", "type": "String", "displayName": "Credit Card", "required": false }, { "value": "Liability.LongTermLiability", "type": "String", "displayName": "Long Term Liability", "required": false }, { "value": "Liability.OtherCurrentLiability", "type": "String", "displayName": "Other Current Liability", "required": false }, { "value": "Liability.CostOfGoodsSold", "type": "String", "displayName": "Cost Of Goods Sold", "required": false }, { "value": "Equity.Equity", "type": "String", "displayName": "Equity", "required": false }, { "value": "Expense.Expense", "type": "String", "displayName": "Expense", "required": false }, { "value": "Expense.OtherExpense", "type": "String", "displayName": "Other Expense", "required": false } ], "required": true }, "currentBalance": { "type": "Number", "displayName": "Current Balance", "description": "The current balance in the account", "required": false } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": false, "validation": { "warnings": [], "information": [ { "field": "NominalCode", "details": "If included must have a length between 1 and 7 characters" } ] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true, "validation": { "warnings": [ { "field": "Name", "details": "Must have a length between 1 and 100 characters" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the account", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "When not specified company base currency will be used" } ] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "Asset.Bank.CashOnHand", "type": "String", "displayName": "Cash On Hand", "required": false }, { "value": "Asset.Bank.Checking", "type": "String", "displayName": "Checking", "required": false }, { "value": "Asset.Bank.MoneyMarket", "type": "String", "displayName": "Money Market", "required": false }, { "value": "Asset.Bank.RentsHeldInTrust", "type": "String", "displayName": "Rents Held In Trust", "required": false }, { "value": "Asset.Bank.Savings", "type": "String", "displayName": "Savings", "required": false }, { "value": "Asset.Bank.TrustAccounts", "type": "String", "displayName": "Trust Accounts", "required": false }, { "value": "Asset.Bank.CashAndCashEquivalents", "type": "String", "displayName": "Cash And Cash Equivalents", "required": false }, { "value": "Asset.Bank.OtherEarmarkedBankAccounts", "type": "String", "displayName": "Other Earmarked Bank Accounts", "required": false }, { "value": "Asset.Other Current Asset.AllowanceForBadDebts", "type": "String", "displayName": "Allowance For Bad Debts", "required": false }, { "value": "Asset.Other Current Asset.DevelopmentCosts", "type": "String", "displayName": "Development Costs", "required": false }, { "value": "Asset.Other Current Asset.EmployeeCashAdvances", "type": "String", "displayName": "Employee Cash Advances", "required": false }, { "value": "Asset.Other Current Asset.OtherCurrentAssets", "type": "String", "displayName": "Other Current Assets", "required": false }, { "value": "Asset.Other Current Asset.Inventory", "type": "String", "displayName": "Inventory", "required": false }, { "value": "Asset.Other Current Asset.Investment_MortgageRealEstateLoans", "type": "String", "displayName": "Investment Mortgage Real Estate Loans", "required": false }, { "value": "Asset.Other Current Asset.Investment_Other", "type": "String", "displayName": "Investment Other", "required": false }, { "value": "Asset.Other Current Asset.Investment_TaxExemptSecurities", "type": "String", "displayName": "Investment Tax Exempt Securities", "required": false }, { "value": "Asset.Other Current Asset.Investment_USGovernmentObligations", "type": "String", "displayName": "Investment US Government Obligations", "required": false }, { "value": "Asset.Other Current Asset.LoansToOfficers", "type": "String", "displayName": "Loans To Officers", "required": false }, { "value": "Asset.Other Current Asset.LoansToOthers", "type": "String", "displayName": "Loans To Others", "required": false }, { "value": "Asset.Other Current Asset.LoansToStockholders", "type": "String", "displayName": "Loans To Stockholders", "required": false }, { "value": "Asset.Other Current Asset.PrepaidExpenses", "type": "String", "displayName": "Prepaid Expenses", "required": false }, { "value": "Asset.Other Current Asset.Retainage", "type": "String", "displayName": "Retainage", "required": false }, { "value": "Asset.Other Current Asset.UndepositedFunds", "type": "String", "displayName": "Undeposited Funds", "required": false }, { "value": "Asset.Other Current Asset.AssetsAvailableForSale", "type": "String", "displayName": "Assets Available For Sale", "required": false }, { "value": "Asset.Other Current Asset.BalWithGovtAuthorities", "type": "String", "displayName": "Balance With Govt Authorities", "required": false }, { "value": "Asset.Other Current Asset.CalledUpShareCapitalNotPaid", "type": "String", "displayName": "Called Up Share Capital Not Paid", "required": false }, { "value": "Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit", "type": "String", "displayName": "Expenditure Authorisations And Letters Of Credit", "required": false }, { "value": "Asset.Other Current Asset.GlobalTaxDeferred", "type": "String", "displayName": "Global Tax Deferred", "required": false }, { "value": "Asset.Other Current Asset.GlobalTaxRefund", "type": "String", "displayName": "Global Tax Refund", "required": false }, { "value": "Asset.Other Current Asset.InternalTransfers", "type": "String", "displayName": "Internal Transfers", "required": false }, { "value": "Asset.Other Current Asset.OtherConsumables", "type": "String", "displayName": "Other Consumables", "required": false }, { "value": "Asset.Other Current Asset.ProvisionsCurrentAssets", "type": "String", "displayName": "Provisions Current Assets", "required": false }, { "value": "Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties", "type": "String", "displayName": "Short Term Investments In Related Parties", "required": false }, { "value": "Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties", "type": "String", "displayName": "Short Term Loans And Advances To Related Parties", "required": false }, { "value": "Asset.Other Current Asset.TradeAndOtherReceivables", "type": "String", "displayName": "Trade And Other Receivables", "required": false }, { "value": "Asset.Fixed Asset.AccumulatedDepletion", "type": "String", "displayName": "Accumulated Depletion", "required": false }, { "value": "Asset.Fixed Asset.AccumulatedDepreciation", "type": "String", "displayName": "Accumulated Depreciation", "required": false }, { "value": "Asset.Fixed Asset.DepletableAssets", "type": "String", "displayName": "Depletable Assets", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetComputers", "type": "String", "displayName": "Fixed Asset Computers", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetCopiers", "type": "String", "displayName": "Fixed Asset Copiers", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetFurniture", "type": "String", "displayName": "Fixed Asset Furniture", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetPhone", "type": "String", "displayName": "Fixed Asset Phone", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetPhotoVideo", "type": "String", "displayName": "Fixed Asset Photo Video", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetSoftware", "type": "String", "displayName": "Fixed Asset Software", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetOtherToolsEquipment", "type": "String", "displayName": "Fixed Asset Other Tools Equipment", "required": false }, { "value": "Asset.Fixed Asset.FurnitureAndFixtures", "type": "String", "displayName": "Furniture And Fixtures", "required": false }, { "value": "Asset.Fixed Asset.Land", "type": "String", "displayName": "Land", "required": false }, { "value": "Asset.Fixed Asset.LeaseholdImprovements", "type": "String", "displayName": "Leasehold Improvements", "required": false }, { "value": "Asset.Fixed Asset.OtherFixedAssets", "type": "String", "displayName": "Other Fixed Assets", "required": false }, { "value": "Asset.Fixed Asset.AccumulatedAmortization", "type": "String", "displayName": "Accumulated Amortization", "required": false }, { "value": "Asset.Fixed Asset.Buildings", "type": "String", "displayName": "Buildings", "required": false }, { "value": "Asset.Fixed Asset.IntangibleAssets", "type": "String", "displayName": "Intangible Assets", "required": false }, { "value": "Asset.Fixed Asset.MachineryAndEquipment", "type": "String", "displayName": "Machinery And Equipment", "required": false }, { "value": "Asset.Fixed Asset.Vehicles", "type": "String", "displayName": "Vehicles", "required": false }, { "value": "Asset.Fixed Asset.AssetsInCourseOfConstruction", "type": "String", "displayName": "Assets In Course Of Construction", "required": false }, { "value": "Asset.Fixed Asset.CapitalWip", "type": "String", "displayName": "Capital Wip", "required": false }, { "value": "Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets", "type": "String", "displayName": "Cumulative Depreciation On Intangible Assets", "required": false }, { "value": "Asset.Fixed Asset.IntangibleAssetsUnderDevelopment", "type": "String", "displayName": "Intangible Assets Under Development", "required": false }, { "value": "Asset.Fixed Asset.LandAsset", "type": "String", "displayName": "Land Asset", "required": false }, { "value": "Asset.Fixed Asset.NonCurrentAssets", "type": "String", "displayName": "Non Current Assets", "required": false }, { "value": "Asset.Fixed Asset.ParticipatingInterests", "type": "String", "displayName": "Participating Interests", "required": false }, { "value": "Asset.Fixed Asset.ProvisionsFixedAssets", "type": "String", "displayName": "Provisions Fixed Assets", "required": false }, { "value": "Asset.Other Asset.LeaseBuyout", "type": "String", "displayName": "Lease Buyout", "required": false }, { "value": "Asset.Other Asset.OtherLongTermAssets", "type": "String", "displayName": "Other Long Term Assets", "required": false }, { "value": "Asset.Other Asset.SecurityDeposits", "type": "String", "displayName": "Security Deposits", "required": false }, { "value": "Asset.Other Asset.AccumulatedAmortizationOfOtherAssets", "type": "String", "displayName": "Accumulated Amortization Of Other Assets", "required": false }, { "value": "Asset.Other Asset.Goodwill", "type": "String", "displayName": "Goodwill", "required": false }, { "value": "Asset.Other Asset.Licenses", "type": "String", "displayName": "Licenses", "required": false }, { "value": "Asset.Other Asset.OrganizationalCosts", "type": "String", "displayName": "Organizational Costs", "required": false }, { "value": "Asset.Other Asset.AssetsHeldForSale", "type": "String", "displayName": "Assets Held For Sale", "required": false }, { "value": "Asset.Other Asset.AvailableForSaleFinancialAssets", "type": "String", "displayName": "Available For Sale Financial Assets", "required": false }, { "value": "Asset.Other Asset.DeferredTax", "type": "String", "displayName": "Deferred Tax", "required": false }, { "value": "Asset.Other Asset.Investments", "type": "String", "displayName": "Investments", "required": false }, { "value": "Asset.Other Asset.LongTermInvestments", "type": "String", "displayName": "Long Term Investments", "required": false }, { "value": "Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties", "type": "String", "displayName": "Long Term Loans And Advances To Related Parties", "required": false }, { "value": "Asset.Other Asset.OtherIntangibleAssets", "type": "String", "displayName": "Other Intangible Assets", "required": false }, { "value": "Asset.Other Asset.OtherLongTermInvestments", "type": "String", "displayName": "Other Long Term Investments", "required": false }, { "value": "Asset.Other Asset.OtherLongTermLoansAndAdvances", "type": "String", "displayName": "Other Long Term Loans And Advances", "required": false }, { "value": "Asset.Other Asset.PrepaymentsAndAccruedIncome", "type": "String", "displayName": "Prepayments And Accrued Income", "required": false }, { "value": "Asset.Other Asset.ProvisionsNonCurrentAssets", "type": "String", "displayName": "Provisions Non-Current Assets", "required": false }, { "value": "Asset.Accounts Receivable.AccountsReceivable", "type": "String", "displayName": "Accounts Receivable", "required": false }, { "value": "Expense.Expense.AdvertisingPromotional", "type": "String", "displayName": "Advertising/Promotional", "required": false }, { "value": "Expense.Expense.BadDebts", "type": "String", "displayName": "Bad Debts", "required": false }, { "value": "Expense.Expense.BankCharges", "type": "String", "displayName": "Bank Charges", "required": false }, { "value": "Expense.Expense.CharitableContributions", "type": "String", "displayName": "Charitable Contributions", "required": false }, { "value": "Expense.Expense.CommissionsAndFees", "type": "String", "displayName": "Commissions And Fees", "required": false }, { "value": "Expense.Expense.Entertainment", "type": "String", "displayName": "Entertainment", "required": false }, { "value": "Expense.Expense.EntertainmentMeals", "type": "String", "displayName": "Entertainment Meals", "required": false }, { "value": "Expense.Expense.EquipmentRental", "type": "String", "displayName": "Equipment Rental", "required": false }, { "value": "Expense.Expense.FinanceCosts", "type": "String", "displayName": "Finance Costs", "required": false }, { "value": "Expense.Expense.GlobalTaxExpense", "type": "String", "displayName": "Global Tax Expense", "required": false }, { "value": "Expense.Expense.Insurance", "type": "String", "displayName": "Insurance", "required": false }, { "value": "Expense.Expense.InterestPaid", "type": "String", "displayName": "Interest Paid", "required": false }, { "value": "Expense.Expense.LegalProfessionalFees", "type": "String", "displayName": "Legal And Professional Fees", "required": false }, { "value": "Expense.Expense.OfficeExpenses", "type": "String", "displayName": "Office Expenses", "required": false }, { "value": "Expense.Expense.OfficeGeneralAdministrativeExpenses", "type": "String", "displayName": "Office/General Administrative Expenses", "required": false }, { "value": "Expense.Expense.OtherBusinessExpenses", "type": "String", "displayName": "Other Business Expenses", "required": false }, { "value": "Expense.Expense.OtherMiscellaneousServiceCost", "type": "String", "displayName": "Other Miscellaneous Service Cost", "required": false }, { "value": "Expense.Expense.PromotionalMeals", "type": "String", "displayName": "Promotional Meals", "required": false }, { "value": "Expense.Expense.RentOrLeaseOfBuildings", "type": "String", "displayName": "Rent Or Lease Of Buildings", "required": false }, { "value": "Expense.Expense.RepairMaintenance", "type": "String", "displayName": "Repair And Maintenance", "required": false }, { "value": "Expense.Expense.ShippingFreightDelivery", "type": "String", "displayName": "Shipping, Freight And Delivery", "required": false }, { "value": "Expense.Expense.SuppliesMaterials", "type": "String", "displayName": "Supplies And Materials", "required": false }, { "value": "Expense.Expense.Travel", "type": "String", "displayName": "Travel", "required": false }, { "value": "Expense.Expense.TravelMeals", "type": "String", "displayName": "Travel Meals", "required": false }, { "value": "Expense.Expense.Utilities", "type": "String", "displayName": "Utilities", "required": false }, { "value": "Expense.Expense.Auto", "type": "String", "displayName": "Auto", "required": false }, { "value": "Expense.Expense.CostOfLabor", "type": "String", "displayName": "Cost Of Labor", "required": false }, { "value": "Expense.Expense.DuesSubscriptions", "type": "String", "displayName": "Dues And Subscriptions", "required": false }, { "value": "Expense.Expense.PayrollExpenses", "type": "String", "displayName": "Payroll Expenses", "required": false }, { "value": "Expense.Expense.TaxesPaid", "type": "String", "displayName": "Taxes Paid", "required": false }, { "value": "Expense.Expense.UnappliedCashBillPaymentExpense", "type": "String", "displayName": "Unapplied Cash Bill Payment Expense", "required": false }, { "value": "Expense.Expense.Utilities", "type": "String", "displayName": "Utilities", "required": false }, { "value": "Expense.Expense.AmortizationExpense", "type": "String", "displayName": "Amortization Expense", "required": false }, { "value": "Expense.Expense.AppropriationsToDepreciation", "type": "String", "displayName": "Appropriations To Depreciation", "required": false }, { "value": "Expense.Expense.BorrowingCost", "type": "String", "displayName": "Borrowing Cost", "required": false }, { "value": "Expense.Expense.CommissionsAndFees", "type": "String", "displayName": "Commissions And Fees", "required": false }, { "value": "Expense.Expense.DistributionCosts", "type": "String", "displayName": "Distribution Costs", "required": false }, { "value": "Expense.Expense.ExternalServices", "type": "String", "displayName": "External Services", "required": false }, { "value": "Expense.Expense.ExtraordinaryCharges", "type": "String", "displayName": "Extraordinary Charges", "required": false }, { "value": "Expense.Expense.IncomeTaxExpense", "type": "String", "displayName": "Income Tax Expense", "required": false }, { "value": "Expense.Expense.LossOnDiscontinuedOperationsNetOfTax", "type": "String", "displayName": "Loss On Discontinued Operations Net Of Tax", "required": false }, { "value": "Expense.Expense.ManagementCompensation", "type": "String", "displayName": "Management Compensation", "required": false }, { "value": "Expense.Expense.OtherCurrentOperatingCharges", "type": "String", "displayName": "Other Current Operating Charges", "required": false }, { "value": "Expense.Expense.OtherExternalServices", "type": "String", "displayName": "Other External Services", "required": false }, { "value": "Expense.Expense.OtherRentalCosts", "type": "String", "displayName": "Other Rental Costs", "required": false }, { "value": "Expense.Expense.OtherSellingExpenses", "type": "String", "displayName": "Other Selling Expenses", "required": false }, { "value": "Expense.Expense.ProjectStudiesSurveysAssessments", "type": "String", "displayName": "Project Studies Surveys Assessments", "required": false }, { "value": "Expense.Expense.PurchasesRebates", "type": "String", "displayName": "Purchases Rebates", "required": false }, { "value": "Expense.Expense.ShippingAndDeliveryExpense", "type": "String", "displayName": "Shipping And Delivery Expense", "required": false }, { "value": "Expense.Expense.StaffCosts", "type": "String", "displayName": "Staff Costs", "required": false }, { "value": "Expense.Expense.Sundry", "type": "String", "displayName": "Sundry", "required": false }, { "value": "Expense.Expense.TravelExpensesGeneralAndAdminExpenses", "type": "String", "displayName": "Travel Expenses General And Admin Expenses", "required": false }, { "value": "Expense.Expense.TravelExpensesSellingExpense", "type": "String", "displayName": "Travel Expenses Selling Expense", "required": false }, { "value": "Expense.Other Expense.Depreciation", "type": "String", "displayName": "Depreciation", "required": false }, { "value": "Expense.Other Expense.ExchangeGainOrLoss", "type": "String", "displayName": "Exchange Gain Or Loss", "required": false }, { "value": "Expense.Other Expense.OtherMiscellaneousExpense", "type": "String", "displayName": "Other Miscellaneous Expense", "required": false }, { "value": "Expense.Other Expense.PenaltiesSettlements", "type": "String", "displayName": "Penalties And Settlements", "required": false }, { "value": "Expense.Other Expense.Amortization", "type": "String", "displayName": "Amortization", "required": false }, { "value": "Expense.Other Expense.GasAndFuel", "type": "String", "displayName": "Gas And Fuel", "required": false }, { "value": "Expense.Other Expense.HomeOffice", "type": "String", "displayName": "Home Office", "required": false }, { "value": "Expense.Other Expense.HomeOwnerRentalInsurance", "type": "String", "displayName": "Home Owner Rental Insurance", "required": false }, { "value": "Expense.Other Expense.OtherHomeOfficeExpenses", "type": "String", "displayName": "Other Home Office Expenses", "required": false }, { "value": "Expense.Other Expense.MortgageInterest", "type": "String", "displayName": "Mortgage Interest", "required": false }, { "value": "Expense.Other Expense.RentAndLease", "type": "String", "displayName": "Rent And Lease", "required": false }, { "value": "Expense.Other Expense.RepairsAndMaintenance", "type": "String", "displayName": "Repairs And Maintenance", "required": false }, { "value": "Expense.Other Expense.ParkingAndTolls", "type": "String", "displayName": "Parking And Tolls", "required": false }, { "value": "Expense.Other Expense.Vehicle", "type": "String", "displayName": "Vehicle", "required": false }, { "value": "Expense.Other Expense.VehicleInsurance", "type": "String", "displayName": "Vehicle Insurance", "required": false }, { "value": "Expense.Other Expense.VehicleLease", "type": "String", "displayName": "Vehicle Lease", "required": false }, { "value": "Expense.Other Expense.VehicleLoanInterest", "type": "String", "displayName": "Vehicle Loan Interest", "required": false }, { "value": "Expense.Other Expense.VehicleLoan", "type": "String", "displayName": "Vehicle Loan", "required": false }, { "value": "Expense.Other Expense.VehicleRegistration", "type": "String", "displayName": "Vehicle Registration", "required": false }, { "value": "Expense.Other Expense.VehicleRepairs", "type": "String", "displayName": "Vehicle Repairs", "required": false }, { "value": "Expense.Other Expense.OtherVehicleExpenses", "type": "String", "displayName": "Other Vehicle Expenses", "required": false }, { "value": "Expense.Other Expense.Utilities", "type": "String", "displayName": "Utilities", "required": false }, { "value": "Expense.Other Expense.WashAndRoadServices", "type": "String", "displayName": "Wash And Road Services", "required": false }, { "value": "Expense.Other Expense.DeferredTaxExpense", "type": "String", "displayName": "Deferred Tax Expense", "required": false }, { "value": "Expense.Other Expense.Depletion", "type": "String", "displayName": "Depletion", "required": false }, { "value": "Expense.Other Expense.ExceptionalItems", "type": "String", "displayName": "Exceptional Items", "required": false }, { "value": "Expense.Other Expense.ExtraordinaryItems", "type": "String", "displayName": "Extraordinary Items", "required": false }, { "value": "Expense.Other Expense.IncomeTaxOtherExpense", "type": "String", "displayName": "Income Tax Other Expense", "required": false }, { "value": "Expense.Other Expense.MatCredit", "type": "String", "displayName": "Mat Credit", "required": false }, { "value": "Expense.Other Expense.PriorPeriodItems", "type": "String", "displayName": "Prior Period Items", "required": false }, { "value": "Expense.Other Expense.TaxRoundoffGainOrLoss", "type": "String", "displayName": "Tax Roundoff Gain Or Loss", "required": false }, { "value": "Expense.Cost of Goods Sold.EquipmentRentalCos", "type": "String", "displayName": "Equipment Rental - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.OtherCostsOfServiceCos", "type": "String", "displayName": "Other Costs Of Sales - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.ShippingFreightDeliveryCos", "type": "String", "displayName": "Shipping, Freight And Delivery - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.SuppliesMaterialsCogs", "type": "String", "displayName": "Supplies And Materials - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.CostOfLaborCos", "type": "String", "displayName": "Cost Of Labor - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.CostOfSales", "type": "String", "displayName": "Cost Of Sales", "required": false }, { "value": "Expense.Cost of Goods Sold.FreightAndDeliveryCost", "type": "String", "displayName": "Freight And Delivery Cost", "required": false }, { "value": "Income.Income.NonProfitIncome", "type": "String", "displayName": "Non Profit Income", "required": false }, { "value": "Income.Income.OtherPrimaryIncome", "type": "String", "displayName": "Other Primary Income", "required": false }, { "value": "Income.Income.SalesOfProductIncome", "type": "String", "displayName": "Sales Of ProductIncome", "required": false }, { "value": "Income.Income.ServiceFeeIncome", "type": "String", "displayName": "Service Fee Income", "required": false }, { "value": "Income.Income.DiscountsRefundsGiven", "type": "String", "displayName": "Discounts Refunds Given", "required": false }, { "value": "Income.Income.UnappliedCashPaymentIncome", "type": "String", "displayName": "Unapplied Cash Payment Income", "required": false }, { "value": "Income.Income.CashReceiptIncome", "type": "String", "displayName": "Cash Receipt Income", "required": false }, { "value": "Income.Income.OperatingGrants", "type": "String", "displayName": "Operating Grants", "required": false }, { "value": "Income.Income.OtherCurrentOperatingIncome", "type": "String", "displayName": "Other Current Operating Income", "required": false }, { "value": "Income.Income.OwnWorkCapitalized", "type": "String", "displayName": "Own Work Capitalized", "required": false }, { "value": "Income.Income.RevenueGeneral", "type": "String", "displayName": "Revenue General", "required": false }, { "value": "Income.Income.SalesRetail", "type": "String", "displayName": "Sales Retail", "required": false }, { "value": "Income.Income.SalesWholesale", "type": "String", "displayName": "Sales Wholesale", "required": false }, { "value": "Income.Income.SavingsByTaxScheme", "type": "String", "displayName": "Savings By Tax Scheme", "required": false }, { "value": "Income.Other Income.DividendIncome", "type": "String", "displayName": "Dividend Income", "required": false }, { "value": "Income.Other Income.InterestEarned", "type": "String", "displayName": "Interest Earned", "required": false }, { "value": "Income.Other Income.OtherInvestmentIncome", "type": "String", "displayName": "Other Investment Income", "required": false }, { "value": "Income.Other Income.OtherMiscellaneousIncome", "type": "String", "displayName": "Other Miscellaneous Income", "required": false }, { "value": "Income.Other Income.TaxExemptInterest", "type": "String", "displayName": "Tax Exempt Interest", "required": false }, { "value": "Income.Other Income.GainLossOnSaleOfFixedAssets", "type": "String", "displayName": "Gain Loss On Sale Of Fixed Assets", "required": false }, { "value": "Income.Other Income.GainLossOnSaleOfInvestments", "type": "String", "displayName": "Gain Loss On Sale Of Investments", "required": false }, { "value": "Income.Other Income.LossOnDisposalOfAssets", "type": "String", "displayName": "Loss On Disposal Of Assets", "required": false }, { "value": "Income.Other Income.OtherOperatingIncome", "type": "String", "displayName": "Other Operating Income", "required": false }, { "value": "Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax", "type": "String", "displayName": "Unrealised Loss On Securities Net Of Tax", "required": false }, { "value": "Liability.Accounts Payable.AccountsPayable", "type": "String", "displayName": "Accounts Payable", "required": false }, { "value": "Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise", "type": "String", "displayName": "Outstanding Dues Micro Small Enterprise", "required": false }, { "value": "Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise", "type": "String", "displayName": "Outstanding Dues Other Than Micro Small Enterprise", "required": false }, { "value": "Liability.Credit Card.CreditCard", "type": "String", "displayName": "Credit Card", "required": false }, { "value": "Liability.Long Term Liability.NotesPayable", "type": "String", "displayName": "Notes Payable", "required": false }, { "value": "Liability.Long Term Liability.OtherLongTermLiabilities", "type": "String", "displayName": "Other Long Term Liabilities", "required": false }, { "value": "Liability.Long Term Liability.ShareholderNotesPayable", "type": "String", "displayName": "Shareholder Notes Payable", "required": false }, { "value": "Liability.Long Term Liability.AccrualsAndDeferredIncome", "type": "String", "displayName": "Accruals And Deferred Income", "required": false }, { "value": "Liability.Long Term Liability.AccruedLongLermLiabilities", "type": "String", "displayName": "Accrued Long Lerm Liabilities", "required": false }, { "value": "Liability.Long Term Liability.AccruedVacationPayable", "type": "String", "displayName": "Accrued Vacation Payable", "required": false }, { "value": "Liability.Long Term Liability.BankLoans", "type": "String", "displayName": "Bank Loans", "required": false }, { "value": "Liability.Long Term Liability.DebtsRelatedToParticipatingInterests", "type": "String", "displayName": "Debts Related To Participating Interests", "required": false }, { "value": "Liability.Long Term Liability.DeferredTaxLiabilities", "type": "String", "displayName": "Deferred Tax Liabilities", "required": false }, { "value": "Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities", "type": "String", "displayName": "Government And Other Public Authorities", "required": false }, { "value": "Liability.Long Term Liability.GroupAndAssociates", "type": "String", "displayName": "Group And Associates", "required": false }, { "value": "Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale", "type": "String", "displayName": "Liabilities Related To Assets Held For Sale", "required": false }, { "value": "Liability.Long Term Liability.LongTermBorrowings", "type": "String", "displayName": "Long Term Borrowings", "required": false }, { "value": "Liability.Long Term Liability.LongTermDebit", "type": "String", "displayName": "Long Term Debit", "required": false }, { "value": "Liability.Long Term Liability.LongTermEmployeeBenefitObligations", "type": "String", "displayName": "Long Term Employee Benefit Obligations", "required": false }, { "value": "Liability.Long Term Liability.ObligationsUnderFinanceLeases", "type": "String", "displayName": "Obligations Under Finance Leases", "required": false }, { "value": "Liability.Long Term Liability.OtherLongTermProvisions", "type": "String", "displayName": "Other Long Term Provisions", "required": false }, { "value": "Liability.Long Term Liability.ProvisionForLiabilities", "type": "String", "displayName": "Provision For Liabilities", "required": false }, { "value": "Liability.Long Term Liability.ProvisionsNonCurrentLiabilities", "type": "String", "displayName": "Provisions Non Current Liabilities", "required": false }, { "value": "Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts", "type": "String", "displayName": "Staff And Related Long Term Liability Accounts", "required": false }, { "value": "Liability.Other Current Liability.DirectDepositPayable", "type": "String", "displayName": "Direct Deposit Payable", "required": false }, { "value": "Liability.Other Current Liability.LineOfCredit", "type": "String", "displayName": "Line Of Credit", "required": false }, { "value": "Liability.Other Current Liability.LoanPayable", "type": "String", "displayName": "Loan Payable", "required": false }, { "value": "Liability.Other Current Liability.GlobalTaxPayable", "type": "String", "displayName": "Global Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.GlobalTaxSuspense", "type": "String", "displayName": "Global Tax Suspense", "required": false }, { "value": "Liability.Other Current Liability.OtherCurrentLiabilities", "type": "String", "displayName": "Other Current Liabilities", "required": false }, { "value": "Liability.Other Current Liability.PayrollClearing", "type": "String", "displayName": "Payroll Clearing", "required": false }, { "value": "Liability.Other Current Liability.PayrollTaxPayable", "type": "String", "displayName": "Payroll Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.PrepaidExpensesPayable", "type": "String", "displayName": "Prepaid Expenses Payable", "required": false }, { "value": "Liability.Other Current Liability.RentsInTrustLiability", "type": "String", "displayName": "Rents In Trust Liability", "required": false }, { "value": "Liability.Other Current Liability.TrustAccountsLiabilities", "type": "String", "displayName": "Trust Accounts Liabilities", "required": false }, { "value": "Liability.Other Current Liability.FederalIncomeTaxPayable", "type": "String", "displayName": "Federal Income Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.InsurancePayable", "type": "String", "displayName": "Insurance Payable", "required": false }, { "value": "Liability.Other Current Liability.SalesTaxPayable", "type": "String", "displayName": "Sales Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.StateLocalIncomeTaxPayable", "type": "String", "displayName": "State Local Income Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.AccruedLiabilities", "type": "String", "displayName": "Accrued Liabilities", "required": false }, { "value": "Liability.Other Current Liability.CurrentLiabilities", "type": "String", "displayName": "Current Liabilities", "required": false }, { "value": "Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations", "type": "String", "displayName": "Current Portion EmployeeBenefits Obligations", "required": false }, { "value": "Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases", "type": "String", "displayName": "Current Portion Of Obligations Under Finance Leases", "required": false }, { "value": "Liability.Other Current Liability.CurrentTaxLiability", "type": "String", "displayName": "Current Tax Liability", "required": false }, { "value": "Liability.Other Current Liability.DividendsPayable", "type": "String", "displayName": "Dividends Payable", "required": false }, { "value": "Liability.Other Current Liability.DutiesAndTaxes", "type": "String", "displayName": "Duties And Taxes", "required": false }, { "value": "Liability.Other Current Liability.InterestPayables", "type": "String", "displayName": "Interest Payables", "required": false }, { "value": "Liability.Other Current Liability.ProvisionForWarrantyObligations", "type": "String", "displayName": "Provision For Warranty Obligations", "required": false }, { "value": "Liability.Other Current Liability.ProvisionsCurrentLiabilities", "type": "String", "displayName": "Provisions Current Liabilities", "required": false }, { "value": "Liability.Other Current Liability.ShortTermBorrowings", "type": "String", "displayName": "Short Term Borrowings", "required": false }, { "value": "Liability.Other Current Liability.SocialSecurityAgencies", "type": "String", "displayName": "Social Security Agencies", "required": false }, { "value": "Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts", "type": "String", "displayName": "Staff And Related Liability Accounts", "required": false }, { "value": "Liability.Other Current Liability.SundryDebtorsAndCreditors", "type": "String", "displayName": "Sundry Debtors And Creditors", "required": false }, { "value": "Liability.Other Current Liability.TradeAndOtherPayables", "type": "String", "displayName": "Trade And Other Payables", "required": false }, { "value": "Equity.Equity.OpeningBalanceEquity", "type": "String", "displayName": "Opening Balance Equity", "required": false }, { "value": "Equity.Equity.PartnersEquity", "type": "String", "displayName": "Partners Equity", "required": false }, { "value": "Equity.Equity.RetainedEarnings", "type": "String", "displayName": "Retained Earnings", "required": false }, { "value": "Equity.Equity.AccumulatedAdjustment", "type": "String", "displayName": "Accumulated Adjustment", "required": false }, { "value": "Equity.Equity.OwnersEquity", "type": "String", "displayName": "Owners Equity", "required": false }, { "value": "Equity.Equity.PaidInCapitalOrSurplus", "type": "String", "displayName": "Paid In Capital Or Surplus", "required": false }, { "value": "Equity.Equity.PartnerContributions", "type": "String", "displayName": "Partner Contributions", "required": false }, { "value": "Equity.Equity.PartnerDistributions", "type": "String", "displayName": "Partner Distributions", "required": false }, { "value": "Equity.Equity.PreferredStock", "type": "String", "displayName": "Preferred Stock", "required": false }, { "value": "Equity.Equity.CommonStock", "type": "String", "displayName": "Common Stock", "required": false }, { "value": "Equity.Equity.TreasuryStock", "type": "String", "displayName": "Treasury Stock", "required": false }, { "value": "Equity.Equity.EstimatedTaxes", "type": "String", "displayName": "Estimated Taxes", "required": false }, { "value": "Equity.Equity.Healthcare", "type": "String", "displayName": "Healthcare", "required": false }, { "value": "Equity.Equity.PersonalIncome", "type": "String", "displayName": "Personal Income", "required": false }, { "value": "Equity.Equity.PersonalExpense", "type": "String", "displayName": "Personal Expense", "required": false }, { "value": "Equity.Equity.AccumulatedOtherComprehensiveIncome", "type": "String", "displayName": "Accumulated Other Comprehensive Income", "required": false }, { "value": "Equity.Equity.CalledUpShareCapital", "type": "String", "displayName": "Called Up Share Capital", "required": false }, { "value": "Equity.Equity.CapitalReserves", "type": "String", "displayName": "Capital Reserves", "required": false }, { "value": "Equity.Equity.DividendDisbursed", "type": "String", "displayName": "Dividend Disbursed", "required": false }, { "value": "Equity.Equity.EquityInEarningsOfSubsiduaries", "type": "String", "displayName": "Equity In Earnings Of Subsiduaries", "required": false }, { "value": "Equity.Equity.InvestmentGrants", "type": "String", "displayName": "Investment Grants", "required": false }, { "value": "Equity.Equity.MoneyReceivedAgainstShareWarrants", "type": "String", "displayName": "Money Received Against Share Warrants", "required": false }, { "value": "Equity.Equity.OtherFreeReserves", "type": "String", "displayName": "Other Free Reserves", "required": false }, { "value": "Equity.Equity.ShareApplicationMoneyPendingAllotment", "type": "String", "displayName": "Share Application Money Pending Allotment", "required": false }, { "value": "Equity.Equity.ShareCapital", "type": "String", "displayName": "Share Capital", "required": false }, { "value": "Equity.Equity.Funds", "type": "String", "displayName": "Funds", "required": false } ], "required": true } }, "required": true } }, "QuickBooks Online": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": false, "validation": { "warnings": [], "information": [ { "field": "NominalCode", "details": "If included must have a length between 1 and 7 characters" } ] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true, "validation": { "warnings": [ { "field": "Name", "details": "Must have a length between 1 and 100 characters" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the account", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "When not specified company base currency will be used" } ] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "Asset.Bank.CashOnHand", "type": "String", "displayName": "Cash On Hand", "required": false }, { "value": "Asset.Bank.Checking", "type": "String", "displayName": "Checking", "required": false }, { "value": "Asset.Bank.MoneyMarket", "type": "String", "displayName": "Money Market", "required": false }, { "value": "Asset.Bank.RentsHeldInTrust", "type": "String", "displayName": "Rents Held In Trust", "required": false }, { "value": "Asset.Bank.Savings", "type": "String", "displayName": "Savings", "required": false }, { "value": "Asset.Bank.TrustAccounts", "type": "String", "displayName": "Trust Accounts", "required": false }, { "value": "Asset.Bank.CashAndCashEquivalents", "type": "String", "displayName": "Cash And Cash Equivalents", "required": false }, { "value": "Asset.Bank.OtherEarmarkedBankAccounts", "type": "String", "displayName": "Other Earmarked Bank Accounts", "required": false }, { "value": "Asset.Other Current Asset.AllowanceForBadDebts", "type": "String", "displayName": "Allowance For Bad Debts", "required": false }, { "value": "Asset.Other Current Asset.DevelopmentCosts", "type": "String", "displayName": "Development Costs", "required": false }, { "value": "Asset.Other Current Asset.EmployeeCashAdvances", "type": "String", "displayName": "Employee Cash Advances", "required": false }, { "value": "Asset.Other Current Asset.OtherCurrentAssets", "type": "String", "displayName": "Other Current Assets", "required": false }, { "value": "Asset.Other Current Asset.Inventory", "type": "String", "displayName": "Inventory", "required": false }, { "value": "Asset.Other Current Asset.Investment_MortgageRealEstateLoans", "type": "String", "displayName": "Investment Mortgage Real Estate Loans", "required": false }, { "value": "Asset.Other Current Asset.Investment_Other", "type": "String", "displayName": "Investment Other", "required": false }, { "value": "Asset.Other Current Asset.Investment_TaxExemptSecurities", "type": "String", "displayName": "Investment Tax Exempt Securities", "required": false }, { "value": "Asset.Other Current Asset.Investment_USGovernmentObligations", "type": "String", "displayName": "Investment US Government Obligations", "required": false }, { "value": "Asset.Other Current Asset.LoansToOfficers", "type": "String", "displayName": "Loans To Officers", "required": false }, { "value": "Asset.Other Current Asset.LoansToOthers", "type": "String", "displayName": "Loans To Others", "required": false }, { "value": "Asset.Other Current Asset.LoansToStockholders", "type": "String", "displayName": "Loans To Stockholders", "required": false }, { "value": "Asset.Other Current Asset.PrepaidExpenses", "type": "String", "displayName": "Prepaid Expenses", "required": false }, { "value": "Asset.Other Current Asset.Retainage", "type": "String", "displayName": "Retainage", "required": false }, { "value": "Asset.Other Current Asset.UndepositedFunds", "type": "String", "displayName": "Undeposited Funds", "required": false }, { "value": "Asset.Other Current Asset.AssetsAvailableForSale", "type": "String", "displayName": "Assets Available For Sale", "required": false }, { "value": "Asset.Other Current Asset.BalWithGovtAuthorities", "type": "String", "displayName": "Balance With Govt Authorities", "required": false }, { "value": "Asset.Other Current Asset.CalledUpShareCapitalNotPaid", "type": "String", "displayName": "Called Up Share Capital Not Paid", "required": false }, { "value": "Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit", "type": "String", "displayName": "Expenditure Authorisations And Letters Of Credit", "required": false }, { "value": "Asset.Other Current Asset.GlobalTaxDeferred", "type": "String", "displayName": "Global Tax Deferred", "required": false }, { "value": "Asset.Other Current Asset.GlobalTaxRefund", "type": "String", "displayName": "Global Tax Refund", "required": false }, { "value": "Asset.Other Current Asset.InternalTransfers", "type": "String", "displayName": "Internal Transfers", "required": false }, { "value": "Asset.Other Current Asset.OtherConsumables", "type": "String", "displayName": "Other Consumables", "required": false }, { "value": "Asset.Other Current Asset.ProvisionsCurrentAssets", "type": "String", "displayName": "Provisions Current Assets", "required": false }, { "value": "Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties", "type": "String", "displayName": "Short Term Investments In Related Parties", "required": false }, { "value": "Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties", "type": "String", "displayName": "Short Term Loans And Advances To Related Parties", "required": false }, { "value": "Asset.Other Current Asset.TradeAndOtherReceivables", "type": "String", "displayName": "Trade And Other Receivables", "required": false }, { "value": "Asset.Fixed Asset.AccumulatedDepletion", "type": "String", "displayName": "Accumulated Depletion", "required": false }, { "value": "Asset.Fixed Asset.AccumulatedDepreciation", "type": "String", "displayName": "Accumulated Depreciation", "required": false }, { "value": "Asset.Fixed Asset.DepletableAssets", "type": "String", "displayName": "Depletable Assets", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetComputers", "type": "String", "displayName": "Fixed Asset Computers", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetCopiers", "type": "String", "displayName": "Fixed Asset Copiers", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetFurniture", "type": "String", "displayName": "Fixed Asset Furniture", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetPhone", "type": "String", "displayName": "Fixed Asset Phone", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetPhotoVideo", "type": "String", "displayName": "Fixed Asset Photo Video", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetSoftware", "type": "String", "displayName": "Fixed Asset Software", "required": false }, { "value": "Asset.Fixed Asset.FixedAssetOtherToolsEquipment", "type": "String", "displayName": "Fixed Asset Other Tools Equipment", "required": false }, { "value": "Asset.Fixed Asset.FurnitureAndFixtures", "type": "String", "displayName": "Furniture And Fixtures", "required": false }, { "value": "Asset.Fixed Asset.Land", "type": "String", "displayName": "Land", "required": false }, { "value": "Asset.Fixed Asset.LeaseholdImprovements", "type": "String", "displayName": "Leasehold Improvements", "required": false }, { "value": "Asset.Fixed Asset.OtherFixedAssets", "type": "String", "displayName": "Other Fixed Assets", "required": false }, { "value": "Asset.Fixed Asset.AccumulatedAmortization", "type": "String", "displayName": "Accumulated Amortization", "required": false }, { "value": "Asset.Fixed Asset.Buildings", "type": "String", "displayName": "Buildings", "required": false }, { "value": "Asset.Fixed Asset.IntangibleAssets", "type": "String", "displayName": "Intangible Assets", "required": false }, { "value": "Asset.Fixed Asset.MachineryAndEquipment", "type": "String", "displayName": "Machinery And Equipment", "required": false }, { "value": "Asset.Fixed Asset.Vehicles", "type": "String", "displayName": "Vehicles", "required": false }, { "value": "Asset.Fixed Asset.AssetsInCourseOfConstruction", "type": "String", "displayName": "Assets In Course Of Construction", "required": false }, { "value": "Asset.Fixed Asset.CapitalWip", "type": "String", "displayName": "Capital Wip", "required": false }, { "value": "Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets", "type": "String", "displayName": "Cumulative Depreciation On Intangible Assets", "required": false }, { "value": "Asset.Fixed Asset.IntangibleAssetsUnderDevelopment", "type": "String", "displayName": "Intangible Assets Under Development", "required": false }, { "value": "Asset.Fixed Asset.LandAsset", "type": "String", "displayName": "Land Asset", "required": false }, { "value": "Asset.Fixed Asset.NonCurrentAssets", "type": "String", "displayName": "Non Current Assets", "required": false }, { "value": "Asset.Fixed Asset.ParticipatingInterests", "type": "String", "displayName": "Participating Interests", "required": false }, { "value": "Asset.Fixed Asset.ProvisionsFixedAssets", "type": "String", "displayName": "Provisions Fixed Assets", "required": false }, { "value": "Asset.Other Asset.LeaseBuyout", "type": "String", "displayName": "Lease Buyout", "required": false }, { "value": "Asset.Other Asset.OtherLongTermAssets", "type": "String", "displayName": "Other Long Term Assets", "required": false }, { "value": "Asset.Other Asset.SecurityDeposits", "type": "String", "displayName": "Security Deposits", "required": false }, { "value": "Asset.Other Asset.AccumulatedAmortizationOfOtherAssets", "type": "String", "displayName": "Accumulated Amortization Of Other Assets", "required": false }, { "value": "Asset.Other Asset.Goodwill", "type": "String", "displayName": "Goodwill", "required": false }, { "value": "Asset.Other Asset.Licenses", "type": "String", "displayName": "Licenses", "required": false }, { "value": "Asset.Other Asset.OrganizationalCosts", "type": "String", "displayName": "Organizational Costs", "required": false }, { "value": "Asset.Other Asset.AssetsHeldForSale", "type": "String", "displayName": "Assets Held For Sale", "required": false }, { "value": "Asset.Other Asset.AvailableForSaleFinancialAssets", "type": "String", "displayName": "Available For Sale Financial Assets", "required": false }, { "value": "Asset.Other Asset.DeferredTax", "type": "String", "displayName": "Deferred Tax", "required": false }, { "value": "Asset.Other Asset.Investments", "type": "String", "displayName": "Investments", "required": false }, { "value": "Asset.Other Asset.LongTermInvestments", "type": "String", "displayName": "Long Term Investments", "required": false }, { "value": "Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties", "type": "String", "displayName": "Long Term Loans And Advances To Related Parties", "required": false }, { "value": "Asset.Other Asset.OtherIntangibleAssets", "type": "String", "displayName": "Other Intangible Assets", "required": false }, { "value": "Asset.Other Asset.OtherLongTermInvestments", "type": "String", "displayName": "Other Long Term Investments", "required": false }, { "value": "Asset.Other Asset.OtherLongTermLoansAndAdvances", "type": "String", "displayName": "Other Long Term Loans And Advances", "required": false }, { "value": "Asset.Other Asset.PrepaymentsAndAccruedIncome", "type": "String", "displayName": "Prepayments And Accrued Income", "required": false }, { "value": "Asset.Other Asset.ProvisionsNonCurrentAssets", "type": "String", "displayName": "Provisions Non-Current Assets", "required": false }, { "value": "Asset.Accounts Receivable.AccountsReceivable", "type": "String", "displayName": "Accounts Receivable", "required": false }, { "value": "Expense.Expense.AdvertisingPromotional", "type": "String", "displayName": "Advertising/Promotional", "required": false }, { "value": "Expense.Expense.BadDebts", "type": "String", "displayName": "Bad Debts", "required": false }, { "value": "Expense.Expense.BankCharges", "type": "String", "displayName": "Bank Charges", "required": false }, { "value": "Expense.Expense.CharitableContributions", "type": "String", "displayName": "Charitable Contributions", "required": false }, { "value": "Expense.Expense.CommissionsAndFees", "type": "String", "displayName": "Commissions And Fees", "required": false }, { "value": "Expense.Expense.Entertainment", "type": "String", "displayName": "Entertainment", "required": false }, { "value": "Expense.Expense.EntertainmentMeals", "type": "String", "displayName": "Entertainment Meals", "required": false }, { "value": "Expense.Expense.EquipmentRental", "type": "String", "displayName": "Equipment Rental", "required": false }, { "value": "Expense.Expense.FinanceCosts", "type": "String", "displayName": "Finance Costs", "required": false }, { "value": "Expense.Expense.GlobalTaxExpense", "type": "String", "displayName": "Global Tax Expense", "required": false }, { "value": "Expense.Expense.Insurance", "type": "String", "displayName": "Insurance", "required": false }, { "value": "Expense.Expense.InterestPaid", "type": "String", "displayName": "Interest Paid", "required": false }, { "value": "Expense.Expense.LegalProfessionalFees", "type": "String", "displayName": "Legal And Professional Fees", "required": false }, { "value": "Expense.Expense.OfficeExpenses", "type": "String", "displayName": "Office Expenses", "required": false }, { "value": "Expense.Expense.OfficeGeneralAdministrativeExpenses", "type": "String", "displayName": "Office/General Administrative Expenses", "required": false }, { "value": "Expense.Expense.OtherBusinessExpenses", "type": "String", "displayName": "Other Business Expenses", "required": false }, { "value": "Expense.Expense.OtherMiscellaneousServiceCost", "type": "String", "displayName": "Other Miscellaneous Service Cost", "required": false }, { "value": "Expense.Expense.PromotionalMeals", "type": "String", "displayName": "Promotional Meals", "required": false }, { "value": "Expense.Expense.RentOrLeaseOfBuildings", "type": "String", "displayName": "Rent Or Lease Of Buildings", "required": false }, { "value": "Expense.Expense.RepairMaintenance", "type": "String", "displayName": "Repair And Maintenance", "required": false }, { "value": "Expense.Expense.ShippingFreightDelivery", "type": "String", "displayName": "Shipping, Freight And Delivery", "required": false }, { "value": "Expense.Expense.SuppliesMaterials", "type": "String", "displayName": "Supplies And Materials", "required": false }, { "value": "Expense.Expense.Travel", "type": "String", "displayName": "Travel", "required": false }, { "value": "Expense.Expense.TravelMeals", "type": "String", "displayName": "Travel Meals", "required": false }, { "value": "Expense.Expense.Utilities", "type": "String", "displayName": "Utilities", "required": false }, { "value": "Expense.Expense.Auto", "type": "String", "displayName": "Auto", "required": false }, { "value": "Expense.Expense.CostOfLabor", "type": "String", "displayName": "Cost Of Labor", "required": false }, { "value": "Expense.Expense.DuesSubscriptions", "type": "String", "displayName": "Dues And Subscriptions", "required": false }, { "value": "Expense.Expense.PayrollExpenses", "type": "String", "displayName": "Payroll Expenses", "required": false }, { "value": "Expense.Expense.TaxesPaid", "type": "String", "displayName": "Taxes Paid", "required": false }, { "value": "Expense.Expense.UnappliedCashBillPaymentExpense", "type": "String", "displayName": "Unapplied Cash Bill Payment Expense", "required": false }, { "value": "Expense.Expense.Utilities", "type": "String", "displayName": "Utilities", "required": false }, { "value": "Expense.Expense.AmortizationExpense", "type": "String", "displayName": "Amortization Expense", "required": false }, { "value": "Expense.Expense.AppropriationsToDepreciation", "type": "String", "displayName": "Appropriations To Depreciation", "required": false }, { "value": "Expense.Expense.BorrowingCost", "type": "String", "displayName": "Borrowing Cost", "required": false }, { "value": "Expense.Expense.CommissionsAndFees", "type": "String", "displayName": "Commissions And Fees", "required": false }, { "value": "Expense.Expense.DistributionCosts", "type": "String", "displayName": "Distribution Costs", "required": false }, { "value": "Expense.Expense.ExternalServices", "type": "String", "displayName": "External Services", "required": false }, { "value": "Expense.Expense.ExtraordinaryCharges", "type": "String", "displayName": "Extraordinary Charges", "required": false }, { "value": "Expense.Expense.IncomeTaxExpense", "type": "String", "displayName": "Income Tax Expense", "required": false }, { "value": "Expense.Expense.LossOnDiscontinuedOperationsNetOfTax", "type": "String", "displayName": "Loss On Discontinued Operations Net Of Tax", "required": false }, { "value": "Expense.Expense.ManagementCompensation", "type": "String", "displayName": "Management Compensation", "required": false }, { "value": "Expense.Expense.OtherCurrentOperatingCharges", "type": "String", "displayName": "Other Current Operating Charges", "required": false }, { "value": "Expense.Expense.OtherExternalServices", "type": "String", "displayName": "Other External Services", "required": false }, { "value": "Expense.Expense.OtherRentalCosts", "type": "String", "displayName": "Other Rental Costs", "required": false }, { "value": "Expense.Expense.OtherSellingExpenses", "type": "String", "displayName": "Other Selling Expenses", "required": false }, { "value": "Expense.Expense.ProjectStudiesSurveysAssessments", "type": "String", "displayName": "Project Studies Surveys Assessments", "required": false }, { "value": "Expense.Expense.PurchasesRebates", "type": "String", "displayName": "Purchases Rebates", "required": false }, { "value": "Expense.Expense.ShippingAndDeliveryExpense", "type": "String", "displayName": "Shipping And Delivery Expense", "required": false }, { "value": "Expense.Expense.StaffCosts", "type": "String", "displayName": "Staff Costs", "required": false }, { "value": "Expense.Expense.Sundry", "type": "String", "displayName": "Sundry", "required": false }, { "value": "Expense.Expense.TravelExpensesGeneralAndAdminExpenses", "type": "String", "displayName": "Travel Expenses General And Admin Expenses", "required": false }, { "value": "Expense.Expense.TravelExpensesSellingExpense", "type": "String", "displayName": "Travel Expenses Selling Expense", "required": false }, { "value": "Expense.Other Expense.Depreciation", "type": "String", "displayName": "Depreciation", "required": false }, { "value": "Expense.Other Expense.ExchangeGainOrLoss", "type": "String", "displayName": "Exchange Gain Or Loss", "required": false }, { "value": "Expense.Other Expense.OtherMiscellaneousExpense", "type": "String", "displayName": "Other Miscellaneous Expense", "required": false }, { "value": "Expense.Other Expense.PenaltiesSettlements", "type": "String", "displayName": "Penalties And Settlements", "required": false }, { "value": "Expense.Other Expense.Amortization", "type": "String", "displayName": "Amortization", "required": false }, { "value": "Expense.Other Expense.GasAndFuel", "type": "String", "displayName": "Gas And Fuel", "required": false }, { "value": "Expense.Other Expense.HomeOffice", "type": "String", "displayName": "Home Office", "required": false }, { "value": "Expense.Other Expense.HomeOwnerRentalInsurance", "type": "String", "displayName": "Home Owner Rental Insurance", "required": false }, { "value": "Expense.Other Expense.OtherHomeOfficeExpenses", "type": "String", "displayName": "Other Home Office Expenses", "required": false }, { "value": "Expense.Other Expense.MortgageInterest", "type": "String", "displayName": "Mortgage Interest", "required": false }, { "value": "Expense.Other Expense.RentAndLease", "type": "String", "displayName": "Rent And Lease", "required": false }, { "value": "Expense.Other Expense.RepairsAndMaintenance", "type": "String", "displayName": "Repairs And Maintenance", "required": false }, { "value": "Expense.Other Expense.ParkingAndTolls", "type": "String", "displayName": "Parking And Tolls", "required": false }, { "value": "Expense.Other Expense.Vehicle", "type": "String", "displayName": "Vehicle", "required": false }, { "value": "Expense.Other Expense.VehicleInsurance", "type": "String", "displayName": "Vehicle Insurance", "required": false }, { "value": "Expense.Other Expense.VehicleLease", "type": "String", "displayName": "Vehicle Lease", "required": false }, { "value": "Expense.Other Expense.VehicleLoanInterest", "type": "String", "displayName": "Vehicle Loan Interest", "required": false }, { "value": "Expense.Other Expense.VehicleLoan", "type": "String", "displayName": "Vehicle Loan", "required": false }, { "value": "Expense.Other Expense.VehicleRegistration", "type": "String", "displayName": "Vehicle Registration", "required": false }, { "value": "Expense.Other Expense.VehicleRepairs", "type": "String", "displayName": "Vehicle Repairs", "required": false }, { "value": "Expense.Other Expense.OtherVehicleExpenses", "type": "String", "displayName": "Other Vehicle Expenses", "required": false }, { "value": "Expense.Other Expense.Utilities", "type": "String", "displayName": "Utilities", "required": false }, { "value": "Expense.Other Expense.WashAndRoadServices", "type": "String", "displayName": "Wash And Road Services", "required": false }, { "value": "Expense.Other Expense.DeferredTaxExpense", "type": "String", "displayName": "Deferred Tax Expense", "required": false }, { "value": "Expense.Other Expense.Depletion", "type": "String", "displayName": "Depletion", "required": false }, { "value": "Expense.Other Expense.ExceptionalItems", "type": "String", "displayName": "Exceptional Items", "required": false }, { "value": "Expense.Other Expense.ExtraordinaryItems", "type": "String", "displayName": "Extraordinary Items", "required": false }, { "value": "Expense.Other Expense.IncomeTaxOtherExpense", "type": "String", "displayName": "Income Tax Other Expense", "required": false }, { "value": "Expense.Other Expense.MatCredit", "type": "String", "displayName": "Mat Credit", "required": false }, { "value": "Expense.Other Expense.PriorPeriodItems", "type": "String", "displayName": "Prior Period Items", "required": false }, { "value": "Expense.Other Expense.TaxRoundoffGainOrLoss", "type": "String", "displayName": "Tax Roundoff Gain Or Loss", "required": false }, { "value": "Expense.Cost of Goods Sold.EquipmentRentalCos", "type": "String", "displayName": "Equipment Rental - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.OtherCostsOfServiceCos", "type": "String", "displayName": "Other Costs Of Sales - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.ShippingFreightDeliveryCos", "type": "String", "displayName": "Shipping, Freight And Delivery - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.SuppliesMaterialsCogs", "type": "String", "displayName": "Supplies And Materials - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.CostOfLaborCos", "type": "String", "displayName": "Cost Of Labor - COS", "required": false }, { "value": "Expense.Cost of Goods Sold.CostOfSales", "type": "String", "displayName": "Cost Of Sales", "required": false }, { "value": "Expense.Cost of Goods Sold.FreightAndDeliveryCost", "type": "String", "displayName": "Freight And Delivery Cost", "required": false }, { "value": "Income.Income.NonProfitIncome", "type": "String", "displayName": "Non Profit Income", "required": false }, { "value": "Income.Income.OtherPrimaryIncome", "type": "String", "displayName": "Other Primary Income", "required": false }, { "value": "Income.Income.SalesOfProductIncome", "type": "String", "displayName": "Sales Of ProductIncome", "required": false }, { "value": "Income.Income.ServiceFeeIncome", "type": "String", "displayName": "Service Fee Income", "required": false }, { "value": "Income.Income.DiscountsRefundsGiven", "type": "String", "displayName": "Discounts Refunds Given", "required": false }, { "value": "Income.Income.UnappliedCashPaymentIncome", "type": "String", "displayName": "Unapplied Cash Payment Income", "required": false }, { "value": "Income.Income.CashReceiptIncome", "type": "String", "displayName": "Cash Receipt Income", "required": false }, { "value": "Income.Income.OperatingGrants", "type": "String", "displayName": "Operating Grants", "required": false }, { "value": "Income.Income.OtherCurrentOperatingIncome", "type": "String", "displayName": "Other Current Operating Income", "required": false }, { "value": "Income.Income.OwnWorkCapitalized", "type": "String", "displayName": "Own Work Capitalized", "required": false }, { "value": "Income.Income.RevenueGeneral", "type": "String", "displayName": "Revenue General", "required": false }, { "value": "Income.Income.SalesRetail", "type": "String", "displayName": "Sales Retail", "required": false }, { "value": "Income.Income.SalesWholesale", "type": "String", "displayName": "Sales Wholesale", "required": false }, { "value": "Income.Income.SavingsByTaxScheme", "type": "String", "displayName": "Savings By Tax Scheme", "required": false }, { "value": "Income.Other Income.DividendIncome", "type": "String", "displayName": "Dividend Income", "required": false }, { "value": "Income.Other Income.InterestEarned", "type": "String", "displayName": "Interest Earned", "required": false }, { "value": "Income.Other Income.OtherInvestmentIncome", "type": "String", "displayName": "Other Investment Income", "required": false }, { "value": "Income.Other Income.OtherMiscellaneousIncome", "type": "String", "displayName": "Other Miscellaneous Income", "required": false }, { "value": "Income.Other Income.TaxExemptInterest", "type": "String", "displayName": "Tax Exempt Interest", "required": false }, { "value": "Income.Other Income.GainLossOnSaleOfFixedAssets", "type": "String", "displayName": "Gain Loss On Sale Of Fixed Assets", "required": false }, { "value": "Income.Other Income.GainLossOnSaleOfInvestments", "type": "String", "displayName": "Gain Loss On Sale Of Investments", "required": false }, { "value": "Income.Other Income.LossOnDisposalOfAssets", "type": "String", "displayName": "Loss On Disposal Of Assets", "required": false }, { "value": "Income.Other Income.OtherOperatingIncome", "type": "String", "displayName": "Other Operating Income", "required": false }, { "value": "Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax", "type": "String", "displayName": "Unrealised Loss On Securities Net Of Tax", "required": false }, { "value": "Liability.Accounts Payable.AccountsPayable", "type": "String", "displayName": "Accounts Payable", "required": false }, { "value": "Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise", "type": "String", "displayName": "Outstanding Dues Micro Small Enterprise", "required": false }, { "value": "Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise", "type": "String", "displayName": "Outstanding Dues Other Than Micro Small Enterprise", "required": false }, { "value": "Liability.Credit Card.CreditCard", "type": "String", "displayName": "Credit Card", "required": false }, { "value": "Liability.Long Term Liability.NotesPayable", "type": "String", "displayName": "Notes Payable", "required": false }, { "value": "Liability.Long Term Liability.OtherLongTermLiabilities", "type": "String", "displayName": "Other Long Term Liabilities", "required": false }, { "value": "Liability.Long Term Liability.ShareholderNotesPayable", "type": "String", "displayName": "Shareholder Notes Payable", "required": false }, { "value": "Liability.Long Term Liability.AccrualsAndDeferredIncome", "type": "String", "displayName": "Accruals And Deferred Income", "required": false }, { "value": "Liability.Long Term Liability.AccruedLongLermLiabilities", "type": "String", "displayName": "Accrued Long Lerm Liabilities", "required": false }, { "value": "Liability.Long Term Liability.AccruedVacationPayable", "type": "String", "displayName": "Accrued Vacation Payable", "required": false }, { "value": "Liability.Long Term Liability.BankLoans", "type": "String", "displayName": "Bank Loans", "required": false }, { "value": "Liability.Long Term Liability.DebtsRelatedToParticipatingInterests", "type": "String", "displayName": "Debts Related To Participating Interests", "required": false }, { "value": "Liability.Long Term Liability.DeferredTaxLiabilities", "type": "String", "displayName": "Deferred Tax Liabilities", "required": false }, { "value": "Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities", "type": "String", "displayName": "Government And Other Public Authorities", "required": false }, { "value": "Liability.Long Term Liability.GroupAndAssociates", "type": "String", "displayName": "Group And Associates", "required": false }, { "value": "Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale", "type": "String", "displayName": "Liabilities Related To Assets Held For Sale", "required": false }, { "value": "Liability.Long Term Liability.LongTermBorrowings", "type": "String", "displayName": "Long Term Borrowings", "required": false }, { "value": "Liability.Long Term Liability.LongTermDebit", "type": "String", "displayName": "Long Term Debit", "required": false }, { "value": "Liability.Long Term Liability.LongTermEmployeeBenefitObligations", "type": "String", "displayName": "Long Term Employee Benefit Obligations", "required": false }, { "value": "Liability.Long Term Liability.ObligationsUnderFinanceLeases", "type": "String", "displayName": "Obligations Under Finance Leases", "required": false }, { "value": "Liability.Long Term Liability.OtherLongTermProvisions", "type": "String", "displayName": "Other Long Term Provisions", "required": false }, { "value": "Liability.Long Term Liability.ProvisionForLiabilities", "type": "String", "displayName": "Provision For Liabilities", "required": false }, { "value": "Liability.Long Term Liability.ProvisionsNonCurrentLiabilities", "type": "String", "displayName": "Provisions Non Current Liabilities", "required": false }, { "value": "Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts", "type": "String", "displayName": "Staff And Related Long Term Liability Accounts", "required": false }, { "value": "Liability.Other Current Liability.DirectDepositPayable", "type": "String", "displayName": "Direct Deposit Payable", "required": false }, { "value": "Liability.Other Current Liability.LineOfCredit", "type": "String", "displayName": "Line Of Credit", "required": false }, { "value": "Liability.Other Current Liability.LoanPayable", "type": "String", "displayName": "Loan Payable", "required": false }, { "value": "Liability.Other Current Liability.GlobalTaxPayable", "type": "String", "displayName": "Global Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.GlobalTaxSuspense", "type": "String", "displayName": "Global Tax Suspense", "required": false }, { "value": "Liability.Other Current Liability.OtherCurrentLiabilities", "type": "String", "displayName": "Other Current Liabilities", "required": false }, { "value": "Liability.Other Current Liability.PayrollClearing", "type": "String", "displayName": "Payroll Clearing", "required": false }, { "value": "Liability.Other Current Liability.PayrollTaxPayable", "type": "String", "displayName": "Payroll Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.PrepaidExpensesPayable", "type": "String", "displayName": "Prepaid Expenses Payable", "required": false }, { "value": "Liability.Other Current Liability.RentsInTrustLiability", "type": "String", "displayName": "Rents In Trust Liability", "required": false }, { "value": "Liability.Other Current Liability.TrustAccountsLiabilities", "type": "String", "displayName": "Trust Accounts Liabilities", "required": false }, { "value": "Liability.Other Current Liability.FederalIncomeTaxPayable", "type": "String", "displayName": "Federal Income Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.InsurancePayable", "type": "String", "displayName": "Insurance Payable", "required": false }, { "value": "Liability.Other Current Liability.SalesTaxPayable", "type": "String", "displayName": "Sales Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.StateLocalIncomeTaxPayable", "type": "String", "displayName": "State Local Income Tax Payable", "required": false }, { "value": "Liability.Other Current Liability.AccruedLiabilities", "type": "String", "displayName": "Accrued Liabilities", "required": false }, { "value": "Liability.Other Current Liability.CurrentLiabilities", "type": "String", "displayName": "Current Liabilities", "required": false }, { "value": "Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations", "type": "String", "displayName": "Current Portion EmployeeBenefits Obligations", "required": false }, { "value": "Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases", "type": "String", "displayName": "Current Portion Of Obligations Under Finance Leases", "required": false }, { "value": "Liability.Other Current Liability.CurrentTaxLiability", "type": "String", "displayName": "Current Tax Liability", "required": false }, { "value": "Liability.Other Current Liability.DividendsPayable", "type": "String", "displayName": "Dividends Payable", "required": false }, { "value": "Liability.Other Current Liability.DutiesAndTaxes", "type": "String", "displayName": "Duties And Taxes", "required": false }, { "value": "Liability.Other Current Liability.InterestPayables", "type": "String", "displayName": "Interest Payables", "required": false }, { "value": "Liability.Other Current Liability.ProvisionForWarrantyObligations", "type": "String", "displayName": "Provision For Warranty Obligations", "required": false }, { "value": "Liability.Other Current Liability.ProvisionsCurrentLiabilities", "type": "String", "displayName": "Provisions Current Liabilities", "required": false }, { "value": "Liability.Other Current Liability.ShortTermBorrowings", "type": "String", "displayName": "Short Term Borrowings", "required": false }, { "value": "Liability.Other Current Liability.SocialSecurityAgencies", "type": "String", "displayName": "Social Security Agencies", "required": false }, { "value": "Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts", "type": "String", "displayName": "Staff And Related Liability Accounts", "required": false }, { "value": "Liability.Other Current Liability.SundryDebtorsAndCreditors", "type": "String", "displayName": "Sundry Debtors And Creditors", "required": false }, { "value": "Liability.Other Current Liability.TradeAndOtherPayables", "type": "String", "displayName": "Trade And Other Payables", "required": false }, { "value": "Equity.Equity.OpeningBalanceEquity", "type": "String", "displayName": "Opening Balance Equity", "required": false }, { "value": "Equity.Equity.PartnersEquity", "type": "String", "displayName": "Partners Equity", "required": false }, { "value": "Equity.Equity.RetainedEarnings", "type": "String", "displayName": "Retained Earnings", "required": false }, { "value": "Equity.Equity.AccumulatedAdjustment", "type": "String", "displayName": "Accumulated Adjustment", "required": false }, { "value": "Equity.Equity.OwnersEquity", "type": "String", "displayName": "Owners Equity", "required": false }, { "value": "Equity.Equity.PaidInCapitalOrSurplus", "type": "String", "displayName": "Paid In Capital Or Surplus", "required": false }, { "value": "Equity.Equity.PartnerContributions", "type": "String", "displayName": "Partner Contributions", "required": false }, { "value": "Equity.Equity.PartnerDistributions", "type": "String", "displayName": "Partner Distributions", "required": false }, { "value": "Equity.Equity.PreferredStock", "type": "String", "displayName": "Preferred Stock", "required": false }, { "value": "Equity.Equity.CommonStock", "type": "String", "displayName": "Common Stock", "required": false }, { "value": "Equity.Equity.TreasuryStock", "type": "String", "displayName": "Treasury Stock", "required": false }, { "value": "Equity.Equity.EstimatedTaxes", "type": "String", "displayName": "Estimated Taxes", "required": false }, { "value": "Equity.Equity.Healthcare", "type": "String", "displayName": "Healthcare", "required": false }, { "value": "Equity.Equity.PersonalIncome", "type": "String", "displayName": "Personal Income", "required": false }, { "value": "Equity.Equity.PersonalExpense", "type": "String", "displayName": "Personal Expense", "required": false }, { "value": "Equity.Equity.AccumulatedOtherComprehensiveIncome", "type": "String", "displayName": "Accumulated Other Comprehensive Income", "required": false }, { "value": "Equity.Equity.CalledUpShareCapital", "type": "String", "displayName": "Called Up Share Capital", "required": false }, { "value": "Equity.Equity.CapitalReserves", "type": "String", "displayName": "Capital Reserves", "required": false }, { "value": "Equity.Equity.DividendDisbursed", "type": "String", "displayName": "Dividend Disbursed", "required": false }, { "value": "Equity.Equity.EquityInEarningsOfSubsiduaries", "type": "String", "displayName": "Equity In Earnings Of Subsiduaries", "required": false }, { "value": "Equity.Equity.InvestmentGrants", "type": "String", "displayName": "Investment Grants", "required": false }, { "value": "Equity.Equity.MoneyReceivedAgainstShareWarrants", "type": "String", "displayName": "Money Received Against Share Warrants", "required": false }, { "value": "Equity.Equity.OtherFreeReserves", "type": "String", "displayName": "Other Free Reserves", "required": false }, { "value": "Equity.Equity.ShareApplicationMoneyPendingAllotment", "type": "String", "displayName": "Share Application Money Pending Allotment", "required": false }, { "value": "Equity.Equity.ShareCapital", "type": "String", "displayName": "Share Capital", "required": false }, { "value": "Equity.Equity.Funds", "type": "String", "displayName": "Funds", "required": false } ], "required": true } }, "required": true } }, "Sage Business Cloud Accounting": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "Name", "details": "Should not be longer than 200 characters." } ] } }, "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [], "information": [ { "field": "NominalCode", "details": "Should be a number between 1 and 99999999." } ] } }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "options": [ { "value": "SALES", "type": "String", "displayName": "Sales", "required": false }, { "value": "OTHER_INCOME", "type": "String", "displayName": "Other Income", "required": false }, { "value": "DIRECT_EXPENSES", "type": "String", "displayName": "Direct Expenses", "required": false }, { "value": "OVERHEADS", "type": "String", "displayName": "Overheads", "required": false }, { "value": "DEPRECIATION", "type": "String", "displayName": "Depreciation", "required": false }, { "value": "CURRENT_ASSETS", "type": "String", "displayName": "Current Assets", "required": false }, { "value": "FIXED_ASSETS", "type": "String", "displayName": "Fixed Assets", "required": false }, { "value": "FUTURE_ASSETS", "type": "String", "displayName": "Future Assets", "required": false }, { "value": "BANK", "type": "String", "displayName": "Bank", "required": false }, { "value": "CURRENT_LIABILITY", "type": "String", "displayName": "Current Liability", "required": false }, { "value": "FUTURE_LIABILITY", "type": "String", "displayName": "Future Liability", "required": false }, { "value": "EQUITY", "type": "String", "displayName": "Equity", "required": false }, { "value": "LINE_OF_CREDIT", "type": "String", "displayName": "Credit Card / Loan", "required": false } ], "required": true } }, "required": true } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [ { "field": "NominalCode", "details": "Must be unique within the entity." }, { "field": "NominalCode", "details": "Must be at most 24 characters in length, although restrictions may vary between entities." } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true }, "status": { "type": "String", "displayName": "Account Status", "description": "The status of the account", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "type": { "type": "String", "displayName": "Account Type", "description": "The type, or base category, of the account", "options": [ { "value": "Asset", "type": "String", "displayName": "Asset", "required": false }, { "value": "Equity", "type": "String", "displayName": "Equity", "required": false }, { "value": "Expense", "type": "String", "displayName": "Expense", "required": false }, { "value": "Income", "type": "String", "displayName": "Income", "required": false }, { "value": "Liability", "type": "String", "displayName": "Liability", "required": false } ], "required": true }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "required": true, "validation": { "warnings": [], "information": [ { "field": "FullyQualifiedCategory", "details": "Any category that is part of the hierarchy of one of: 'Assets', 'Equity', 'Liabilities', 'Total Expenses' and 'Total Income' is permitted." } ] } } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true }, "description": { "type": "String", "displayName": "Description", "description": "Description of the account", "required": true }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "The full category of the account e.g. Liability.Current or Income.Revenue", "required": true }, "fullyQualifiedName": { "type": "String", "displayName": "Fully Qualified Name", "description": "The full name of the account e.g. Liability.Current.VAT or Income.Revenue.Sales", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the account", "required": true }, "currentBalance": { "type": "Number", "displayName": "Current Balance", "description": "The current balance in the account", "required": true }, "type": { "type": "String", "displayName": "Account Type", "description": "The type, or base category, of the account", "required": true }, "status": { "type": "String", "displayName": "Account Status", "description": "The status of the account", "required": true }, "isBankAccount": { "type": "Boolean", "displayName": "Is Bank Account?", "description": "Confirms whether the nominal account represents a bank account or not", "required": true }, "validDatatypeLinks": { "type": "Array", "displayName": "Valid Datatype Links", "description": "Describes which fields on other data types are valid links to this account in the originating system", "properties": { "property": { "type": "String", "displayName": "Property", "description": "The field on the source data type that other data types can link to", "required": true }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of absolute names of fields from other data types, e.g. Invoice.LineItems.AccountRef.Id", "required": true } }, "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Nominal Account", "description": "Nominal Accounts are the categories a business uses to record transactions", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "Identifier for the nominal account.", "required": true, "validation": { "warnings": [ { "field": "NominalCode", "details": "Max length of 10 characters." } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of account as it appears in the chart of accounts or general ledger.", "required": true, "validation": { "warnings": [], "information": [ { "field": "Name", "details": "Payments are enabled to this account if the name ends in .PaymentsEnabled." } ] } }, "description": { "type": "String", "displayName": "Description", "description": "Description for the nominal account.", "required": false }, "fullyQualifiedCategory": { "type": "String", "displayName": "Fully Qualified Category", "description": "Account type and category for nominal account.", "options": [ { "value": "Asset.Current", "type": "String", "displayName": "Current Asset", "required": false }, { "value": "Asset.Fixed", "type": "String", "displayName": "Fixed Asset", "required": false }, { "value": "Asset.Inventory", "type": "String", "displayName": "Inventory", "required": false }, { "value": "Asset.NonCurrent", "type": "String", "displayName": "Non-current Asset", "required": false }, { "value": "Asset.Prepayment", "type": "String", "displayName": "Prepayment", "required": false }, { "value": "Expense.DirectCosts", "type": "String", "displayName": "Direct Costs", "required": false }, { "value": "Expense.Expense", "type": "String", "displayName": "Expense", "required": false }, { "value": "Expense.Overhead", "type": "String", "displayName": "Overhead", "required": false }, { "value": "Expense.Superannuation", "type": "String", "displayName": "Superannuation", "required": false }, { "value": "Expense.Wages", "type": "String", "displayName": "Wages", "required": false }, { "value": "Income.Sales", "type": "String", "displayName": "Sales", "required": false }, { "value": "Income.Revenue", "type": "String", "displayName": "Revenue", "required": false }, { "value": "Income.Other", "type": "String", "displayName": "Other Income", "required": false }, { "value": "Liability.Current", "type": "String", "displayName": "Current Liability", "required": false }, { "value": "Liability.Depreciation", "type": "String", "displayName": "Depreciation", "required": false }, { "value": "Liability.Liability", "type": "String", "displayName": "Liability", "required": false }, { "value": "Liability.NonCurrent", "type": "String", "displayName": "Non Current Liability", "required": false }, { "value": "Liability.PayAsYouGo", "type": "String", "displayName": "Pay As You Go Liability", "required": false }, { "value": "Liability.Superannuation", "type": "String", "displayName": "Superannuation Liability", "required": false }, { "value": "Liability.WagesPayable", "type": "String", "displayName": "Wages Payable Liability", "required": false }, { "value": "Equity.Equity", "type": "String", "displayName": "Equity", "required": false } ], "required": true } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-chartOfAccounts-model", "description": "The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/accounting-api#/schemas/Account) for a given company and integration.\n\n[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/accounts": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Accounts" ], "summary": "Create account", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account/definitions/accountPrototype" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create account* endpoint creates a new [account](https://docs.codat.io/accounting-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/accounting-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account.\n", "operationId": "create-account" } }, "/companies/{companyId}/data/billCreditNotes": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Bill credit notes" ], "summary": "List bill credit notes", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillCreditNotes" }, "examples": { "Dynamics 365 Business Central": { "value": { "results": [ { "id": "0deaed0a-9f51-eb11-89f9-00224800af18", "billCreditNoteNumber": "109001", "supplierRef": { "id": "be1217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "Fabrikam, Inc." }, "withholdingTax": [], "totalAmount": 8, "totalDiscount": 0, "subTotal": 8, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 8, "status": "Submitted", "issueDate": "2020-12-21T00:00:00", "currency": "GBP", "lineItems": [ { "description": "Abdi Item No VAT", "unitAmount": 8, "quantity": 1, "discountAmount": 0, "subTotal": 8, "taxAmount": 0, "totalAmount": 8, "accountRef": { "id": "6a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Inventory" }, "discountPercentage": 0, "taxRateRef": { "id": "6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for EXPORT / ZERO", "effectiveTaxRate": 0 }, "itemRef": { "id": "ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT", "name": "Abdi Item No VAT / General Business Posting Group: 'EXPORT' / VAT Business Posting Group: 'EXPORT'" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2023-03-27T14:21:26Z", "metadata": { "isDeleted": false }, "note": "BCN001" }, { "id": "157c025f-a19e-eb11-8ce6-0022481a7bed", "billCreditNoteNumber": "109002", "supplierRef": { "id": "be1217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "Fabrikam, Inc." }, "withholdingTax": [], "totalAmount": 20, "totalDiscount": 0, "subTotal": 20, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 10, "status": "PartiallyPaid", "issueDate": "2021-01-26T00:00:00", "currency": "GBP", "lineItems": [ { "description": "Abdi Item No VAT", "unitAmount": 20, "quantity": 1, "discountAmount": 0, "subTotal": 20, "taxAmount": 0, "totalAmount": 20, "accountRef": { "id": "6a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Inventory" }, "discountPercentage": 0, "taxRateRef": { "id": "6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for EXPORT / ZERO", "effectiveTaxRate": 0 }, "itemRef": { "id": "ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT", "name": "Abdi Item No VAT / General Business Posting Group: 'EXPORT' / VAT Business Posting Group: 'EXPORT'" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "257c025f-a19e-eb11-8ce6-0022481a7bed", "note": "Credit Memo 1002", "reference": "109002", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-01-26T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2021-04-16T00:00:00", "totalAmount": 10 } } ], "modifiedDate": "2023-03-27T14:21:26Z", "metadata": { "isDeleted": false }, "note": "16042021" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 224, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "443bd109-e1ed-4de2-b1ab-3b13e980d288", "billCreditNoteNumber": "19600007", "supplierRef": { "id": "5e6f49b9-6489-4b82-83e7-291d308919bb", "supplierName": "Mickey Mouse" }, "withholdingTax": [], "totalAmount": 12.1, "totalDiscount": 0, "subTotal": 10, "totalTaxAmount": 2.1, "discountPercentage": 0, "remainingCredit": 12.1, "status": "Submitted", "issueDate": "2019-12-16T00:00:00Z", "currency": "EUR", "currencyRate": 1, "lineItems": [ { "description": "Cheesecake", "unitAmount": 10, "quantity": 1, "discountAmount": 0, "subTotal": 10, "taxAmount": 2.1, "totalAmount": 12.1, "accountRef": { "id": "5f139759-b554-4314-862e-b9d88e5b2e1b", "name": "Af te dragen loonheffing" }, "taxRateRef": { "id": "84277189-ad16-456c-b501-ca31f0a483cc", "name": "BTW prive gebruik", "effectiveTaxRate": 21 }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2022-10-26T13:32:18Z", "sourceModifiedDate": "2020-01-03T15:06:19Z" }, { "id": "6643f559-d7e9-4cfe-802f-60beddbc4ed9", "billCreditNoteNumber": "20600003", "supplierRef": { "id": "f87070e2-bbd7-4383-a7c9-824748c1d70e", "supplierName": "Exact Software Nederland B.V." }, "withholdingTax": [], "totalAmount": 13.57, "totalDiscount": 0, "subTotal": 13.57, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 13.57, "status": "Submitted", "issueDate": "2020-01-20T00:00:00Z", "currency": "EUR", "currencyRate": 1, "lineItems": [ { "description": "1 transactions of type CARD_PAYMENT_FEE_REFUND", "unitAmount": 13.57, "quantity": 1, "discountAmount": 0, "subTotal": 13.57, "totalAmount": 13.57, "accountRef": { "id": "f6c251f5-21d0-4164-9b8f-17789fd2fee9", "name": "Kosten werkgeverslasten vakantiegeld" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2022-10-26T13:32:18Z", "sourceModifiedDate": "2020-01-20T19:38:37Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 42, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "f9083d38-40c7-4b5f-a693-f4670e3d85bc", "billCreditNoteNumber": "19600008", "supplierRef": { "id": "1c703cce-967c-4476-a86a-32e35341a8f5", "supplierName": "Customer Bill Supplier" }, "withholdingTax": [], "totalAmount": 99999, "totalDiscount": 0, "subTotal": 99999, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 99999, "status": "Submitted", "issueDate": "2019-10-30T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Oil Change", "unitAmount": -150, "quantity": 1000.5, "discountAmount": 0, "subTotal": -150075, "totalAmount": -150075, "accountRef": { "id": "885ff551-664d-451b-995b-cb114c9877d0", "name": "Unallocated Cash" }, "itemRef": { "id": "3001" }, "trackingCategoryRefs": [] }, { "description": "description", "unitAmount": 250074, "quantity": 1, "discountAmount": 0, "subTotal": 250074, "totalAmount": 250074, "accountRef": { "id": "885ff551-664d-451b-995b-cb114c9877d0", "name": "Unallocated Cash" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2022-10-26T13:33:23Z", "sourceModifiedDate": "2019-10-30T13:12:56Z" }, { "id": "05023688-5bd5-4034-ae4c-5e3e5099bbfb", "billCreditNoteNumber": "19600009", "supplierRef": { "id": "1c703cce-967c-4476-a86a-32e35341a8f5", "supplierName": "Customer Bill Supplier" }, "withholdingTax": [], "totalAmount": 10, "totalDiscount": 0, "subTotal": 10, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 10, "status": "Submitted", "issueDate": "2019-11-01T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Credit note line item #5", "unitAmount": 10, "quantity": 1, "discountAmount": 0, "subTotal": 10, "totalAmount": 10, "accountRef": { "id": "62be6536-f4ea-49b8-9797-1adc23982334", "name": "Depreciation" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2022-10-26T13:33:23Z", "sourceModifiedDate": "2019-11-01T15:07:18Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 40, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "10665024", "billCreditNoteNumber": "Bill Credit", "supplierRef": { "id": "6161941", "supplierName": "A & J Fabtech Ltd" }, "withholdingTax": [], "totalAmount": 1500, "totalDiscount": 0, "subTotal": 1250, "totalTaxAmount": 250, "discountPercentage": 0, "remainingCredit": 1500, "status": "Submitted", "issueDate": "2018-08-22T00:00:00", "currency": "GBP", "lineItems": [ { "description": "A & J Fabtech Ltd - Bill Credit Note Bill Credit", "unitAmount": 1250, "quantity": 1, "taxAmount": 250, "totalAmount": 1500, "accountRef": { "id": "285", "name": "Accommodation and Meals" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2023-04-25T14:19:10Z", "sourceModifiedDate": "2018-08-22T13:22:08Z", "metadata": { "isDeleted": false } }, { "id": "11007024", "billCreditNoteNumber": "Draft test", "supplierRef": { "id": "6161963", "supplierName": "ABB Ltd" }, "withholdingTax": [], "totalAmount": 10, "totalDiscount": 0, "subTotal": 8.33, "totalTaxAmount": 1.67, "discountPercentage": 0, "remainingCredit": 10, "status": "Submitted", "issueDate": "2018-10-17T00:00:00", "currency": "GBP", "lineItems": [ { "description": "ABB Ltd - Bill Credit Note Draft test", "unitAmount": 8.33, "quantity": 1, "taxAmount": 1.67, "totalAmount": 10, "accountRef": { "id": "285", "name": "Accommodation and Meals" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2023-04-25T14:19:10Z", "sourceModifiedDate": "2018-10-17T12:56:54Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 45, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes?page=2&pageSize=2" } } } }, "KashFlow": { "value": { "results": [ { "id": "91339087", "billCreditNoteNumber": "5", "supplierRef": { "id": "6202387", "supplierName": "Dell" }, "withholdingTax": [], "totalAmount": 10, "totalDiscount": 0, "subTotal": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2020-02-25T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Oil refund", "unitAmount": 10, "quantity": 1, "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "accountRef": { "id": "21481832", "name": "Oil" }, "itemRef": { "id": "114817740" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2022-09-30T10:29:16Z" }, { "id": "91341939", "billCreditNoteNumber": "6", "supplierRef": { "id": "6202387", "supplierName": "Dell" }, "withholdingTax": [], "totalAmount": 240, "totalDiscount": 0, "subTotal": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2020-02-25T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "", "unitAmount": -200, "quantity": -1, "subTotal": 200, "taxAmount": -40, "totalAmount": 240, "accountRef": { "id": "21481820", "name": "Materials purchased" }, "itemRef": { "id": "114821376" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2022-09-30T10:29:16Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 8, "_links": { "current": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes" }, "next": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "1781", "billCreditNoteNumber": "VENDCRED1", "supplierRef": { "id": "749", "supplierName": "Jo's Cheese" }, "withholdingTax": [], "totalAmount": 174.6, "totalDiscount": 0, "subTotal": 145.5, "totalTaxAmount": 29.1, "discountPercentage": 0, "remainingCredit": 174.6, "status": "Submitted", "issueDate": "2021-11-02T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "billcredit_test", "unitAmount": 145.5, "quantity": 1, "unitOfMeasurement": "pack", "subTotal": 145.5, "totalAmount": 145.5, "accountRef": { "id": "713", "name": "Inventory Asset" }, "trackingCategoryRefs": [ { "id": "department-1" }, { "id": "location-1" } ], "tracking": { "categoryRefs": [ { "id": "department-1" }, { "id": "location-1" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ], "paymentAllocations": [], "modifiedDate": "2022-09-20T08:16:22Z", "sourceModifiedDate": "2021-11-02T19:58:58", "note": "Codat1" }, { "id": "1782", "billCreditNoteNumber": "VENDCRED2", "supplierRef": { "id": "749", "supplierName": "Jo's Cheese" }, "withholdingTax": [], "totalAmount": 642.3, "totalDiscount": 0, "subTotal": 535.25, "totalTaxAmount": 107.05, "discountPercentage": 0, "remainingCredit": 342.3, "status": "PartiallyPaid", "issueDate": "2021-11-02T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Cheese", "unitAmount": 400, "quantity": 1, "unitOfMeasurement": "pack", "subTotal": 400, "totalAmount": 400, "accountRef": { "id": "714", "name": "Cost of Goods Sold" }, "createdFromLineRef": { "id": "7462", "dataType": "bills", "lineNumber": "1" }, "trackingCategoryRefs": [ { "id": "location-1" } ], "tracking": { "categoryRefs": [ { "id": "location-1" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } }, { "description": "double cream", "unitAmount": 100, "quantity": 1, "subTotal": 100, "totalAmount": 100, "accountRef": { "id": "714", "name": "Cost of Goods Sold" }, "trackingCategoryRefs": [ { "id": "location-1" } ], "tracking": { "categoryRefs": [ { "id": "location-1" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } }, { "description": "", "unitAmount": 35.25, "quantity": 1, "subTotal": 35.25, "totalAmount": 35.25, "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "128", "name": "Test Item" }, "trackingCategoryRefs": [ { "id": "location-1" } ], "tracking": { "categoryRefs": [ { "id": "location-1" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ], "paymentAllocations": [ { "payment": { "id": "1782", "note": "Codat1", "reference": "Bill Credit 02/11/2021", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-11-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 300 } } ], "createdFromRefs": [ { "id": "7462", "dataType": "bills" } ], "modifiedDate": "2022-09-20T08:16:22Z", "sourceModifiedDate": "2021-11-03T18:27:14", "note": "Codat1" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 16, "_links": { "current": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes" }, "next": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "6D2C-1197698059", "billCreditNoteNumber": "Return", "supplierRef": { "id": "E0000-933272656", "supplierName": "Timberloft Lumber" }, "withholdingTax": [], "totalAmount": 475, "totalDiscount": 0, "subTotal": 475, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 475, "status": "Submitted", "issueDate": "2024-10-30T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Lumber:Rough - Rough lumber", "unitAmount": 475, "quantity": 0, "discountAmount": 0, "subTotal": 475, "taxAmount": 0, "totalAmount": 475, "discountPercentage": 0, "itemRef": { "id": "1C0000-933272656", "name": "Lumber:Rough" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "tracking": { "categoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ], "paymentAllocations": [ { "payment": { "id": "6D2C-1197698059", "reference": "Return", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2024-10-30T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 475 } } ], "modifiedDate": "2023-04-26T09:12:30Z", "sourceModifiedDate": "2023-12-16T05:06:19", "metadata": { "isDeleted": false } }, { "id": "F3A-933787869", "billCreditNoteNumber": "CR-1098", "supplierRef": { "id": "80000-933272656", "supplierName": "Sloan Roofing" }, "withholdingTax": [], "totalAmount": 850, "totalDiscount": 0, "subTotal": 850, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 850, "status": "Submitted", "issueDate": "2024-12-12T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Subs:Roofing - Roofing", "unitAmount": 850, "quantity": 0, "discountAmount": 0, "subTotal": 850, "taxAmount": 0, "totalAmount": 850, "discountPercentage": 0, "itemRef": { "id": "D0000-933272656", "name": "Subs:Roofing" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "tracking": { "categoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ], "paymentAllocations": [ { "payment": { "id": "F3A-933787869", "reference": "CR-1098", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2024-12-12T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 850 } } ], "modifiedDate": "2023-04-26T09:12:30Z", "sourceModifiedDate": "2023-12-16T05:05:03", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 3, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "19", "billCreditNoteNumber": "19", "supplierRef": { "id": "4", "supplierName": "BILLy elliot" }, "withholdingTax": [], "totalAmount": 5, "totalDiscount": 0, "subTotal": 5, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2019-05-13T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "", "unitAmount": 5, "quantity": 1, "subTotal": 5, "taxAmount": 0, "totalAmount": 5, "accountRef": { "id": "16", "name": "Advertising" }, "taxRateRef": { "id": "NON", "name": "NON", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" } } ], "paymentAllocations": [ { "payment": { "id": "20", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2019-05-13T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 5 } } ], "modifiedDate": "2023-01-18T11:02:37Z", "sourceModifiedDate": "2019-05-13T13:14:06Z" }, { "id": "677", "billCreditNoteNumber": "677", "supplierRef": { "id": "4", "supplierName": "BILLy elliot" }, "withholdingTax": [], "totalAmount": 5, "totalDiscount": 0, "subTotal": 5, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2020-03-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "", "unitAmount": 5, "quantity": 1, "subTotal": 5, "taxAmount": 0, "totalAmount": 5, "accountRef": { "id": "16", "name": "Advertising" }, "taxRateRef": { "id": "NON", "name": "NON", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" } } ], "paymentAllocations": [ { "payment": { "id": "678", "note": "payment note test", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-03-23T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 5 } } ], "modifiedDate": "2023-01-18T11:02:37Z", "sourceModifiedDate": "2020-03-23T10:44:06Z", "note": "Codat Note field" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 11, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "424", "billCreditNoteNumber": "424", "supplierRef": { "id": "24", "supplierName": "Brijesh Jain" }, "withholdingTax": [], "totalAmount": 69, "totalDiscount": 0, "subTotal": 69, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 69, "status": "Submitted", "issueDate": "2019-06-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Refund of iZettle Fees", "unitAmount": 69, "quantity": 1, "subTotal": 69, "taxAmount": 0, "totalAmount": 69, "accountRef": { "id": "30", "name": "Janitorial Expense" }, "taxRateRef": { "id": "20_Bills", "name": "5.0% RC CIS Bills", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" } } ], "paymentAllocations": [], "modifiedDate": "2023-04-26T09:35:58Z", "sourceModifiedDate": "2019-06-20T15:48:50Z", "metadata": { "isDeleted": false } }, { "id": "455", "billCreditNoteNumber": "455", "supplierRef": { "id": "53", "supplierName": "Bank of AnyCity" }, "withholdingTax": [], "totalAmount": 10, "totalDiscount": 0, "subTotal": 10, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2019-06-26T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "a", "unitAmount": 10, "quantity": 1, "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "accountRef": { "id": "11", "name": "Ask My Accountant" }, "taxRateRef": { "id": "20_Bills", "name": "5.0% RC CIS Bills", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" } } ], "paymentAllocations": [ { "payment": { "id": "530", "reference": "4", "accountRef": { "id": "100", "name": "Savings2" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2019-07-16T00:00:00", "totalAmount": 170 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 10 } } ], "modifiedDate": "2023-04-26T09:35:58Z", "sourceModifiedDate": "2019-07-16T09:49:14Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 26, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "45391", "billCreditNoteNumber": "Return 1", "supplierRef": { "id": "CON001", "supplierName": "Concept Stationery Supplies" }, "withholdingTax": [], "totalAmount": 120, "totalDiscount": 2.5, "subTotal": 100, "totalTaxAmount": 20, "discountPercentage": 2.5, "remainingCredit": 109.5, "status": "Submitted", "issueDate": "2020-07-22T00:00:00Z", "allocatedOnDate": "2020-01-20T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Tax Summary - Tax Rate 1", "unitAmount": 0, "quantity": 0, "discountAmount": 0.5, "subTotal": 0, "taxAmount": 20, "totalAmount": 20, "taxRateRef": { "id": "1729", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [] }, { "description": "Goods Summary", "unitAmount": 0, "quantity": 0, "discountAmount": 2.5, "subTotal": 100, "taxAmount": 0, "totalAmount": 100, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "45391", "note": "ret1", "reference": "Return 1", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-20T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10.5 } } ], "modifiedDate": "2022-10-14T09:35:52Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "note": "ret1" }, { "id": "45421", "billCreditNoteNumber": "Return 2", "supplierRef": { "id": "QUA001", "supplierName": "Quality Motors" }, "withholdingTax": [], "totalAmount": 60, "totalDiscount": 1.25, "subTotal": 50, "totalTaxAmount": 10, "discountPercentage": 2.5, "remainingCredit": 60, "status": "Submitted", "issueDate": "2020-07-22T00:00:00Z", "allocatedOnDate": "2020-02-03T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Tax Summary - Tax Rate 1", "unitAmount": 0, "quantity": 0, "discountAmount": 0.25, "subTotal": 0, "taxAmount": 10, "totalAmount": 10, "taxRateRef": { "id": "1729", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [] }, { "description": "Goods Summary", "unitAmount": 0, "quantity": 0, "discountAmount": 1.25, "subTotal": 50, "taxAmount": 0, "totalAmount": 50, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2022-10-14T09:35:52Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "note": "ret2" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 21, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "20", "billCreditNoteNumber": "O/BAL", "supplierRef": { "id": "NEW001", "supplierName": "Newtown Builders Ltd" }, "withholdingTax": [], "totalAmount": 0.01, "totalDiscount": 0, "subTotal": 0.01, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0.01, "status": "Submitted", "issueDate": "2021-12-31T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Opening Balance", "unitAmount": 0.01, "quantity": 1, "subTotal": 0.01, "taxAmount": 0, "totalAmount": 0.01, "accountRef": { "id": "9998", "name": "Suspense Account" }, "taxRateRef": { "id": "9", "name": "Non-Vatable Tax Code", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [ { "id": "department_0", "name": "Default" } ], "tracking": { "categoryRefs": [ { "id": "department_0", "name": "Default" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ], "paymentAllocations": [], "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false }, "note": "Opening Balance" }, { "id": "323", "billCreditNoteNumber": "Return", "supplierRef": { "id": "UNI001", "supplierName": "Unique Systems" }, "withholdingTax": [], "totalAmount": 103.4, "totalDiscount": 0, "subTotal": 88, "totalTaxAmount": 15.4, "discountPercentage": 0, "remainingCredit": 103.4, "status": "Submitted", "issueDate": "2022-02-28T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Returned Goods, damaged", "unitAmount": 103.4, "quantity": 1, "subTotal": 88, "taxAmount": 15.4, "totalAmount": 103.4, "accountRef": { "id": "5000", "name": "Materials Purchased" }, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_0", "name": "Default" } ], "tracking": { "categoryRefs": [ { "id": "department_0", "name": "Default" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ], "paymentAllocations": [], "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false }, "note": "Returned Goods, damaged" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 12, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "b6c6fce9866849b0b44cac99ab7dc579", "billCreditNoteNumber": "Supplier credit note", "supplierRef": { "id": "ec716559789111e8aaa5027d54329956", "supplierName": "Bagels Limited" }, "withholdingTax": [], "totalAmount": 10, "totalDiscount": 0, "subTotal": 10, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2018-11-23T00:00:00", "currency": "USD", "currencyRate": 0.776970973, "lineItems": [ { "description": "Consulting services", "unitAmount": 10, "quantity": 1, "discountAmount": 0, "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "accountRef": { "id": "9a995955267a11e797950a57719b2edb", "name": "Cost of sales - goods" }, "discountPercentage": 0, "taxRateRef": { "id": "GB_ZERO", "name": "Zero Rated 0.00%", "effectiveTaxRate": 0 }, "itemRef": { "id": "a87b922b33de11e797950a57719b2edb", "name": "Consulting services" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "bf6496aaf0294883b27c423ce8266113", "note": "Supplier refund using credit/debit card", "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "currency": "USD", "currencyRate": 0.771449236, "paidOnDate": "2019-11-19T00:00:00", "totalAmount": -10 }, "allocation": { "currency": "USD", "currencyRate": 1, "totalAmount": 10 } } ], "modifiedDate": "2022-10-24T14:53:32Z", "sourceModifiedDate": "2019-11-19T14:17:32Z" }, { "id": "23d866f6367d4f11956a36a71e47bc37", "supplierRef": { "id": "ca430e0d156011e8b45c025132dab352", "supplierName": "Test Supplier" }, "withholdingTax": [], "totalAmount": 60, "totalDiscount": 0, "subTotal": 50, "totalTaxAmount": 10, "discountPercentage": 0, "remainingCredit": 60, "status": "Submitted", "issueDate": "2019-01-29T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Consulting services", "unitAmount": 10, "quantity": 5, "discountAmount": 0, "subTotal": 50, "taxAmount": 10, "totalAmount": 60, "accountRef": { "id": "9a995955267a11e797950a57719b2edb", "name": "Cost of sales - goods" }, "discountPercentage": 0, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 }, "itemRef": { "id": "a87b922b33de11e797950a57719b2edb", "name": "Consulting services" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2022-10-24T14:53:32Z", "sourceModifiedDate": "2020-07-16T15:00:36Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 747, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "3359", "billCreditNoteNumber": "APADJ0001", "supplierRef": { "id": "3", "supplierName": "ADP" }, "withholdingTax": [], "totalAmount": 12, "totalDiscount": 0, "subTotal": 10, "totalTaxAmount": 2, "discountPercentage": 0, "remainingCredit": 12, "status": "Submitted", "issueDate": "2021-09-20T00:00:00", "currency": "USD", "currencyRate": 0.7283, "lineItems": [ { "description": "No Description Provided", "unitAmount": 5, "quantity": 1, "subTotal": 5, "taxAmount": 1, "totalAmount": 6, "accountRef": { "id": "197", "name": "Software and Licenses" }, "taxRateRef": { "id": "47", "name": "EC Purchase Goods Standard Rate Input", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" }, { "id": "SUPPLIER-3", "name": "ADP" } ], "tracking": { "categoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" }, { "id": "SUPPLIER-3", "name": "ADP" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } }, { "description": "No Description Provided", "unitAmount": 5, "quantity": 1, "subTotal": 5, "taxAmount": 1, "totalAmount": 6, "accountRef": { "id": "197", "name": "Software and Licenses" }, "taxRateRef": { "id": "47", "name": "EC Purchase Goods Standard Rate Input", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" }, { "id": "SUPPLIER-3", "name": "ADP" } ], "tracking": { "categoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" }, { "id": "SUPPLIER-3", "name": "ADP" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ], "paymentAllocations": [], "modifiedDate": "2022-10-28T11:10:22Z", "sourceModifiedDate": "2021-09-20T13:50:16", "note": "" }, { "id": "3399", "billCreditNoteNumber": "APADJ0002", "supplierRef": { "id": "3", "supplierName": "ADP" }, "withholdingTax": [], "totalAmount": 360, "totalDiscount": 0, "subTotal": 300, "totalTaxAmount": 60, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2021-09-24T00:00:00", "allocatedOnDate": "2021-09-29T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "No Description Provided", "unitAmount": 300, "quantity": 1, "subTotal": 300, "taxAmount": 60, "totalAmount": 360, "accountRef": { "id": "197", "name": "Software and Licenses" }, "taxRateRef": { "id": "81", "name": "UK Purchase Goods Standard Rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" }, { "id": "SUPPLIER-3", "name": "ADP" } ], "tracking": { "categoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" }, { "id": "SUPPLIER-3", "name": "ADP" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ], "paymentAllocations": [], "modifiedDate": "2022-10-28T11:10:22Z", "sourceModifiedDate": "2021-09-29T13:34:47", "note": "" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 82, "_links": { "current": { "href": "/companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes" }, "next": { "href": "/companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "ee8bec08-2be8-40ba-acd0-d53d5df11235", "billCreditNoteNumber": "RPT429-1", "supplierRef": { "id": "3a0d40a2-2698-4cf5-b7b2-30133c632ab6", "supplierName": "Swanston Security" }, "withholdingTax": [], "totalAmount": 25.44, "totalDiscount": 0, "subTotal": 25.44, "totalTaxAmount": 4.24, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2022-12-12T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Refund as agreed due to window break when guard absent", "unitAmount": 21.2, "quantity": 1, "discountAmount": 0, "subTotal": 21.2, "taxAmount": 4.24, "totalAmount": 25.44, "accountRef": { "id": "f96c9458-d724-47bf-8f74-a9d5726465ce", "name": "General Expenses" }, "discountPercentage": 0, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "ee8bec08-2be8-40ba-acd0-d53d5df11235", "reference": "", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-12-12T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-12-12T00:00:00", "totalAmount": 25.44 } } ], "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2011-04-07T07:26:30", "metadata": { "isDeleted": false } }, { "id": "7d1f4e11-e909-43b0-901c-2c824dff1e82", "billCreditNoteNumber": "720-2", "supplierRef": { "id": "cf8fa320-a527-496c-823e-22dd069d29e6", "supplierName": "PC Complete" }, "withholdingTax": [], "totalAmount": 270.36, "totalDiscount": 0, "subTotal": 270.36, "totalTaxAmount": 45.06, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2022-12-16T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Unable to supply DVD writer for laptop", "unitAmount": 225.3, "quantity": 1, "discountAmount": 0, "subTotal": 225.3, "taxAmount": 45.06, "totalAmount": 270.36, "accountRef": { "id": "f96c9458-d724-47bf-8f74-a9d5726465ce", "name": "General Expenses" }, "discountPercentage": 0, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "7d1f4e11-e909-43b0-901c-2c824dff1e82", "reference": "", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-12-16T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-12-16T00:00:00", "totalAmount": 270.36 } } ], "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2011-04-06T21:00:33", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/billCreditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/billCreditNotes" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) for a given company's connection.\n\n[Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-bill-credit-notes" } }, "/companies/{companyId}/data/billCreditNotes/{billCreditNoteId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/billCreditNoteId" } ], "get": { "tags": [ "Bill credit notes" ], "summary": "Get bill credit note", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillCreditNote" }, "examples": { "Dynamics 365 Business Central": { "value": { "id": "0deaed0a-9f51-eb11-89f9-00224800af18", "billCreditNoteNumber": "109001", "supplierRef": { "id": "be1217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "Fabrikam, Inc." }, "withholdingTax": [], "totalAmount": 8, "totalDiscount": 0, "subTotal": 8, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 8, "status": "Submitted", "issueDate": "2020-12-21T00:00:00", "currency": "GBP", "lineItems": [ { "description": "Abdi Item No VAT", "unitAmount": 8, "quantity": 1, "discountAmount": 0, "subTotal": 8, "taxAmount": 0, "totalAmount": 8, "accountRef": { "id": "6a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Inventory" }, "discountPercentage": 0, "taxRateRef": { "id": "6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for EXPORT / ZERO", "effectiveTaxRate": 0 }, "itemRef": { "id": "ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT", "name": "Abdi Item No VAT / General Business Posting Group: 'EXPORT' / VAT Business Posting Group: 'EXPORT'" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2023-03-27T14:21:26Z", "metadata": { "isDeleted": false }, "note": "BCN001" } }, "Exact (Netherlands)": { "value": { "id": "443bd109-e1ed-4de2-b1ab-3b13e980d288", "billCreditNoteNumber": "19600007", "supplierRef": { "id": "5e6f49b9-6489-4b82-83e7-291d308919bb", "supplierName": "Mickey Mouse" }, "withholdingTax": [], "totalAmount": 12.1, "totalDiscount": 0, "subTotal": 10, "totalTaxAmount": 2.1, "discountPercentage": 0, "remainingCredit": 12.1, "status": "Submitted", "issueDate": "2019-12-16T00:00:00Z", "currency": "EUR", "currencyRate": 1, "lineItems": [ { "description": "Cheesecake", "unitAmount": 10, "quantity": 1, "discountAmount": 0, "subTotal": 10, "taxAmount": 2.1, "totalAmount": 12.1, "accountRef": { "id": "5f139759-b554-4314-862e-b9d88e5b2e1b", "name": "Af te dragen loonheffing" }, "taxRateRef": { "id": "84277189-ad16-456c-b501-ca31f0a483cc", "name": "BTW prive gebruik", "effectiveTaxRate": 21 }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2022-10-26T13:32:18Z", "sourceModifiedDate": "2020-01-03T15:06:19Z" } }, "Exact (UK)": { "value": { "id": "f9083d38-40c7-4b5f-a693-f4670e3d85bc", "billCreditNoteNumber": "19600008", "supplierRef": { "id": "1c703cce-967c-4476-a86a-32e35341a8f5", "supplierName": "Customer Bill Supplier" }, "withholdingTax": [], "totalAmount": 99999, "totalDiscount": 0, "subTotal": 99999, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 99999, "status": "Submitted", "issueDate": "2019-10-30T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Oil Change", "unitAmount": -150, "quantity": 1000.5, "discountAmount": 0, "subTotal": -150075, "totalAmount": -150075, "accountRef": { "id": "885ff551-664d-451b-995b-cb114c9877d0", "name": "Unallocated Cash" }, "itemRef": { "id": "3001" }, "trackingCategoryRefs": [] }, { "description": "description", "unitAmount": 250074, "quantity": 1, "discountAmount": 0, "subTotal": 250074, "totalAmount": 250074, "accountRef": { "id": "885ff551-664d-451b-995b-cb114c9877d0", "name": "Unallocated Cash" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2022-10-26T13:33:23Z", "sourceModifiedDate": "2019-10-30T13:12:56Z" } }, "FreeAgent": { "value": { "id": "10665024", "billCreditNoteNumber": "Bill Credit", "supplierRef": { "id": "6161941", "supplierName": "A & J Fabtech Ltd" }, "withholdingTax": [], "totalAmount": 1500, "totalDiscount": 0, "subTotal": 1250, "totalTaxAmount": 250, "discountPercentage": 0, "remainingCredit": 1500, "status": "Submitted", "issueDate": "2018-08-22T00:00:00", "currency": "GBP", "lineItems": [ { "description": "A & J Fabtech Ltd - Bill Credit Note Bill Credit", "unitAmount": 1250, "quantity": 1, "taxAmount": 250, "totalAmount": 1500, "accountRef": { "id": "285", "name": "Accommodation and Meals" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2023-04-25T14:19:10Z", "sourceModifiedDate": "2018-08-22T13:22:08Z", "metadata": { "isDeleted": false } } }, "KashFlow": { "value": { "id": "91339087", "billCreditNoteNumber": "5", "supplierRef": { "id": "6202387", "supplierName": "Dell" }, "withholdingTax": [], "totalAmount": 10, "totalDiscount": 0, "subTotal": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2020-02-25T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Oil refund", "unitAmount": 10, "quantity": 1, "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "accountRef": { "id": "21481832", "name": "Oil" }, "itemRef": { "id": "114817740" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [], "modifiedDate": "2022-09-30T10:29:16Z" } }, "Oracle NetSuite": { "value": { "id": "1781", "billCreditNoteNumber": "VENDCRED1", "supplierRef": { "id": "749", "supplierName": "Jo's Cheese" }, "withholdingTax": [], "totalAmount": 174.6, "totalDiscount": 0, "subTotal": 145.5, "totalTaxAmount": 29.1, "discountPercentage": 0, "remainingCredit": 174.6, "status": "Submitted", "issueDate": "2021-11-02T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "billcredit_test", "unitAmount": 145.5, "quantity": 1, "unitOfMeasurement": "pack", "subTotal": 145.5, "totalAmount": 145.5, "accountRef": { "id": "713", "name": "Inventory Asset" }, "createdFromLineRef": { "id": "1432", "dataType": "bills", "lineNumber": "1" }, "trackingCategoryRefs": [ { "id": "department-1" }, { "id": "location-1" } ], "tracking": { "categoryRefs": [ { "id": "department-1" }, { "id": "location-1" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ], "paymentAllocations": [], "createdFromRefs": [ { "id": "1432", "dataType": "bills" } ], "modifiedDate": "2022-09-20T08:16:22Z", "sourceModifiedDate": "2021-11-02T19:58:58", "note": "Codat1" } }, "QuickBooks Desktop": { "value": { "id": "6D2C-1197698059", "billCreditNoteNumber": "Return", "supplierRef": { "id": "E0000-933272656", "supplierName": "Timberloft Lumber" }, "withholdingTax": [], "totalAmount": 475, "totalDiscount": 0, "subTotal": 475, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 475, "status": "Submitted", "issueDate": "2024-10-30T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Lumber:Rough - Rough lumber", "unitAmount": 475, "quantity": 0, "discountAmount": 0, "subTotal": 475, "taxAmount": 0, "totalAmount": 475, "discountPercentage": 0, "itemRef": { "id": "1C0000-933272656", "name": "Lumber:Rough" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "tracking": { "categoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ], "paymentAllocations": [ { "payment": { "id": "6D2C-1197698059", "reference": "Return", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2024-10-30T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 475 } } ], "modifiedDate": "2023-04-26T09:12:30Z", "sourceModifiedDate": "2023-12-16T05:06:19", "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "19", "billCreditNoteNumber": "19", "supplierRef": { "id": "4", "supplierName": "BILLy elliot" }, "withholdingTax": [], "totalAmount": 5, "totalDiscount": 0, "subTotal": 5, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2019-05-13T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "", "unitAmount": 5, "quantity": 1, "subTotal": 5, "taxAmount": 0, "totalAmount": 5, "accountRef": { "id": "16", "name": "Advertising" }, "taxRateRef": { "id": "NON", "name": "NON", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" } } ], "paymentAllocations": [ { "payment": { "id": "20", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2019-05-13T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 5 } } ], "modifiedDate": "2023-01-18T11:02:37Z", "sourceModifiedDate": "2019-05-13T13:14:06Z" } }, "QuickBooks Online Sandbox": { "value": { "id": "424", "billCreditNoteNumber": "424", "supplierRef": { "id": "24", "supplierName": "Brijesh Jain" }, "withholdingTax": [], "totalAmount": 69, "totalDiscount": 0, "subTotal": 69, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 69, "status": "Submitted", "issueDate": "2019-06-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Refund of iZettle Fees", "unitAmount": 69, "quantity": 1, "subTotal": 69, "taxAmount": 0, "totalAmount": 69, "accountRef": { "id": "30", "name": "Janitorial Expense" }, "taxRateRef": { "id": "20_Bills", "name": "5.0% RC CIS Bills", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" } } ], "paymentAllocations": [], "modifiedDate": "2023-04-26T09:35:58Z", "sourceModifiedDate": "2019-06-20T15:48:50Z", "metadata": { "isDeleted": false } } }, "Sage 200cloud": { "value": { "id": "45391", "billCreditNoteNumber": "Return 1", "supplierRef": { "id": "CON001", "supplierName": "Concept Stationery Supplies" }, "withholdingTax": [], "totalAmount": 120, "totalDiscount": 2.5, "subTotal": 100, "totalTaxAmount": 20, "discountPercentage": 2.5, "remainingCredit": 109.5, "status": "Submitted", "issueDate": "2020-07-22T00:00:00Z", "allocatedOnDate": "2020-01-20T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Tax Summary - Tax Rate 1", "unitAmount": 0, "quantity": 0, "discountAmount": 0.5, "subTotal": 0, "taxAmount": 20, "totalAmount": 20, "taxRateRef": { "id": "1729", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [] }, { "description": "Goods Summary", "unitAmount": 0, "quantity": 0, "discountAmount": 2.5, "subTotal": 100, "taxAmount": 0, "totalAmount": 100, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "45391", "note": "ret1", "reference": "Return 1", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-20T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10.5 } } ], "modifiedDate": "2022-10-14T09:35:52Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "note": "ret1" } }, "Sage 50 (UK)": { "value": { "id": "20", "billCreditNoteNumber": "O/BAL", "supplierRef": { "id": "NEW001", "supplierName": "Newtown Builders Ltd" }, "withholdingTax": [], "totalAmount": 0.01, "totalDiscount": 0, "subTotal": 0.01, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0.01, "status": "Submitted", "issueDate": "2021-12-31T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Opening Balance", "unitAmount": 0.01, "quantity": 1, "subTotal": 0.01, "taxAmount": 0, "totalAmount": 0.01, "accountRef": { "id": "9998", "name": "Suspense Account" }, "taxRateRef": { "id": "9", "name": "Non-Vatable Tax Code", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [ { "id": "department_0", "name": "Default" } ], "tracking": { "categoryRefs": [ { "id": "department_0", "name": "Default" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ], "paymentAllocations": [], "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false }, "note": "Opening Balance" } }, "Sage Business Cloud Accounting": { "value": { "id": "b6c6fce9866849b0b44cac99ab7dc579", "billCreditNoteNumber": "Supplier credit note", "supplierRef": { "id": "ec716559789111e8aaa5027d54329956", "supplierName": "Bagels Limited" }, "withholdingTax": [], "totalAmount": 10, "totalDiscount": 0, "subTotal": 10, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2018-11-23T00:00:00", "currency": "USD", "currencyRate": 0.776970973, "lineItems": [ { "description": "Consulting services", "unitAmount": 10, "quantity": 1, "discountAmount": 0, "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "accountRef": { "id": "9a995955267a11e797950a57719b2edb", "name": "Cost of sales - goods" }, "discountPercentage": 0, "taxRateRef": { "id": "GB_ZERO", "name": "Zero Rated 0.00%", "effectiveTaxRate": 0 }, "itemRef": { "id": "a87b922b33de11e797950a57719b2edb", "name": "Consulting services" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "bf6496aaf0294883b27c423ce8266113", "note": "Supplier refund using credit/debit card", "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "currency": "USD", "currencyRate": 0.771449236, "paidOnDate": "2019-11-19T00:00:00", "totalAmount": -10 }, "allocation": { "currency": "USD", "currencyRate": 1, "totalAmount": 10 } } ], "modifiedDate": "2022-10-24T14:53:32Z", "sourceModifiedDate": "2019-11-19T14:17:32Z" } }, "Sage Intacct": { "value": { "id": "3359", "billCreditNoteNumber": "APADJ0001", "supplierRef": { "id": "3", "supplierName": "ADP" }, "withholdingTax": [], "totalAmount": 12, "totalDiscount": 0, "subTotal": 10, "totalTaxAmount": 2, "discountPercentage": 0, "remainingCredit": 12, "status": "Submitted", "issueDate": "2021-09-20T00:00:00", "currency": "USD", "currencyRate": 0.7283, "lineItems": [ { "description": "No Description Provided", "unitAmount": 5, "quantity": 1, "subTotal": 5, "taxAmount": 1, "totalAmount": 6, "accountRef": { "id": "197", "name": "Software and Licenses" }, "taxRateRef": { "id": "47", "name": "EC Purchase Goods Standard Rate Input", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" }, { "id": "SUPPLIER-3", "name": "ADP" } ], "tracking": { "categoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" }, { "id": "SUPPLIER-3", "name": "ADP" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } }, { "description": "No Description Provided", "unitAmount": 5, "quantity": 1, "subTotal": 5, "taxAmount": 1, "totalAmount": 6, "accountRef": { "id": "197", "name": "Software and Licenses" }, "taxRateRef": { "id": "47", "name": "EC Purchase Goods Standard Rate Input", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" }, { "id": "SUPPLIER-3", "name": "ADP" } ], "tracking": { "categoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" }, { "id": "SUPPLIER-3", "name": "ADP" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ], "paymentAllocations": [], "modifiedDate": "2022-10-28T11:10:22Z", "sourceModifiedDate": "2021-09-20T13:50:16", "note": "" } }, "Xero": { "value": { "id": "ee8bec08-2be8-40ba-acd0-d53d5df11235", "billCreditNoteNumber": "RPT429-1", "supplierRef": { "id": "3a0d40a2-2698-4cf5-b7b2-30133c632ab6", "supplierName": "Swanston Security" }, "withholdingTax": [], "totalAmount": 25.44, "totalDiscount": 0, "subTotal": 25.44, "totalTaxAmount": 4.24, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2022-12-12T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Refund as agreed due to window break when guard absent", "unitAmount": 21.2, "quantity": 1, "discountAmount": 0, "subTotal": 21.2, "taxAmount": 4.24, "totalAmount": 25.44, "accountRef": { "id": "f96c9458-d724-47bf-8f74-a9d5726465ce", "name": "General Expenses" }, "discountPercentage": 0, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "ee8bec08-2be8-40ba-acd0-d53d5df11235", "reference": "", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-12-12T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-12-12T00:00:00", "totalAmount": 25.44 } } ], "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2011-04-07T07:26:30", "metadata": { "isDeleted": false } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId.\n\n[Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support getting a specific bill credit note.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-bill-credit-note" } }, "/companies/{companyId}/connections/{connectionId}/options/billCreditNotes": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create/update bill credit note model", "tags": [ "Bill credit notes" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Dynamics 365 Business Central": { "value": { "type": "Object", "displayName": "Accounts Payable Credit Note", "description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the credit note has been issued by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "options": [ { "value": "Draft", "type": "Array", "displayName": "Draft", "required": false }, { "value": "Submitted", "type": "Array", "displayName": "Submitted", "required": false }, { "value": "Void", "type": "Array", "displayName": "Void", "required": false } ], "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": true, "validation": { "warnings": [ { "field": "Currency", "details": "Must be a valid currency code" } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": true, "validation": { "warnings": [ { "field": "Note", "details": "Vendor Credit Memo Number must be specified in this field" } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Line items", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Either AccountRef or ItemRef should be specified. If ItemRef is chosen, ID must be specified" } ], "information": [] } } }, "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Either AccountRef or ItemRef should be specified. If AccountRef is chosen, ID must be specified" } ], "information": [] } } }, "required": false }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true, "validation": { "warnings": [ { "field": "LineItems.Quantity", "details": "Must be positive" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "LineItems", "details": "Must be positive" } ], "information": [] } } }, "required": true } }, "FreeAgent": { "value": { "type": "Object", "displayName": "Accounts Payable Credit Note", "description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the credit note has been issued by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "billCreditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the credit note was allocated", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the credit note, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must be greater than 0 and must be equal to the sum of the line item total amounts." } ], "information": [] } }, "totalTaxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the credit note", "required": true, "validation": { "warnings": [ { "field": "TotalTaxAmount", "details": "Must be greater than 0 and must be equal to the sum of the line item tax amounts." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "options": [ { "value": "AED", "type": "String", "displayName": "AED", "required": false }, { "value": "AMD", "type": "String", "displayName": "AMD", "required": false }, { "value": "AOA", "type": "String", "displayName": "AOA", "required": false }, { "value": "ARS", "type": "String", "displayName": "ARS", "required": false }, { "value": "AUD", "type": "String", "displayName": "AUD", "required": false }, { "value": "AWG", "type": "String", "displayName": "AWG", "required": false }, { "value": "AZN", "type": "String", "displayName": "AZN", "required": false }, { "value": "BBD", "type": "String", "displayName": "BBD", "required": false }, { "value": "BDT", "type": "String", "displayName": "BDT", "required": false }, { "value": "BGN", "type": "String", "displayName": "BGN", "required": false }, { "value": "BRL", "type": "String", "displayName": "BRL", "required": false }, { "value": "BWP", "type": "String", "displayName": "BWP", "required": false }, { "value": "CAD", "type": "String", "displayName": "CAD", "required": false }, { "value": "CHF", "type": "String", "displayName": "CHF", "required": false }, { "value": "CLP", "type": "String", "displayName": "CLP", "required": false }, { "value": "CNY", "type": "String", "displayName": "CNY", "required": false }, { "value": "COP", "type": "String", "displayName": "COP", "required": false }, { "value": "CRC", "type": "String", "displayName": "CRC", "required": false }, { "value": "CUC", "type": "String", "displayName": "CUC", "required": false }, { "value": "CUP", "type": "String", "displayName": "CUP", "required": false }, { "value": "CZK", "type": "String", "displayName": "CZK", "required": false }, { "value": "DKK", "type": "String", "displayName": "DKK", "required": false }, { "value": "DOP", "type": "String", "displayName": "DOP", "required": false }, { "value": "EGP", "type": "String", "displayName": "EGP", "required": false }, { "value": "EUR", "type": "String", "displayName": "EUR", "required": false }, { "value": "FJD", "type": "String", "displayName": "FJD", "required": false }, { "value": "GBP", "type": "String", "displayName": "GBP", "required": false }, { "value": "GEL", "type": "String", "displayName": "GEL", "required": false }, { "value": "GHS", "type": "String", "displayName": "GHS", "required": false }, { "value": "GTQ", "type": "String", "displayName": "GTQ", "required": false }, { "value": "GYD", "type": "String", "displayName": "GYD", "required": false }, { "value": "HKD", "type": "String", "displayName": "HKD", "required": false }, { "value": "HNL", "type": "String", "displayName": "HNL", "required": false }, { "value": "HRK", "type": "String", "displayName": "HRK", "required": false }, { "value": "HUF", "type": "String", "displayName": "HUF", "required": false }, { "value": "IDR", "type": "String", "displayName": "IDR", "required": false }, { "value": "ILS", "type": "String", "displayName": "ILS", "required": false }, { "value": "INR", "type": "String", "displayName": "INR", "required": false }, { "value": "ISK", "type": "String", "displayName": "ISK", "required": false }, { "value": "JMD", "type": "String", "displayName": "JMD", "required": false }, { "value": "JPY", "type": "String", "displayName": "JPY", "required": false }, { "value": "KES", "type": "String", "displayName": "KES", "required": false }, { "value": "KRW", "type": "String", "displayName": "KRW", "required": false }, { "value": "KWD", "type": "String", "displayName": "KWD", "required": false }, { "value": "KYD", "type": "String", "displayName": "KYD", "required": false }, { "value": "KZT", "type": "String", "displayName": "KZT", "required": false }, { "value": "LAK", "type": "String", "displayName": "LAK", "required": false }, { "value": "LBP", "type": "String", "displayName": "LBP", "required": false }, { "value": "LKR", "type": "String", "displayName": "LKR", "required": false }, { "value": "LTL", "type": "String", "displayName": "LTL", "required": false }, { "value": "LVL", "type": "String", "displayName": "LVL", "required": false }, { "value": "MAD", "type": "String", "displayName": "MAD", "required": false }, { "value": "MDL", "type": "String", "displayName": "MDL", "required": false }, { "value": "MGA", "type": "String", "displayName": "MGA", "required": false }, { "value": "MUR", "type": "String", "displayName": "MUR", "required": false }, { "value": "MVR", "type": "String", "displayName": "MVR", "required": false }, { "value": "MWK", "type": "String", "displayName": "MWK", "required": false }, { "value": "MXN", "type": "String", "displayName": "MXN", "required": false }, { "value": "MYR", "type": "String", "displayName": "MYR", "required": false }, { "value": "MZN", "type": "String", "displayName": "MZN", "required": false }, { "value": "NAD", "type": "String", "displayName": "NAD", "required": false }, { "value": "NGN", "type": "String", "displayName": "NGN", "required": false }, { "value": "NOK", "type": "String", "displayName": "NOK", "required": false }, { "value": "NPR", "type": "String", "displayName": "NPR", "required": false }, { "value": "NZD", "type": "String", "displayName": "NZD", "required": false }, { "value": "OMR", "type": "String", "displayName": "OMR", "required": false }, { "value": "PEN", "type": "String", "displayName": "PEN", "required": false }, { "value": "PHP", "type": "String", "displayName": "PHP", "required": false }, { "value": "PKR", "type": "String", "displayName": "PKR", "required": false }, { "value": "PLN", "type": "String", "displayName": "PLN", "required": false }, { "value": "QAR", "type": "String", "displayName": "QAR", "required": false }, { "value": "RON", "type": "String", "displayName": "RON", "required": false }, { "value": "RSD", "type": "String", "displayName": "RSD", "required": false }, { "value": "RUB", "type": "String", "displayName": "RUB", "required": false }, { "value": "RWF", "type": "String", "displayName": "RWF", "required": false }, { "value": "SAR", "type": "String", "displayName": "SAR", "required": false }, { "value": "SCR", "type": "String", "displayName": "SCR", "required": false }, { "value": "SEK", "type": "String", "displayName": "SEK", "required": false }, { "value": "SGD", "type": "String", "displayName": "SGD", "required": false }, { "value": "THB", "type": "String", "displayName": "THB", "required": false }, { "value": "TND", "type": "String", "displayName": "TND", "required": false }, { "value": "TRY", "type": "String", "displayName": "TRY", "required": false }, { "value": "TTD", "type": "String", "displayName": "TTD", "required": false }, { "value": "TWD", "type": "String", "displayName": "TWD", "required": false }, { "value": "TZS", "type": "String", "displayName": "TZS", "required": false }, { "value": "UAH", "type": "String", "displayName": "UAH", "required": false }, { "value": "UGX", "type": "String", "displayName": "UGX", "required": false }, { "value": "USD", "type": "String", "displayName": "USD", "required": false }, { "value": "UYU", "type": "String", "displayName": "UYU", "required": false }, { "value": "VEF", "type": "String", "displayName": "VEF", "required": false }, { "value": "VND", "type": "String", "displayName": "VND", "required": false }, { "value": "VUV", "type": "String", "displayName": "VUV", "required": false }, { "value": "XAF", "type": "String", "displayName": "XAF", "required": false }, { "value": "XCD", "type": "String", "displayName": "XCD", "required": false }, { "value": "XOF", "type": "String", "displayName": "XOF", "required": false }, { "value": "ZAR", "type": "String", "displayName": "ZAR", "required": false }, { "value": "ZMK", "type": "String", "displayName": "ZMK", "required": false } ], "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "If not specified, defaults to the company's native currency" } ] } }, "lineItems": { "type": "Array", "displayName": "Line items", "description": "A collection of lines that detail items related to the credit note", "properties": { "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxAmount", "details": "Must be positive for bill items and negative for credit items. If not specified, defaults to the tax correct tax rate amount for the category of the bill." } ], "information": [ { "field": "LineItems.TaxAmount", "details": "Amount of sales tax for the BillCreditNoteLineItem in company's native currency." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true } }, "required": true, "validation": { "warnings": [ { "field": "LineItems", "details": "Up to a maximum of 40 line items may be specified" } ], "information": [] } } }, "required": true } }, "MYOB AccountRight and Essentials": { "value": { "type": "Object", "displayName": "Accounts Payable Credit Note", "description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the credit note, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Precision must be maximum of two decimal places." }, { "field": "TotalAmount", "details": "Must be greater than zero." } ], "information": [ { "field": "TotalAmount", "details": "Must be provided." } ] } }, "totalDiscount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given credit note currency, of any discounts applied", "required": false, "validation": { "warnings": [ { "field": "TotalDiscount", "details": "Precision must be maximum of two decimal places." } ], "information": [] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the credit note, inclusive of discounts but exclusive of tax", "required": false, "validation": { "warnings": [ { "field": "SubTotal", "details": "Precision must be maximum of two decimal places." } ], "information": [] } }, "totalTaxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the credit note", "required": false, "validation": { "warnings": [ { "field": "TotalTaxAmount", "details": "Precision must be maximum of two decimal places." } ], "information": [] } }, "remainingCredit": { "type": "Number", "displayName": "Remaining Credit", "description": "Unused balance of total amount originally raised", "required": false, "validation": { "warnings": [ { "field": "RemainingCredit", "details": "Precision must be maximum of two decimal places." } ], "information": [] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must be provided." } ] } }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the credit note has been issued by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [], "information": [ { "field": "SupplierRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "SupplierRef", "details": "Must be provided." } ] } }, "lineItems": { "type": "Array", "displayName": "Line items", "description": "A collection of lines that detail items related to the credit note", "properties": { "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.AccountRef", "details": "Must be provided." } ] } }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.Description", "details": "Must not be greater than 225 characters long." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "LineItems.TotalAmount", "details": "Precision must be maximum of two decimal places." }, { "field": "LineItems.TotalAmount", "details": "Must be greater than zero." } ], "information": [ { "field": "LineItems.TotalAmount", "details": "Must be provided." } ] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false, "validation": { "warnings": [ { "field": "LineItems.SubTotal", "details": "Precision must be maximum of two decimal places." } ], "information": [] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxAmount", "details": "Precision must be maximum of two decimal places." } ], "information": [] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must be provided." } ] } } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "Accounts Payable Credit Note", "description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the credit note has been issued by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": false }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true }, "lineItems": { "type": "Array", "displayName": "Line items", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": false, "validation": { "warnings": [ { "field": "LineItems.UnitAmount", "details": "Must not be provided for 'Discount' type items" } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": false, "validation": { "warnings": [ { "field": "LineItems.Quantity", "details": "Must not be provided for 'Discount' type items" } ], "information": [] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true } }, "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true } }, "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": false }, "tracking": { "type": "Object", "displayName": "Accounts Payable Tracking", "description": "A collection of items this line item is being tracked against", "properties": { "categoryRefs": { "type": "Array", "displayName": "Category References", "description": "A collection of categories this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true } }, "required": false } }, "required": false } }, "required": true } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Accounts Payable Credit Note", "description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the credit note has been issued by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must match the ID of an existing supplier" } ], "information": [] } } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "Must be a three letter ISO code that matches the currency of the supplier." }, { "field": "Currency", "details": "Can only be set if the QuickBooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "Currency", "details": "If not set, will default to the default currency of the supplier." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1." }, { "field": "CurrencyRate", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ] } }, "totalTaxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the credit note", "required": true, "validation": { "warnings": [ { "field": "TotalTaxAmount", "details": "Cannot be mapped directly into QuickBooks Desktop and will only be used for validation purposes" }, { "field": "TotalTaxAmount", "details": "Must match sum of total of tax from the line items" } ], "information": [] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the credit note, inclusive of discounts but exclusive of tax", "required": true, "validation": { "warnings": [ { "field": "SubTotal", "details": "Must match the totalAmount - taxAmount" } ], "information": [] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the credit note, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must match the sum of line items ((quantity * unit price) - discount + tax)" } ], "information": [ { "field": "TotalAmount", "details": "If a bill credit note is pushed with a total amount of 0, it will automatically be marked as paid in QuickBooks Desktop" } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Max length of 4000 characters." } ], "information": [] } }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false }, { "value": "Paid", "type": "String", "displayName": "Paid", "required": false }, { "value": "Void", "type": "String", "displayName": "Void", "required": false } ], "required": true, "validation": { "warnings": [ { "field": "Status", "details": "If a bill credit note is pushed with a total amount of 0, then the status must be Paid or Void" } ], "information": [ { "field": "Status", "details": "If a bill credit note is pushed with a status of void, then all the amounts in the bill credit note must be 0" }, { "field": "Status", "details": "If a bill credit note is pushed without payment allocations, then the status must be Submitted, if pushed with payment allocations, then the status must be paid" } ] } }, "lineItems": { "type": "Array", "displayName": "Line items", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Should not be longer than 4000 characters." } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TotalAmount", "details": "Must match subtotal + tax amount of line" } ] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.SubTotal", "details": "Must match quantity * unit amount of line" } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true, "validation": { "warnings": [ { "field": "LineItems.TaxAmount", "details": "Cannot be mapped directly into QuickBooks Desktop and will only be used for validation purposes" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing nominal account." } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "LineItems.AccountRef", "details": "Can't include both AccountRef and ItemRef" } ], "information": [ { "field": "LineItems.AccountRef", "details": "Account type must be Asset, Liability or Expense and not Accounts Payable" } ] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item type." } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "LineItems.ItemRef", "details": "Can't include both AccountRef and ItemRef" } ], "information": [ { "field": "LineItems.ItemRef", "details": "Item type must not be Discount or Sale-Tax items" } ] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Only valid for UK or CA versions of QuickBooks Desktop with VAT enabled" }, { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax rate" } ], "information": [] } } }, "required": false }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.Id", "details": "Must match the ID of an existing tracking category." } ], "information": [] } } }, "required": false } }, "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments that are allocated to (i.e. spend) the credit note", "properties": { "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": false, "validation": { "warnings": [ { "field": "Allocation.Currency", "details": "If set, must match currency on the bill credit note" } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the transaction", "required": false, "validation": { "warnings": [ { "field": "Allocation.CurrencyRate", "details": "If set, must match currency rate on the bill credit note" } ], "information": [] } }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": false, "validation": { "warnings": [ { "field": "Allocation.AllocatedOnDate", "details": "If set, must match issue date on the bill credit note" } ], "information": [] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": true, "validation": { "warnings": [ { "field": "Allocation.TotalAmount", "details": "Must match total amount on the bill credit note" } ], "information": [] } } }, "required": true }, "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": false, "validation": { "warnings": [ { "field": "Payment.Currency", "details": "$ set, must match currency on the {topLevelItem}" } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the base company", "required": false, "validation": { "warnings": [ { "field": "Payment.CurrencyRate", "details": "If set, must match currency rate on the bill credit note" } ], "information": [] } }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": true, "validation": { "warnings": [ { "field": "Payment.PaidOnDate", "details": "Must match issue date on the bill credit note" } ], "information": [] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": true, "validation": { "warnings": [ { "field": "Payment.TotalAmount", "details": " Must match total amount on the bill credit note" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing credit card account." } ], "information": [] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Payment.AccountRef", "details": " Account type must be of type Credit Card" } ] } } }, "required": true } }, "required": false, "validation": { "warnings": [ { "field": "PaymentAllocations", "details": "A maximum of one payment allocation may be provided per bill credit note" } ], "information": [ { "field": "PaymentAllocations", "details": "If a payment allocation is provided, a credit card credit will created in QuickBooksDesktop, if left as null or empty, a {topLevelItem} will be created" } ] } } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Accounts Payable Credit Note", "description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.", "properties": { "billCreditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": false }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the credit note has been issued by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Required if multi-currency is enabled for the company." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "Required if Currency is not the base currency." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": false }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": false, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "If the issue date is not supplied, the current date on the server is used" } ] } }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false }, { "value": "Paid", "type": "String", "displayName": "Paid", "required": false } ], "required": true }, "lineItems": { "type": "Array", "displayName": "Line items", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Should not be longer than 4000 characters." } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax code." } ], "information": [ { "field": "TaxRateRef.Id", "details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used." } ] } } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Required if the expense line is account based. If AccountRef is specified, ItemRef must be null." } ] } } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [ { "field": "ItemRef.Id", "details": "Required if the expense line is item based. If ItemRef is specified, AccountRef must be null." } ] } } }, "required": false } }, "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments that are allocated to (i.e. spend) the credit note", "required": false, "validation": { "warnings": [ { "field": "PaymentAllocations", "details": "Payment Allocations are no longer valid for BillCreditNotes and must not be provided, use the DirectCost data type to push credit card credits." } ], "information": [] } } }, "required": true } }, "QuickBooks Online": { "value": { "type": "Object", "displayName": "Accounts Payable Credit Note", "description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.", "properties": { "billCreditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": false }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the credit note has been issued by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Required if multi-currency is enabled for the company." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "Required if Currency is not the base currency." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": false }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": false, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "If the issue date is not supplied, the current date on the server is used" } ] } }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false }, { "value": "Paid", "type": "String", "displayName": "Paid", "required": false } ], "required": true }, "lineItems": { "type": "Array", "displayName": "Line items", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Should not be longer than 4000 characters." } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax code." } ], "information": [ { "field": "TaxRateRef.Id", "details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used." } ] } } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Required if the expense line is account based. If AccountRef is specified, ItemRef must be null." } ] } } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [ { "field": "ItemRef.Id", "details": "Required if the expense line is item based. If ItemRef is specified, AccountRef must be null." } ] } } }, "required": false } }, "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments that are allocated to (i.e. spend) the credit note", "required": false, "validation": { "warnings": [ { "field": "PaymentAllocations", "details": "Payment Allocations are no longer valid for BillCreditNotes and must not be provided, use the DirectCost data type to push credit card credits." } ], "information": [] } } }, "required": true } }, "Sage 50 (UK)": { "value": { "type": "Object", "displayName": "Accounts Payable Credit Note", "description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier", "description": "Supplier providing the bill credit note.", "properties": { "id": { "type": "String", "displayName": "Supplier Id", "description": "Identifier of the supplier.", "required": true, "validation": { "warnings": [ { "field": "supplierRef.id", "details": "Must match the ID of an existing supplier and have a max length of 8 characters." } ], "information": [] } } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Date", "description": "Date when the bill credit note was issued.", "required": true }, "billCreditNoteNumber": { "type": "String", "displayName": "Bill Credit Note Number", "description": "The reference number for this bill credit note", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency in which the bill credit note is issued.", "required": true, "validation": { "warnings": [ { "field": "currency", "details": "This must match the supplier's default currency." } ], "information": [] } }, "status": { "type": "String", "displayName": "Status", "description": "The status of the bill credit note", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true }, "note": { "type": "String", "displayName": "Note", "description": "To be used for any additional information associated with the bill credit note line item.", "required": false, "validation": { "warnings": [ { "field": "note", "details": "Maximum 60 characters" } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "Line items of the bill credit note.", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Description of the bill credit note line item.", "required": true, "validation": { "warnings": [ { "field": "lineItems.description", "details": "Max length of 60 characters." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Identifier for the account.", "properties": { "id": { "type": "String", "displayName": "Account Id", "description": "Identifier of the account.", "required": true, "validation": { "warnings": [ { "field": "accountRef.id", "details": "Must match the ID of an existing account." } ], "information": [] } } }, "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "Tax of the bill credit note line item.", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the bill credit note line item, inclusive of the tax amount.", "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Tax rate reference of a bill credit note line item.", "properties": { "id": { "type": "String", "displayName": "Tax Rate Id", "description": "ID of the tax rate.", "required": true, "validation": { "warnings": [ { "field": "taxRateRef.id", "details": "Must match the ID of an existing tax rate." } ], "information": [] } } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Categories", "description": "Tracking categories for the line item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "Prefixed identifier for tracking category e.g. project_{x}, department_{x}, costcode_{x}", "required": true, "validation": { "warnings": [ { "field": "trackingCategoryRefs.id", "details": "Cost codes assigned with costcode_{x} must exist in Sage50 and must be assigned in conjunction with a project" }, { "field": "trackingCategoryRefs.id", "details": "Projects assigned with project_{x} must exist in Sage50 and must be assigned in conjunction with a cost code" }, { "field": "trackingCategoryRefs.id", "details": "Departments assigned with department_{x} must exist in Sage50" } ], "information": [] } } }, "required": false } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company." } ] } } }, "Sage Business Cloud Accounting": { "value": { "type": "Object", "displayName": "Accounts Payable Credit Note", "description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.", "properties": { "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must be provided." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "If supplied, must match the currency of the supplier." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the credit note has been issued by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must match the ID of an existing supplier." }, { "field": "SupplierRef.Id", "details": "The supplier must be in the same location as the company." } ], "information": [ { "field": "SupplierRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the credit note, inclusive of discounts and tax", "required": false, "validation": { "warnings": [], "information": [ { "field": "TotalAmount", "details": "If supplied, must match the sum of all line item total amounts." } ] } }, "billCreditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": false, "validation": { "warnings": [], "information": [ { "field": "BillCreditNoteNumber", "details": "Should not be longer than 25 characters." } ] } }, "lineItems": { "type": "Array", "displayName": "Line items", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": true, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Should not be longer than 2000 characters." } ], "information": [ { "field": "LineItems.Description", "details": "Must be provided." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TotalAmount", "details": "If supplied, must match the total of the line including tax." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxAmount", "details": "Must be provided." } ] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax rate." } ], "information": [ { "field": "TaxRateRef.Id", "details": "Must be provided." } ] } } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must be provided." } ] } } }, "required": true } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "Accounts Payable Credit Note", "description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.", "properties": { "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "options": [ { "value": "Draft", "type": "String", "displayName": "Draft", "required": false }, { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": false, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "If not specified will default to Submitted." } ] } }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the credit note has been issued by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the credit note was allocated", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "options": [ { "value": "AUD", "type": "String", "displayName": "Australian Dollar", "required": false }, { "value": "CAD", "type": "String", "displayName": "Canadian Dollar", "required": false }, { "value": "GBP", "type": "String", "displayName": "Pound Sterling", "required": false }, { "value": "USD", "type": "String", "displayName": "US Dollar", "required": false }, { "value": "ZAR", "type": "String", "displayName": "Rand", "required": false } ], "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Must be provided if CurrencyRate is set." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": false, "validation": { "warnings": [], "information": [ { "field": "Note", "details": "Must contain no more than 1000 characters." } ] } }, "lineItems": { "type": "Array", "displayName": "Line items", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.Description", "details": "Must contain no more than 1000 characters." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must not be negative." } ] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [], "information": [ { "field": "TaxRateRef.Id", "details": "Must be an existing tax rate in Sage Intacct." } ] } } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxRateRef", "details": "Must be provided when TaxAmount is set." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxAmount", "details": "Must not be negative." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must contain at least one line item." } ] } } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Accounts Payable Credit Note", "description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.", "properties": { "billCreditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": true }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the credit note has been issued by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true }, "supplierName": { "type": "String", "displayName": "Name", "description": "The name of the supplier referenced by the identifier", "required": true } }, "required": true }, "withholdingTax": { "type": "Array", "displayName": "Withholding Tax", "description": "A collection of tax deductions", "properties": { "name": { "type": "String", "displayName": "Name", "description": "Name of the deduction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "Deduction amount", "required": true } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the credit note, inclusive of discounts and tax", "required": true }, "totalDiscount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given credit note currency, of any discounts applied", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the credit note, inclusive of discounts but exclusive of tax", "required": true }, "totalTaxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the credit note", "required": true }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": true }, "remainingCredit": { "type": "Number", "displayName": "Remaining Credit", "description": "Unused balance of total amount originally raised", "required": true }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the credit note was allocated", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": true }, "lineItems": { "type": "Array", "displayName": "Line items", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given credit note currency, of any discounts applied", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": true }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": true } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the item referenced by the identifier", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": true } }, "required": true }, "tracking": { "type": "Object", "displayName": "Accounts Payable Tracking", "description": "A collection of items this line item is being tracked against", "properties": { "categoryRefs": { "type": "Array", "displayName": "Category References", "description": "A collection of categories this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": true } }, "required": true }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true }, "companyName": { "type": "String", "displayName": "Name", "description": "The name of the customer referenced by the identifier", "required": true } }, "required": true }, "projectRef": { "type": "Object", "displayName": "Project Reference", "description": "Reference to the project this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the Project", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the Project referenced by the identifier", "required": true } }, "required": true }, "isBilledTo": { "type": "String", "displayName": "Is Billed To", "description": "The type of item this line item is billed to.", "required": true }, "isRebilledTo": { "type": "String", "displayName": "Is Rebilled To", "description": "The type of item this line item is billed to", "required": true } }, "required": true } }, "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments that are allocated to (i.e. spend) the credit note", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the allocated payment", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the allocated payment", "required": true }, "reference": { "type": "String", "displayName": "Reference", "description": "Reference associated with the allocated payment", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the base company", "required": true }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": true } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the transaction", "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": true } }, "required": true } }, "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Accounts Payable Credit Note", "description": "A bill credit note can be thought of as a voucher issued by a supplier. It can be applied against one or multiple bills to reduce their balance.", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the credit note has been issued by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must be a valid GUID." }, { "field": "SupplierRef.Id", "details": "Must match the ID of an existing supplier." } ], "information": [ { "field": "SupplierRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "SupplierRef", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the credit note, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must be greater than zero." } ], "information": [ { "field": "TotalAmount", "details": "Must be provided and must equal the sum of the link items amount." } ] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must be provided." } ] } }, "billCreditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": false, "validation": { "warnings": [], "information": [ { "field": "BillCreditNoteNumber", "details": "Must not be longer than 225 characters long." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "options": [ { "value": "Draft", "type": "String", "displayName": "Draft", "required": false }, { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false }, { "value": "Paid", "type": "String", "displayName": "Paid", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "Must be provided." } ] } }, "lineItems": { "type": "Array", "displayName": "Line items", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TotalAmount", "details": "Must be provided." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a valid GUID." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided" } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.AccountRef", "details": "Must be provided." } ] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [], "information": [ { "field": "TrackingCategoryRefs.Id", "details": "Must be provided." } ] } } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TrackingCategoryRefs", "details": "Tracking categories must not have the same parent tracking category." }, { "field": "LineItems.TrackingCategoryRefs", "details": "Maximum of 2 Tracking Categories." } ] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must be a valid GUID." }, { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must be provided." } ] } } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-update-billCreditNotes-model", "description": "The *Get create/update bill credit note model* endpoint returns the expected data for the request payload when creating and updating a [bill credit note](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) for a given company and integration.\n\n[Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support creating and updating a bill credit note.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/billCreditNotes": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Bill credit notes" ], "summary": "Create bill credit note", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillCreditNote" }, "examples": { "QuickBooks Online": { "value": { "billCreditNoteNumber": "309", "supplierRef": { "id": "87", "supplierName": "Ankunding Inc" }, "withholdingTax": [], "totalAmount": 100, "totalDiscount": 0, "subTotal": 100, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 100, "status": "Submitted", "issueDate": "2023-04-20T00:00:00", "currency": "GBP", "currencyRate": 1.242097, "lineItems": [ { "description": "", "unitAmount": 100, "quantity": 1, "subTotal": 100, "taxAmount": 0, "totalAmount": 100, "accountRef": { "id": "7" }, "taxRateRef": { "id": "NON", "name": "NON", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" } } ] } }, "Xero": { "value": { "billCreditNoteNumber": "1234567", "supplierRef": { "id": "3a0d40a2-2698-4cf5-b7b2-30133c632ab6" }, "withholdingTax": [], "totalAmount": 25.44, "totalDiscount": 0, "subTotal": 25.44, "totalTaxAmount": 4.24, "discountPercentage": 0, "remainingCredit": 0, "status": "Submitted", "issueDate": "2023-02-09T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Refund as agreed due to window break when guard absent", "unitAmount": 21.2, "quantity": 1, "discountAmount": 0, "subTotal": 21.2, "taxAmount": 4.24, "totalAmount": 25.44, "accountRef": { "id": "f96c9458-d724-47bf-8f74-a9d5726465ce" }, "discountPercentage": 0, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [] } ] } }, "NetSuite": { "value": { "billCreditNoteNumber": "VENDCRED1987", "supplierRef": { "id": "727" }, "withholdingTax": [], "totalAmount": 10, "totalDiscount": 0, "subTotal": 10, "totalTaxAmount": 0, "discountPercentage": 0, "status": "Submitted", "issueDate": "2023-04-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "", "unitAmount": 10, "quantity": 1, "subTotal": 10, "totalAmount": 10, "accountRef": { "id": "714" }, "trackingCategoryRefs": [ { "id": "department-4", "name": "DP Department - incl children" } ], "tracking": { "categoryRefs": [ { "id": "department-4", "name": "DP Department - incl children" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ] } }, "Sage Intacct": { "value": { "supplierRef": { "id": "3" }, "withholdingTax": [], "totalAmount": 360, "totalDiscount": 0, "subTotal": 300, "totalTaxAmount": 60, "discountPercentage": 0, "status": "Submitted", "issueDate": "2021-09-24T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "No Description Provided", "unitAmount": 300, "quantity": 1, "subTotal": 300, "taxAmount": 60, "totalAmount": 360, "accountRef": { "id": "197", "name": "Software and Licenses" }, "taxRateRef": { "id": "81", "name": "UK Purchase Goods Standard Rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "LOCATION-15", "name": "United Kingdom" }, { "id": "SUPPLIER-3", "name": "ADP" } ], "tracking": { "categoryRefs": [ { "id": "LOCATION-15" }, { "id": "SUPPLIER-3", "name": "ADP" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" } } ] } }, "MYOB": { "value": { "billCreditNoteNumber": "XYZ0012", "supplierRef": { "id": "5c0664ca-6eb1-4085-9da4-37ef748bc65e", "supplierName": "Metropolitan Electricity" }, "withholdingTax": [], "totalAmount": 900, "totalDiscount": 0, "subTotal": 1000, "totalTaxAmount": 100, "discountPercentage": 0, "status": "Submitted", "issueDate": "2023-04-20T00:00:00", "currency": "AUD", "lineItems": [ { "description": "Credit note for incorrect bill", "unitAmount": 900, "quantity": 1, "subTotal": 900, "taxAmount": 100, "totalAmount": 900, "accountRef": { "id": "f04d046b-0137-4d95-8af7-ed9fef1a4ba3" }, "taxRateRef": { "id": "ff083e95-de4e-4c56-87dd-32ad9cdac172", "name": "Capital Acquisitions", "effectiveTaxRate": 10 } } ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBillCreditNoteResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create bill credit note* endpoint creates a new [bill credit note](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) for a given company's connection.\n\n[Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update bill credit note model](https://docs.codat.io/accounting-api#/operations/get-create-update-billCreditNotes-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support creating an account.\n", "operationId": "create-bill-credit-note" } }, "/companies/{companyId}/connections/{connectionId}/push/billCreditNotes/{billCreditNoteId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/billCreditNoteId" } ], "put": { "tags": [ "Bill credit notes" ], "summary": "Update bill credit note", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/forceUpdate" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillCreditNote" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBillCreditNoteResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Update bill credit note* endpoint updates an existing [bill credit note](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) for a given company's connection.\n\n[Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update bill credit note model](https://docs.codat.io/accounting-api#/operations/get-create-update-billCreditNotes-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support creating an account.\n", "operationId": "update-bill-credit-note" } }, "/companies/{companyId}/connections/{connectionId}/push/billCreditNotes/{billCreditNoteId}/attachment": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/billCreditNoteId" } ], "post": { "tags": [ "Bill credit notes" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AttachmentUpload" } } } }, "responses": { "200": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Upload bill credit note attachment", "description": "---\nstoplight-id: c26f5b1b19168\n---\n\nThe *Upload bill credit note attachment* endpoint uploads an attachment and assigns it against a specific `billCreditNoteId`.\n\n[Bill Credit Notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.\n\n**Integration-specific behaviour**\n\nFor more details on supported file types by integration see [Attachments](https://docs.codat.io/accounting-api#/schemas/Attachment).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support uploading a bill credit note attachment.\n", "operationId": "upload-billCreditNote-attachment" } }, "/companies/{companyId}/data/billPayments": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Bill payments" ], "summary": "List bill payments", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillPayments" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "dcb18480-8b69-44d8-aa26-268b6a80d170", "supplierRef": { "id": "8GeHBdBZiZ", "supplierName": "DuBuque, Goyette and Franecki" }, "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "totalAmount": 71351.42, "currency": "GBP", "currencyRate": 1, "date": "2022-05-06T00:00:00", "note": "Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572", "paymentMethodRef": { "id": "cb4a5647-aa86-40ab-bb4f-158acaa99c12", "name": "Check payments-u4p" }, "lines": [ { "amount": 71351.42, "links": [ { "type": "Bill", "id": "81539597-e681-40c9-a4dd-ec2fffcde572", "amount": -71351.42, "currencyRate": 1 } ], "allocatedOnDate": "2022-05-06T00:00:00" } ], "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2022-05-06T00:00:00", "metadata": { "isDeleted": false } }, { "id": "ca0976d0-036d-4187-ab66-7169286b007d", "supplierRef": { "id": "9efd64dc-4b31-425d-9eb2-7c7773593713", "supplierName": "Jacobson, Konopelski and Heidenreich" }, "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "totalAmount": 16221.64, "currency": "GBP", "currencyRate": 1, "date": "2022-05-14T13:12:00", "note": "Bill Payment against bill 3f44d2be-d4c2-4cc3-8216-8add5265eb13", "paymentMethodRef": { "id": "fc87fba8-812e-4a54-b633-29ef2abf4c12", "name": "CreditCard payments-u4p" }, "lines": [ { "amount": 16221.64, "links": [ { "type": "Bill", "id": "3f44d2be-d4c2-4cc3-8216-8add5265eb13", "amount": -16221.64, "currencyRate": 1 } ], "allocatedOnDate": "2022-05-14T13:12:00" } ], "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2022-05-14T13:12:00", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 232, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "19387f05-8ad1-ea11-bbaa-000d3a2b9185", "supplierRef": { "id": "c41217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "Wide World Importers" }, "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" }, "totalAmount": 234, "currency": "GBP", "currencyRate": 1, "date": "2019-01-01T00:00:00", "note": "Invoice 107006", "lines": [ { "amount": 234, "links": [ { "type": "Bill", "id": "c8cb06bf-89d1-ea11-bbaa-000d3a2b9185-108006", "amount": -234, "currencyRate": 1 } ], "allocatedOnDate": "2019-01-01T00:00:00" } ], "modifiedDate": "2023-03-27T14:21:25Z", "reference": "108006", "metadata": { "isDeleted": false } }, { "id": "3d387f05-8ad1-ea11-bbaa-000d3a2b9185", "supplierRef": { "id": "be1217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "Fabrikam, Inc." }, "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" }, "totalAmount": 390, "currency": "GBP", "currencyRate": 1, "date": "2019-01-01T00:00:00", "note": "Invoice 107007", "lines": [ { "amount": 390, "links": [ { "type": "Bill", "id": "cbcb06bf-89d1-ea11-bbaa-000d3a2b9185-108007", "amount": -390, "currencyRate": 1 } ], "allocatedOnDate": "2019-01-01T00:00:00" } ], "modifiedDate": "2023-03-27T14:21:25Z", "reference": "108007", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 236, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "da7e456f-76f7-42ac-8dad-d90a040f3afb", "supplierRef": { "id": "63fadca8-4905-475a-b32a-b4341293bcf4", "supplierName": "Kelly's Industrial Supplies" }, "accountRef": { "id": "d79d65bd-1d7d-4f55-95d3-76b3a7b7b823", "name": "Bank 1" }, "totalAmount": -5, "currency": "EUR", "currencyRate": 1, "date": "2019-11-05T00:00:00Z", "lines": [ { "amount": -5, "links": [ { "type": "PaymentOnAccount", "id": "63fadca8-4905-475a-b32a-b4341293bcf4", "amount": 5, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:35:13Z", "sourceModifiedDate": "2019-11-05T14:26:22Z", "reference": "19200008" }, { "id": "002b8462-f3a3-4019-84fe-6a2af1f30c5a", "supplierRef": { "id": "5811b467-53eb-4491-8ca1-bc9b7889811b", "supplierName": "Ann's test supplier 2" }, "accountRef": { "id": "1879b322-7758-4e20-8f3f-701df27f2340", "name": "Kas" }, "totalAmount": 0.13, "currency": "EUR", "currencyRate": 1, "date": "2019-11-07T00:00:00Z", "lines": [ { "amount": -0.12, "links": [ { "type": "CreditNote", "id": "33f3016c-2ecf-4d17-911e-b385537e7341", "amount": 0.12, "currencyRate": 1 } ] }, { "amount": 0.12, "links": [ { "type": "Bill", "id": "de6b3634-faf2-4688-b06b-72ed3ca6cf4e", "amount": -0.12, "currencyRate": 1 } ] }, { "amount": 0.13, "links": [ { "type": "Bill", "id": "de6b3634-faf2-4688-b06b-72ed3ca6cf4e", "amount": -0.13, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:35:14Z", "sourceModifiedDate": "2021-11-17T12:08:10Z", "reference": "19100002" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1173, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "7a5f621b-739f-4ed8-b738-2aae3ef886ac", "supplierRef": { "id": "a7cad20d-44db-442b-ac1f-90475802d6fb", "supplierName": "Pencils Pencils Pencils" }, "accountRef": { "id": "4a4e34b5-7f62-4b64-a44a-073398b14b41", "name": "Bank" }, "totalAmount": 123, "currency": "GBP", "currencyRate": 1, "date": "2017-10-11T00:00:00Z", "lines": [ { "amount": 123, "links": [ { "type": "Bill", "id": "e7a45898-2db3-424c-acb9-a51647740f26", "amount": -123, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:33:17Z", "sourceModifiedDate": "2017-10-11T10:12:29Z", "reference": "17200006" }, { "id": "b358df76-3930-42ad-8f38-78edcc60172d", "supplierRef": { "id": "41302634-76b5-4442-b800-0bb63780e77c", "supplierName": "Some Supplier" }, "accountRef": { "id": "4a4e34b5-7f62-4b64-a44a-073398b14b41", "name": "Bank" }, "totalAmount": 55000, "currency": "GBP", "currencyRate": 1, "date": "2017-10-31T00:00:00Z", "lines": [ { "amount": 55000, "links": [ { "type": "PaymentOnAccount", "id": "41302634-76b5-4442-b800-0bb63780e77c", "amount": -55000, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:33:17Z", "sourceModifiedDate": "2019-02-14T17:56:54Z", "reference": "17200001" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 39, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "135234103", "supplierRef": { "id": "7169654", "supplierName": "The Eagle" }, "totalAmount": 14.3, "currency": "GBP", "date": "2017-11-23T00:00:00", "note": "ATOMIC SOFTWARE LIMITE WELLINGTON,NZL OTHER �14.30 - Bill payment against Pints1 (The Eagle)", "lines": [ { "amount": 14.3, "links": [ { "type": "Bill", "id": "10659723", "amount": -14.3, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-25T14:21:36Z", "metadata": { "isDeleted": false } }, { "id": "168350314", "supplierRef": { "id": "6161941", "supplierName": "A & J Fabtech Ltd" }, "totalAmount": 30, "currency": "GBP", "date": "2019-01-03T00:00:00", "note": "�30.00 - Bill payment against Test123 (A & J Fabtech Ltd)", "lines": [ { "amount": 30, "links": [ { "type": "Bill", "id": "11224800", "amount": -30, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-25T14:21:36Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 89, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "16", "supplierRef": { "id": "29" }, "accountRef": { "id": "167679", "name": "Cash" }, "totalAmount": 10, "currency": "GBP", "date": "2021-08-18T00:00:00", "note": "Bill payment", "lines": [ { "amount": 10, "links": [ { "type": "Bill", "id": "16", "amount": -10, "currencyRate": 1 } ], "allocatedOnDate": "2021-08-18T00:00:00" } ], "modifiedDate": "2023-03-24T16:07:23Z", "metadata": { "isDeleted": false } }, { "id": "18", "supplierRef": { "id": "39" }, "accountRef": { "id": "167679", "name": "Cash" }, "totalAmount": 15, "currency": "USD", "date": "2021-08-18T00:00:00", "note": "Bill payment Ikea", "lines": [ { "amount": 15, "links": [ { "type": "Bill", "id": "18", "amount": -15, "currencyRate": 1 } ], "allocatedOnDate": "2021-08-18T00:00:00" } ], "modifiedDate": "2023-03-24T16:07:23Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 26, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "112", "supplierRef": { "id": "724", "supplierName": "Vendor A.A.A" }, "accountRef": { "id": "825", "name": "Codat Europe Bank" }, "totalAmount": 120, "currency": "GBP", "currencyRate": 1, "date": "2021-03-26T00:00:00", "lines": [ { "amount": 120, "links": [ { "type": "Bill", "id": "7", "amount": -120, "currencyRate": 1 } ] } ], "modifiedDate": "2023-01-30T14:48:40Z", "sourceModifiedDate": "2021-03-26T10:31:06", "reference": "Bill Payment #1" }, { "id": "159623-724", "supplierRef": { "id": "724", "supplierName": "Vendor A.A.A" }, "accountRef": { "id": "825", "name": "Codat Europe Bank" }, "totalAmount": -555.55, "currency": "GBP", "currencyRate": 1, "date": "2022-07-11T00:00:00", "lines": [ { "amount": -555.55, "links": [ { "type": "PaymentOnAccount", "id": "724", "amount": 555.55, "currencyRate": 1 } ] } ], "modifiedDate": "2023-01-30T14:48:40Z", "sourceModifiedDate": "2022-07-11T09:41:02", "reference": "Deposit #DEP25" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 3, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments" }, "next": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "3A09-1071529982", "supplierRef": { "id": "720000-1071512482", "supplierName": "Bayshore Auto Mall" }, "accountRef": { "id": "20000-933270541", "name": "Checking" }, "totalAmount": 532.97, "currency": "GBP", "currencyRate": 1, "date": "2023-01-11T00:00:00", "note": "Monthly Truck Payment", "lines": [ { "amount": 532.97, "links": [ { "type": "Bill", "id": "38AA-1071513625", "amount": -532.97, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:09:20Z", "sourceModifiedDate": "2023-12-16T05:04:58", "reference": "101", "metadata": { "isDeleted": false } }, { "id": "84C2-1197705262", "supplierRef": { "id": "B0000-933272656", "supplierName": "Patton Hardware Supplies" }, "accountRef": { "id": "8000007E-1197732180", "name": "CalOil Credit Card" }, "totalAmount": 4050.98, "currency": "GBP", "currencyRate": 1, "date": "2023-01-15T00:00:00", "lines": [ { "amount": 4050.98, "links": [ { "type": "Bill", "id": "84C2-1197705262", "amount": -4050.98, "currencyRate": 1 } ], "allocatedOnDate": "2023-01-15T00:00:00" } ], "modifiedDate": "2023-04-26T09:09:20Z", "sourceModifiedDate": "2023-12-16T05:06:15", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 214, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "20", "supplierRef": { "id": "4", "supplierName": "BILLy elliot" }, "totalAmount": 0, "currency": "GBP", "currencyRate": 1, "date": "2019-05-13T00:00:00", "lines": [ { "amount": 0, "links": [ { "type": "Bill", "id": "18", "amount": -5, "currencyRate": 1 }, { "type": "CreditNote", "id": "19", "amount": 5, "currencyRate": 1 } ] } ], "modifiedDate": "2023-01-18T11:02:47Z", "sourceModifiedDate": "2019-05-13T13:14:26Z" }, { "id": "25", "supplierRef": { "id": "5", "supplierName": "Callum McGinley" }, "accountRef": { "id": "63", "name": "Business Bank Account" }, "totalAmount": 5999.99, "currency": "GBP", "currencyRate": 1, "date": "2019-05-31T00:00:00", "lines": [ { "amount": 5999.99, "links": [ { "type": "Bill", "id": "24", "amount": -5999.99, "currencyRate": 1 } ] } ], "modifiedDate": "2023-01-18T11:02:47Z", "sourceModifiedDate": "2019-05-31T12:55:10Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 126, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "158", "supplierRef": { "id": "57", "supplierName": "Hall's Promo Items" }, "accountRef": { "id": "81", "name": "Current" }, "totalAmount": 7940.6, "currency": "HKD", "currencyRate": 0.078807, "date": "2016-01-23T00:00:00", "lines": [ { "amount": 7940.6, "links": [ { "type": "Bill", "id": "157", "amount": -7940.6, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:36:42Z", "sourceModifiedDate": "2016-09-13T21:19:36Z", "reference": "1067", "metadata": { "isDeleted": false } }, { "id": "159", "supplierRef": { "id": "57", "supplierName": "Hall's Promo Items" }, "accountRef": { "id": "81", "name": "Current" }, "totalAmount": 742.5, "currency": "HKD", "currencyRate": 0.078807, "date": "2016-01-23T00:00:00", "lines": [ { "amount": 742.5, "links": [ { "type": "Bill", "id": "28", "amount": -742.5, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:36:42Z", "sourceModifiedDate": "2016-09-13T21:19:49Z", "reference": "1068", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 191, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "45462", "supplierRef": { "id": "CON001", "supplierName": "Concept Stationery Supplies" }, "totalAmount": 27, "currency": "GBP", "currencyRate": 1, "date": "2020-01-05T00:00:00Z", "note": "", "lines": [ { "amount": 27, "links": [ { "type": "PaymentOnAccount", "id": "CON001", "amount": -27, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-14T09:35:54Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "reference": "Payment invoice 1" }, { "id": "45502", "supplierRef": { "id": "SDE001", "supplierName": "S D Enterprises" }, "totalAmount": 59, "currency": "GBP", "currencyRate": 1, "date": "2020-01-17T00:00:00Z", "note": "pay3", "lines": [ { "amount": 59, "links": [ { "type": "PaymentOnAccount", "id": "SDE001", "amount": -59, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-14T09:35:54Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "reference": "payment inv3" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 64, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "255", "supplierRef": { "id": "CON001", "supplierName": "Concept Stationery Supplies" }, "totalAmount": 370.71, "currency": "GBP", "currencyRate": 1, "date": "2022-01-29T00:00:00", "note": "Purchase payment 255 linked to, purchase invoice 86, purchase invoice 87, purchase invoice 250, purchase invoice 251, purchase invoice 252.", "lines": [ { "amount": 117.5, "links": [ { "type": "Bill", "id": "86", "amount": -117.5, "currencyRate": 1 } ] }, { "amount": 64.63, "links": [ { "type": "Bill", "id": "87", "amount": -64.63, "currencyRate": 1 } ] }, { "amount": 50.57, "links": [ { "type": "Bill", "id": "250", "amount": -50.57, "currencyRate": 1 } ] }, { "amount": 36.87, "links": [ { "type": "Bill", "id": "251", "amount": -36.87, "currencyRate": 1 } ] }, { "amount": 101.14, "links": [ { "type": "Bill", "id": "252", "amount": -101.14, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } }, { "id": "256", "supplierRef": { "id": "QUA001", "supplierName": "Quality Motors" }, "totalAmount": 256.36, "currency": "GBP", "currencyRate": 1, "date": "2022-01-29T00:00:00", "note": "Purchase payment 256 linked to, purchase invoice 17.", "lines": [ { "amount": 256.36, "links": [ { "type": "Bill", "id": "17", "amount": -256.36, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 27, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "d953b45e156011e8b45c025132dab352", "supplierRef": { "id": "ca430e0d156011e8b45c025132dab352", "supplierName": "Test Supplier" }, "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "totalAmount": 52.02, "currency": "GBP", "currencyRate": 1, "date": "2018-02-15T00:00:00", "note": "Supplier payment using credit/debit card - Cool stuff", "lines": [ { "amount": 52.02, "links": [ { "type": "PaymentOnAccount", "id": "ca430e0d156011e8b45c025132dab352", "amount": -52.02, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-24T14:54:04Z", "sourceModifiedDate": "2019-11-20T09:30:03Z" }, { "id": "a99b9aae216111e8b45c025132dab352", "supplierRef": { "id": "ca430e0d156011e8b45c025132dab352", "supplierName": "Test Supplier" }, "accountRef": { "id": "9a3e4bc6267a11e797950a57719b2edb", "name": "Cash" }, "totalAmount": 52.02, "currency": "GBP", "currencyRate": 1, "date": "2018-03-06T00:00:00", "note": "Supplier payment using cash", "lines": [ { "amount": 52.02, "links": [ { "type": "PaymentOnAccount", "id": "ca430e0d156011e8b45c025132dab352", "amount": -52.02, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-24T14:54:04Z", "sourceModifiedDate": "2018-03-06T17:13:17Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2225, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "4471", "supplierRef": { "id": "3", "supplierName": "ADP" }, "accountRef": { "id": "353", "name": "Current Account" }, "totalAmount": 20, "currency": "GBP", "date": "2022-01-06T00:00:00", "note": "", "paymentMethodRef": { "id": "6", "name": "Cash" }, "lines": [ { "amount": 20, "links": [ { "type": "Bill", "id": "4470", "amount": -20, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-04T16:32:13Z", "sourceModifiedDate": "2022-02-23T12:03:30", "metadata": { "isDeleted": false } }, { "id": "4472", "supplierRef": { "id": "3", "supplierName": "ADP" }, "accountRef": { "id": "353", "name": "Current Account" }, "totalAmount": 5, "currency": "GBP", "date": "2022-01-06T00:00:00", "note": "", "paymentMethodRef": { "id": "6", "name": "Cash" }, "lines": [ { "amount": 5, "links": [ { "type": "Bill", "id": "4470", "amount": -5, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-04T16:32:13Z", "sourceModifiedDate": "2022-02-23T12:06:58", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/billPayments" } } } }, "Xero": { "value": { "results": [ { "id": "74004690-82a1-4810-aaca-6ce575af94b4", "supplierRef": { "id": "1262c350-fe0f-40ec-aeff-41c95b4a45af", "supplierName": "DIISR - Small Business Services" }, "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "totalAmount": 7267.2, "currency": "GBP", "currencyRate": 1, "date": "2021-12-20T00:00:00", "lines": [ { "amount": 7267.2, "links": [ { "type": "Bill", "id": "3945273c-cc04-479f-a4b5-1e3dc7a55ed1", "amount": -7267.2, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-15T20:37:10Z", "sourceModifiedDate": "2021-01-02T22:51:40", "metadata": { "isDeleted": false } }, { "id": "f2062172-b444-4c8b-b797-9f4c7a4244c7", "supplierRef": { "id": "1262c350-fe0f-40ec-aeff-41c95b4a45af", "supplierName": "DIISR - Small Business Services" }, "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "totalAmount": 7267.2, "currency": "GBP", "currencyRate": 1, "date": "2022-02-17T00:00:00", "lines": [ { "amount": 7267.2, "links": [ { "type": "Bill", "id": "09aa506f-cb81-4cd3-a1ea-6a0b91804d5a", "amount": -7267.2, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-15T20:37:10Z", "sourceModifiedDate": "2021-01-02T22:51:38", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 30, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) for a given company's connection.\n\n[Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-bill-payments" } }, "/companies/{companyId}/data/billPayments/{billPaymentId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/billPaymentId" } ], "get": { "tags": [ "Bill payments" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillPayment" }, "examples": { "Clear Books": { "value": { "id": "dcb18480-8b69-44d8-aa26-268b6a80d170", "supplierRef": { "id": "8GeHBdBZiZ", "supplierName": "DuBuque, Goyette and Franecki" }, "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "totalAmount": 71351.42, "currency": "GBP", "currencyRate": 1, "date": "2022-05-06T00:00:00", "note": "Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572", "paymentMethodRef": { "id": "cb4a5647-aa86-40ab-bb4f-158acaa99c12", "name": "Check payments-u4p" }, "lines": [ { "amount": 71351.42, "links": [ { "type": "Bill", "id": "81539597-e681-40c9-a4dd-ec2fffcde572", "amount": -71351.42, "currencyRate": 1 } ], "allocatedOnDate": "2022-05-06T00:00:00" } ], "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2022-05-06T00:00:00", "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "19387f05-8ad1-ea11-bbaa-000d3a2b9185", "supplierRef": { "id": "c41217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "Wide World Importers" }, "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" }, "totalAmount": 234, "currency": "GBP", "currencyRate": 1, "date": "2019-01-01T00:00:00", "note": "Invoice 107006", "lines": [ { "amount": 234, "links": [ { "type": "Bill", "id": "c8cb06bf-89d1-ea11-bbaa-000d3a2b9185-108006", "amount": -234, "currencyRate": 1 } ], "allocatedOnDate": "2019-01-01T00:00:00" } ], "modifiedDate": "2023-03-27T14:21:25Z", "reference": "108006", "metadata": { "isDeleted": false } } }, "Exact (Netherlands)": { "value": { "id": "da7e456f-76f7-42ac-8dad-d90a040f3afb", "supplierRef": { "id": "63fadca8-4905-475a-b32a-b4341293bcf4", "supplierName": "Kelly's Industrial Supplies" }, "accountRef": { "id": "d79d65bd-1d7d-4f55-95d3-76b3a7b7b823", "name": "Bank 1" }, "totalAmount": -5, "currency": "EUR", "currencyRate": 1, "date": "2019-11-05T00:00:00Z", "lines": [ { "amount": -5, "links": [ { "type": "PaymentOnAccount", "id": "63fadca8-4905-475a-b32a-b4341293bcf4", "amount": 5, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:35:13Z", "sourceModifiedDate": "2019-11-05T14:26:22Z", "reference": "19200008" } }, "Exact (UK)": { "value": { "id": "7a5f621b-739f-4ed8-b738-2aae3ef886ac", "supplierRef": { "id": "a7cad20d-44db-442b-ac1f-90475802d6fb", "supplierName": "Pencils Pencils Pencils" }, "accountRef": { "id": "4a4e34b5-7f62-4b64-a44a-073398b14b41", "name": "Bank" }, "totalAmount": 123, "currency": "GBP", "currencyRate": 1, "date": "2017-10-11T00:00:00Z", "lines": [ { "amount": 123, "links": [ { "type": "Bill", "id": "e7a45898-2db3-424c-acb9-a51647740f26", "amount": -123, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:33:17Z", "sourceModifiedDate": "2017-10-11T10:12:29Z", "reference": "17200006" } }, "FreeAgent": { "value": { "id": "135234103", "supplierRef": { "id": "7169654", "supplierName": "The Eagle" }, "totalAmount": 14.3, "currency": "GBP", "date": "2017-11-23T00:00:00", "note": "ATOMIC SOFTWARE LIMITE WELLINGTON,NZL OTHER �14.30 - Bill payment against Pints1 (The Eagle)", "lines": [ { "amount": 14.3, "links": [ { "type": "Bill", "id": "10659723", "amount": -14.3, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-25T14:21:36Z", "metadata": { "isDeleted": false } } }, "FreshBooks": { "value": { "id": "16", "supplierRef": { "id": "29" }, "accountRef": { "id": "167679", "name": "Cash" }, "totalAmount": 10, "currency": "GBP", "date": "2021-08-18T00:00:00", "note": "Bill payment", "lines": [ { "amount": 10, "links": [ { "type": "Bill", "id": "16", "amount": -10, "currencyRate": 1 } ], "allocatedOnDate": "2021-08-18T00:00:00" } ], "modifiedDate": "2023-03-24T16:07:23Z", "metadata": { "isDeleted": false } } }, "Oracle NetSuite": { "value": { "id": "112", "supplierRef": { "id": "724", "supplierName": "Vendor A.A.A" }, "accountRef": { "id": "825", "name": "Codat Europe Bank" }, "totalAmount": 120, "currency": "GBP", "currencyRate": 1, "date": "2021-03-26T00:00:00", "lines": [ { "amount": 120, "links": [ { "type": "Bill", "id": "7", "amount": -120, "currencyRate": 1 } ] } ], "modifiedDate": "2023-01-30T14:48:40Z", "sourceModifiedDate": "2021-03-26T10:31:06", "reference": "Bill Payment #1" } }, "QuickBooks Desktop": { "value": { "id": "3A09-1071529982", "supplierRef": { "id": "720000-1071512482", "supplierName": "Bayshore Auto Mall" }, "accountRef": { "id": "20000-933270541", "name": "Checking" }, "totalAmount": 532.97, "currency": "GBP", "currencyRate": 1, "date": "2023-01-11T00:00:00", "note": "Monthly Truck Payment", "lines": [ { "amount": 532.97, "links": [ { "type": "Bill", "id": "38AA-1071513625", "amount": -532.97, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:09:20Z", "sourceModifiedDate": "2023-12-16T05:04:58", "reference": "101", "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "20", "supplierRef": { "id": "4", "supplierName": "BILLy elliot" }, "totalAmount": 0, "currency": "GBP", "currencyRate": 1, "date": "2019-05-13T00:00:00", "lines": [ { "amount": 0, "links": [ { "type": "Bill", "id": "18", "amount": -5, "currencyRate": 1 }, { "type": "CreditNote", "id": "19", "amount": 5, "currencyRate": 1 } ] } ], "modifiedDate": "2023-01-18T11:02:47Z", "sourceModifiedDate": "2019-05-13T13:14:26Z" } }, "QuickBooks Online Sandbox": { "value": { "id": "158", "supplierRef": { "id": "57", "supplierName": "Hall's Promo Items" }, "accountRef": { "id": "81", "name": "Current" }, "totalAmount": 7940.6, "currency": "HKD", "currencyRate": 0.078807, "date": "2016-01-23T00:00:00", "lines": [ { "amount": 7940.6, "links": [ { "type": "Bill", "id": "157", "amount": -7940.6, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:36:42Z", "sourceModifiedDate": "2016-09-13T21:19:36Z", "reference": "1067", "metadata": { "isDeleted": false } } }, "Sage 200cloud": { "value": { "id": "45462", "supplierRef": { "id": "CON001", "supplierName": "Concept Stationery Supplies" }, "totalAmount": 27, "currency": "GBP", "currencyRate": 1, "date": "2020-01-05T00:00:00Z", "note": "", "lines": [ { "amount": 27, "links": [ { "type": "PaymentOnAccount", "id": "CON001", "amount": -27, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-14T09:35:54Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "reference": "Payment invoice 1" } }, "Sage 50 (UK)": { "value": { "id": "255", "supplierRef": { "id": "CON001", "supplierName": "Concept Stationery Supplies" }, "totalAmount": 370.71, "currency": "GBP", "currencyRate": 1, "date": "2022-01-29T00:00:00", "note": "Purchase payment 255 linked to, purchase invoice 86, purchase invoice 87, purchase invoice 250, purchase invoice 251, purchase invoice 252.", "lines": [ { "amount": 117.5, "links": [ { "type": "Bill", "id": "86", "amount": -117.5, "currencyRate": 1 } ] }, { "amount": 64.63, "links": [ { "type": "Bill", "id": "87", "amount": -64.63, "currencyRate": 1 } ] }, { "amount": 50.57, "links": [ { "type": "Bill", "id": "250", "amount": -50.57, "currencyRate": 1 } ] }, { "amount": 36.87, "links": [ { "type": "Bill", "id": "251", "amount": -36.87, "currencyRate": 1 } ] }, { "amount": 101.14, "links": [ { "type": "Bill", "id": "252", "amount": -101.14, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } } }, "Sage Business Cloud Accounting": { "value": { "id": "d953b45e156011e8b45c025132dab352", "supplierRef": { "id": "ca430e0d156011e8b45c025132dab352", "supplierName": "Test Supplier" }, "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "totalAmount": 52.02, "currency": "GBP", "currencyRate": 1, "date": "2018-02-15T00:00:00", "note": "Supplier payment using credit/debit card - Cool stuff", "lines": [ { "amount": 52.02, "links": [ { "type": "PaymentOnAccount", "id": "ca430e0d156011e8b45c025132dab352", "amount": -52.02, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-24T14:54:04Z", "sourceModifiedDate": "2019-11-20T09:30:03Z" } }, "Sage Intacct": { "value": { "id": "4471", "supplierRef": { "id": "3", "supplierName": "ADP" }, "accountRef": { "id": "353", "name": "Current Account" }, "totalAmount": 20, "currency": "GBP", "date": "2022-01-06T00:00:00", "note": "", "paymentMethodRef": { "id": "6", "name": "Cash" }, "lines": [ { "amount": 20, "links": [ { "type": "Bill", "id": "4470", "amount": -20, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-04T16:32:13Z", "sourceModifiedDate": "2022-02-23T12:03:30", "metadata": { "isDeleted": false } } }, "Xero": { "value": { "id": "74004690-82a1-4810-aaca-6ce575af94b4", "supplierRef": { "id": "1262c350-fe0f-40ec-aeff-41c95b4a45af", "supplierName": "DIISR - Small Business Services" }, "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "totalAmount": 7267.2, "currency": "GBP", "currencyRate": 1, "date": "2021-12-20T00:00:00", "lines": [ { "amount": 7267.2, "links": [ { "type": "Bill", "id": "3945273c-cc04-479f-a4b5-1e3dc7a55ed1", "amount": -7267.2, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-15T20:37:10Z", "sourceModifiedDate": "2021-01-02T22:51:40", "metadata": { "isDeleted": false } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get bill payment", "description": "The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId.\n\n[Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments) for integrations that support getting a specific bill payment.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-bill-payments" } }, "/companies/{companyId}/connections/{connectionId}/push/billPayments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Bill payments" ], "summary": "Create bill payments", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillPayment" }, "examples": { "Sage 50 (UK)": { "value": { "supplierRef": { "id": "SUPP1", "supplierName": "string" }, "accountRef": { "id": "1200", "name": "string" }, "totalAmount": 15.38, "currency": "GBP", "currencyRate": 1, "date": "2023-01-05T12:33:25.339Z", "note": "note - billpayment on 20230220 of 15.38", "paymentMethodRef": { "id": "string", "name": "string" }, "lines": [ { "amount": 15.38, "links": [ { "type": "Bill", "id": "3", "amount": -15.38, "currencyRate": 1 } ], "allocatedOnDate": "2023-01-05T12:33:25.339Z" } ], "modifiedDate": "2023-01-05T12:33:25.339Z", "sourceModifiedDate": "2023-01-05T12:33:25.339Z", "reference": "reference 20230220 15.38", "metadata": { "isDeleted": true } } }, "QuickBooks Online": { "value": { "supplierRef": { "id": "77", "supplierName": "AtoB" }, "accountRef": { "id": "122" }, "totalAmount": 2500, "currency": "USD", "currencyRate": 1, "date": "2023-04-17T00:00:00", "lines": [ { "amount": 2500, "links": [ { "type": "Bill", "id": "302", "amount": -1200, "currencyRate": 1 }, { "type": "Bill", "id": "303", "amount": -1300, "currencyRate": 1 } ] } ], "reference": "1" } }, "Xero": { "value": { "supplierRef": { "id": "dec56ceb-65e9-43b3-ac98-7fe09eb37e31" }, "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4" }, "totalAmount": 244.45, "currency": "GBP", "currencyRate": 1, "date": "2023-04-17T00:00:00", "lines": [ { "amount": 135.85, "links": [ { "type": "Bill", "id": "59978bef-af2f-4a7e-9728-4997597c0980", "amount": -135.85, "currencyRate": 1 } ] }, { "amount": 108.6, "links": [ { "type": "Bill", "id": "2175c381-d323-4e20-8c94-7680ea7f85d3", "amount": -108.6, "currencyRate": 1 } ] } ] } }, "NetSuite": { "value": { "supplierRef": { "id": "727" }, "accountRef": { "id": "854" }, "totalAmount": 110, "currency": "GBP", "date": "2023-05-09T00:00:00", "lines": [ { "amount": 110, "links": [ { "type": "Bill", "id": "8", "amount": -120 }, { "type": "CreditNote", "id": "462792", "amount": 10 } ] } ] } }, "Sage Intacct": { "value": { "supplierRef": { "id": "3" }, "paymentMethodRef": { "id": "6", "name": "Cash" }, "accountRef": { "id": "360" }, "totalAmount": 45, "currency": "USD", "date": "2023-04-25T00:00:00", "lines": [ { "amount": 45, "links": [ { "type": "Bill", "id": "26572", "amount": -405 }, { "type": "CreditNote", "id": "26573", "amount": 360 } ] } ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBillPaymentResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create bill payment* endpoint creates a new [bill payment](https://docs.codat.io/accounting-api#/schemas/BillPayment) for a given company's connection.\n\n[Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create bill payment model](https://docs.codat.io/accounting-api#/operations/get-create-billPayments-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments) for integrations that support creating a bill payment.\n", "operationId": "create-bill-payment" } }, "/companies/{companyId}/connections/{connectionId}/options/billPayments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create bill payment model", "tags": [ "Bill payments" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Dynamics 365 Business Central": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the payment has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "An account ID must be provided if not allocating against bill" } ], "information": [] } } }, "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": true, "validation": { "warnings": [ { "field": "Currency", "details": "Must be a valid currency code" } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": true, "validation": { "warnings": [ { "field": "Lines.AllocatedOnDate", "details": "AllocatedOnDate must be specified and be later than the issue date of the bill" } ], "information": [] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true } }, "required": true } }, "required": true } }, "required": true } }, "FreeAgent": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [] } } }, "required": true }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must match the sum of the line amounts." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": true }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Amount", "details": "Must match the sum of the link amounts." } ] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Bill", "type": "String", "displayName": "Bill", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "Bill Credit Note", "required": false }, { "value": "Other", "type": "String", "displayName": "Other", "required": false } ], "required": true } }, "required": true } }, "required": true, "validation": { "warnings": [ { "field": "Lines", "details": "Only one line may be specified" } ], "information": [] } } }, "required": true } }, "MYOB AccountRight and Essentials": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the payment has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must be a valid GUID." }, { "field": "SupplierRef.Id", "details": "Must match the ID of an existing supplier." } ], "information": [ { "field": "SupplierRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "SupplierRef", "details": "Must be provided." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a valid GUID." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Precision must be maximum of two decimal places." }, { "field": "TotalAmount", "details": "Must be greater than zero." } ], "information": [ { "field": "TotalAmount", "details": "Must be provided and must equal the sum of the link items amount." } ] } }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true, "validation": { "warnings": [], "information": [ { "field": "Date", "details": "Must be provided." } ] } }, "reference": { "type": "String", "displayName": "Reference", "description": "A user friendly reference for the payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Reference", "details": "Must not be greater than 8 characters long." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "options": [ { "value": "AUD", "type": "String", "displayName": "Australian Dollar", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Must be provided." } ] } }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Amount", "details": "Must be provided." } ] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Id", "details": "Must be provided." } ] } }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true, "validation": { "warnings": [ { "field": "Links.Amount", "details": "Precision must be maximum of two decimal places." } ], "information": [ { "field": "Links.Amount", "details": "Must be provided." } ] } }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Bill", "type": "String", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Type", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Links", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines", "details": "Must be provided." } ] } } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the payment has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account of type 'Bank' OR type 'Credit Card'" } ], "information": [] } } }, "required": true }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": true, "validation": { "warnings": [ { "field": "Currency", "details": "If the currency is set make sure it's the same as the 'Bill' and/or 'VendorCredit' currency" } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false }, "reference": { "type": "String", "displayName": "Reference", "description": "A user friendly reference for the payment", "required": false, "validation": { "warnings": [ { "field": "Reference", "details": "The id format should be 'location-'" } ], "information": [ { "field": "Reference", "details": "This field can be used to provide a tracking category id (Location only)" } ] } }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true, "validation": { "warnings": [ { "field": "Links.Id", "details": "Ensure the status of the linked bill is either 'PartiallyPaid' or 'Submitted'" } ], "information": [] } }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Bill", "type": "String", "displayName": "Bill", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "Bill Credit Note", "required": false } ], "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true } }, "required": true } }, "required": true } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the payment has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must match the ID of an existing supplier." } ], "information": [] } } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing Bank or Credit Card account." } ], "information": [ { "field": "AccountRef.Id", "details": "If an ID which corresponds to a bank account is provided, a 'bill payment check' will be added to Quickbooks Desktop, If an ID which corresponds to a credit card account is provided, a 'bill payment credit card' will be added Quickbooks Desktop. " } ] } } }, "required": true }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "Must be a three letter ISO code that matches the currency of the supplier" }, { "field": "Currency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "Currency", "details": "If not set, will default to the default currency of the supplier" } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1." }, { "field": "CurrencyRate", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must match the sum of amounts in the lines" } ], "information": [] } }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true, "validation": { "warnings": [ { "field": "Lines.Amount", "details": "Amount plus the sum of amounts in the links must equal 0" } ], "information": [] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Bill", "type": "String", "displayName": "Bill", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "Credit Note", "required": false } ], "required": true, "validation": { "warnings": [ { "field": "Links.Type", "details": "Exactly 1 link with type 'Bill' must be specified per line" } ], "information": [] } }, "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true } }, "required": true } }, "required": true } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the payment has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "SupplierRef", "details": "Must be the ID of the Supplier associated with the Bill or Credit Note." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "AccountRef", "details": "Required if TotalAmount is greater than zero." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Required if multi-currency is enabled for the company." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "Required if Currency is not the base currency." } ] } }, "paymentMethodRef": { "type": "Object", "displayName": "Payment Method Reference", "description": "The method of payment", "required": false, "validation": { "warnings": [ { "field": "PaymentMethodRef", "details": "If provided it will be ignored." } ], "information": [] } }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true, "validation": { "warnings": [ { "field": "Lines.Amount", "details": "Amount and sum of Links must sum to zero." } ], "information": [] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Bill", "type": "String", "displayName": "Bill", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "Credit Note", "required": false } ], "required": true }, "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true } }, "required": true } }, "required": true } }, "required": true } }, "QuickBooks Online": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the payment has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "SupplierRef", "details": "Must be the ID of the Supplier associated with the Bill or Credit Note." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "AccountRef", "details": "Required if TotalAmount is greater than zero." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Required if multi-currency is enabled for the company." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "Required if Currency is not the base currency." } ] } }, "paymentMethodRef": { "type": "Object", "displayName": "Payment Method Reference", "description": "The method of payment", "required": false, "validation": { "warnings": [ { "field": "PaymentMethodRef", "details": "If provided it will be ignored." } ], "information": [] } }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true, "validation": { "warnings": [ { "field": "Lines.Amount", "details": "Amount and sum of Links must sum to zero." } ], "information": [] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Bill", "type": "String", "displayName": "Bill", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "Credit Note", "required": false } ], "required": true }, "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true } }, "required": true } }, "required": true } }, "required": true } }, "Sage 50 (UK)": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "accountRef": { "type": "Object", "displayName": "Bank Account", "description": "The bank account to pay this bill from.", "properties": { "id": { "type": "String", "displayName": "Account Id", "description": "Nominal code of the bank account.", "required": true, "validation": { "warnings": [ { "field": "accountRef.id", "details": "Must match the ID of an existing bank account and have a max length of 8 characters." } ], "information": [] } } }, "required": true }, "supplierRef": { "type": "Object", "displayName": "Supplier", "description": "Supplier to be paid.", "properties": { "id": { "type": "String", "displayName": "Supplier Id", "description": "Identifier of the supplier.", "required": true, "validation": { "warnings": [ { "field": "supplierRef.id", "details": "Must match the ID of an existing supplier and have a max length of 8 characters." } ], "information": [] } } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount being paid to the supplier.", "required": true, "validation": { "warnings": [], "information": [ { "details": "This must equal the sum of the line amounts" } ] } }, "reference": { "type": "Number", "displayName": "Reference", "description": "The user reference for this bill payment.", "required": false }, "date": { "type": "Number", "displayName": "Issue Date", "description": "The date this payment was issued.", "required": true }, "note": { "type": "Number", "displayName": "Note", "description": "A description of the payment.", "required": false }, "lines": { "type": "Array", "displayName": "Line Items", "description": "Line items of the payment.", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The amount of this line item", "required": true, "validation": { "warnings": [], "information": [ { "details": "this must equal the negative of the sum of the link amounts" } ] } }, "links": { "type": "Array", "displayName": "Links", "description": "Links to the bills being paid.", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The amount to be added to the value of the bill", "required": true, "validation": { "warnings": [], "information": [ { "details": "When paying off a bill, this value will be negative" } ] } }, "id": { "type": "String", "displayName": "Bill Id", "description": "The ID of the bill to pay", "required": true }, "type": { "type": "String", "displayName": "Payment Link Type", "description": "The type of the item to be paid", "options": [ { "value": "Bill", "type": "String", "displayName": "Bill", "required": false } ], "required": true } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Sage 50 only supports one line item per bill payment so all lines will be merged together in the response." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company." } ] } } }, "Sage Business Cloud Accounting": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": false, "validation": { "warnings": [ { "field": "AccountRef", "details": "Required unless the BillPayment is only allocating a Credit Note." } ], "information": [] } }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the payment has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must match the ID of an existing supplier." } ], "information": [ { "field": "SupplierRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true, "validation": { "warnings": [], "information": [ { "field": "Date", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must be zero when allocating against Bills using a Credit Note only." }, { "field": "TotalAmount", "details": "Must equal the sum of the link items amount." } ], "information": [ { "field": "TotalAmount", "details": "Must be provided." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Note", "details": "Should not be longer than 25 characters." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": true, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "If supplied, must match the currency of the supplier." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": false }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Id", "details": "Must be provided." } ] } }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true, "validation": { "warnings": [ { "field": "Links.Amount", "details": "Must be greater than zero except when Link Type is Bill." } ], "information": [ { "field": "Links.Amount", "details": "Must be provided." } ] } }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Bill", "type": "String", "displayName": "Bill", "required": false }, { "value": "PaymentOnAccount", "type": "String", "displayName": "PaymentOnAccount", "required": false }, { "value": "Refund", "type": "String", "displayName": "Refund", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "CreditNote", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Type", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Links", "details": "Must be provided." } ] } } }, "required": true } }, "required": true } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the payment has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be an account of type BankAccount and compatible with the type of PaymentMethodRef" } ], "information": [] } } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must be a positive amount" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "options": [ { "value": "AUD", "type": "String", "displayName": "Australian Dollar", "required": false }, { "value": "CAD", "type": "String", "displayName": "Canadian Dollar", "required": false }, { "value": "GBP", "type": "String", "displayName": "Pound Sterling", "required": false }, { "value": "USD", "type": "String", "displayName": "US Dollar", "required": false }, { "value": "ZAR", "type": "String", "displayName": "Rand", "required": false } ], "required": false }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Must be no greater than 1000 characters" } ], "information": [] } }, "paymentMethodRef": { "type": "Object", "displayName": "Payment Method Reference", "description": "The method of payment", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the payment method", "options": [ { "value": "3", "type": "String", "displayName": "Credit Card", "required": false }, { "value": "5", "type": "String", "displayName": "EFT", "required": false }, { "value": "6", "type": "String", "displayName": "Cash", "required": false } ], "required": true } }, "required": true }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true, "validation": { "warnings": [ { "field": "Lines.Amount", "details": "Must not be a negative amount" } ], "information": [] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Bill", "type": "String", "displayName": "Bill", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "CreditNote", "required": false } ], "required": true }, "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true } }, "required": true } }, "required": true } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the payment has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true }, "supplierName": { "type": "String", "displayName": "Name", "description": "The name of the supplier referenced by the identifier", "required": true } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": true }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": true }, "paymentMethodRef": { "type": "Object", "displayName": "Payment Method Reference", "description": "The method of payment", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the payment method", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the payment method referenced by the identifier", "required": true } }, "required": true }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "required": true }, "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the currency of the linked transaction", "required": true } }, "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": true } }, "required": true }, "reference": { "type": "String", "displayName": "Reference", "description": "A user friendly reference for the payment", "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true, "validation": { "warnings": [], "information": [ { "field": "Date", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must match the sum of line amounts." } ], "information": [ { "field": "TotalAmount", "details": "Must be provided." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": true, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Must be the company's base currency when pushing a batch payment." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": false, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Must be provided if paying a bill from a Bank Account." } ] } } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "AccountRef", "details": "Must be provided if paying a bill from a Bank Account." } ] } }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Amount", "details": "Must be provided." } ] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true, "validation": { "warnings": [ { "field": "Links.Id", "details": "Must be a valid GUID." } ], "information": [ { "field": "Links.Id", "details": "Bill and Bill Credit Note ID must be provided in order to allocate a Bill Credit Note to a Bill." }, { "field": "Links.Id", "details": "Must be provided." } ] } }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Amount", "details": "Must be provided." } ] } }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Bill", "type": "String", "displayName": "Bill", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "Credit Note", "required": false }, { "value": "BillPayment", "type": "String", "displayName": "Bill Payment", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Type", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Links", "details": "When a single line is provided, must only contain a single Link of type Bill, CreditNote or BillPayment, or two Links of type CreditNote and Bill for a credit note allocation." }, { "field": "Lines.Links", "details": "When more than one line is provided, it must only contain a single Link of type Bill." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines", "details": "When more than one line is provided, a batch payment will be created." } ] } } }, "required": true } }, "Zoho Books": { "value": { "type": "Object", "displayName": "BillPayment", "description": "A bill payment represents an allocation of transactions across an 'accounts payable' account (supplier)", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the payment has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "AccountRef", "details": "Must be provided when making a payment to an invoice and/or a payment on account" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": true, "validation": { "warnings": [ { "field": "Currency", "details": "Must match supplier's currency" } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": false, "validation": { "warnings": [ { "field": "CurrencyRate", "details": "Must be greater or equal to 0" } ], "information": [] } }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Bill", "type": "String", "displayName": "Bill", "required": false }, { "value": "PaymentOnAccount", "type": "String", "displayName": "PaymentOnAccount", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "CreditNote", "required": false } ], "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true, "validation": { "warnings": [ { "field": "Links.Amount", "details": "Must be less than 0 for links of type Bill and PaymentOnAccount or greater than 0 for links of type CreditNote" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "Lines.Links", "details": "If using a bill credit note to pay a bill must contain 1 bill payment line link of type CreditNote and 1 bill payment line link of type Bill. Otherwise must contain at least 1 bill payment line linkof type Bill or PaymentOnAccount" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "Lines", "details": "Must contain 1 bill payment line" } ], "information": [] } } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-billPayments-model", "description": "The *Get create bill payment model* endpoint returns the expected data for the request payload when creating a [bill payment](https://docs.codat.io/accounting-api#/schemas/BillPayment) for a given company and integration.\n\n[Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments) for integrations that support creating a bill payment.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/billPayments/{billPaymentId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/billPaymentId" } ], "delete": { "summary": "Delete bill payment", "operationId": "delete-billPayment", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOperationSummary" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "tags": [ "Bill payments" ], "description": "The *Delete bill payment* endpoint allows you to delete a specified bill payment from an accounting software.\n\n[Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.\n\n### Process\n1. Pass the `{billPaymentId}` to the *Delete bill payment* endpoint and store the `pushOperationKey` returned.\n2. Check the status of the delete operation by checking the status of the push operation either via\n 1. [Push operation webhook](https://docs.codat.io/introduction/webhooks/core-rules-types#push-operation-status-has-changed) (advised),\n 2. [Push operation status endpoint](https://docs.codat.io/codat-api#/operations/get-push-operation).\n\n A `Success` status indicates that the bill payment object was deleted from the accounting software.\n3. (Optional) Check that the bill payment was deleted from the accounting software.\n\n### Effect on related objects\nBe aware that deleting a bill payment from an accounting software might cause related objects to be modified.\n\n## Integration specifics\nIntegrations that support soft delete do not permanently delete the object in the accounting software.\n\n| Integration | Soft Delete | Details |\n|-------------|-------------|---------|\n| QuickBooks Online | No | -\n| QuickBooks Desktop | No | -\n| Oracle NetSuite | No | See [here](/integrations/accounting/netsuite/accounting-netsuite-how-deleting-bill-payments-works) to learn more.\n| Xero | Yes | - \n| Sage Intacct | No | Some bill payments in Sage Intacct can only be deleted, whilst others can only be voided. Codat have applied logic to handle this complexity. \n\n> **Supported integrations**\n>\n> This functionality is currently supported for our QuickBooks Online, QuickBooks Desktop, Oracle NetSuite, Xero and Sage Intacct integrations." } }, "/companies/{companyId}/data/bills": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Bills" ], "summary": "List bills", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bills" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "81539597-e681-40c9-a4dd-ec2fffcde572", "reference": "b465a2c9-3212-4620-889b-6328ba148215", "supplierRef": { "id": "8GeHBdBZiZ", "supplierName": "DuBuque, Goyette and Franecki" }, "purchaseOrderRefs": [], "issueDate": "2022-04-29T00:00:00", "dueDate": "2022-05-06T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Grease Trap", "unitAmount": 2781.94, "quantity": 5, "discountAmount": 0, "subTotal": 13909.7, "taxAmount": 1390.97, "totalAmount": 15300.67, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 1371.39, "quantity": 5, "discountAmount": 0, "subTotal": 6856.95, "taxAmount": 685.7, "totalAmount": 7542.65, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 1371.39, "quantity": 6, "discountAmount": 0, "subTotal": 8228.34, "taxAmount": 822.83, "totalAmount": 9051.17, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 2781.94, "quantity": 3, "discountAmount": 0, "subTotal": 8345.82, "taxAmount": 834.58, "totalAmount": 9180.4, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Underground - Trapped Road Gully 450mm x 450mm", "unitAmount": 402.89, "quantity": 8, "discountAmount": 0, "subTotal": 3223.12, "taxAmount": 322.31, "totalAmount": 3545.43, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "3abf0883-03f7-44c6-bc15-1372522d25e1", "name": "Heavy Duty Hinged Gully Grating" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Underground - Drain Bottle Gullies 90 degree Rectangular", "unitAmount": 95.08, "quantity": 7, "discountAmount": 0, "subTotal": 665.56, "taxAmount": 66.56, "totalAmount": 732.12, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "6", "name": "Back Inlet Roddable Gully 90� Outlet Rectangular Grid" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Underground - Drain Bottle Gullies 90 degree Rectangular", "unitAmount": 95.08, "quantity": 1, "discountAmount": 0, "subTotal": 95.08, "taxAmount": 9.51, "totalAmount": 104.59, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "6", "name": "Back Inlet Roddable Gully 90� Outlet Rectangular Grid" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 1371.39, "quantity": 2, "discountAmount": 0, "subTotal": 2742.78, "taxAmount": 274.28, "totalAmount": 3017.06, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 2781.94, "quantity": 1, "discountAmount": 0, "subTotal": 2781.94, "taxAmount": 278.19, "totalAmount": 3060.13, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Underground - Drain Bottle Gullies 90 degree Rectangular", "unitAmount": 95.08, "quantity": 7, "discountAmount": 0, "subTotal": 665.56, "taxAmount": 66.56, "totalAmount": 732.12, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "6", "name": "Back Inlet Roddable Gully 90� Outlet Rectangular Grid" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 1251.89, "quantity": 4, "discountAmount": 0, "subTotal": 5007.56, "taxAmount": 500.76, "totalAmount": 5508.32, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "51077072-d5c3-463b-9cb4-7da2e11886f9", "name": "150 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 1371.39, "quantity": 9, "discountAmount": 0, "subTotal": 12342.51, "taxAmount": 1234.25, "totalAmount": 13576.76, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 64864.92, "taxAmount": 6486.5, "totalAmount": 71351.42, "amountDue": 0, "modifiedDate": "2023-04-26T12:38:16Z", "sourceModifiedDate": "2023-02-14T17:09:02", "note": "Bill with 12 line items, totaling 71351.42", "paymentAllocations": [ { "payment": { "id": "dcb18480-8b69-44d8-aa26-268b6a80d170", "note": "Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572", "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-05-06T00:00:00", "totalAmount": 71351.42 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-05-06T00:00:00", "totalAmount": -71351.42 } } ], "metadata": { "isDeleted": false } }, { "id": "acc1dc9d-a21a-41b8-953e-73da4afab6e6", "reference": "d88e83b8-a5cc-4578-815d-afa263df4beb", "supplierRef": { "id": "7GObELDcsE", "supplierName": "Lakin, Schmeler and Kihn" }, "purchaseOrderRefs": [ { "id": "7f07b584-bebe-450f-aa9e-1d7aed630b66", "purchaseOrderNumber": "ee9b8e00-49a2-4d83-bc33-e2eee59a1c36" } ], "issueDate": "2022-04-30T00:00:00", "dueDate": "2022-05-15T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Underground - Drain Bottle Gullies 90 degree Rectangular", "unitAmount": 95.08, "quantity": 4, "discountAmount": 0, "subTotal": 380.32, "taxAmount": 38.03, "totalAmount": 418.35, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "6", "name": "Back Inlet Roddable Gully 90� Outlet Rectangular Grid" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 380.32, "taxAmount": 38.03, "totalAmount": 418.35, "amountDue": 0, "modifiedDate": "2023-04-26T12:38:16Z", "sourceModifiedDate": "2023-04-14T01:56:02", "note": "Bill for purchase order ee9b8e00-49a2-4d83-bc33-e2eee59a1c36", "paymentAllocations": [ { "payment": { "id": "a4fa017a-3911-4eb0-aaf9-b002c446c8c3", "note": "Bill Payment against bill acc1dc9d-a21a-41b8-953e-73da4afab6e6", "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-05-15T00:00:00", "totalAmount": 418.35 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-05-15T00:00:00", "totalAmount": -418.35 } } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 183, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "4019ee2b-d05a-ed11-8c34-000d3a0d28a2-108276", "reference": "108276", "supplierRef": { "id": "c01217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "First Up Consultants" }, "purchaseOrderRefs": [], "issueDate": "2019-01-01T00:00:00", "dueDate": "2019-01-01T00:00:00", "currency": "GBP", "lineItems": [ { "description": "ATHENS Desk", "unitAmount": 506.6, "quantity": 4, "discountAmount": 202.64, "subTotal": 1823.76, "taxAmount": 364.75, "totalAmount": 2188.51, "discountPercentage": 10, "accountRef": { "id": "6a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Inventory" }, "taxRateRef": { "id": "63bc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for DOMESTIC / STANDARD", "effectiveTaxRate": 10 }, "itemRef": { "id": "ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC", "name": "ATHENS Desk / General Business Posting Group: 'DOMESTIC' / VAT Business Posting Group: 'DOMESTIC'" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Open", "subTotal": 1823.76, "taxAmount": 364.75, "totalAmount": 2188.51, "amountDue": 2188.51, "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2022-11-02T17:02:48Z", "note": "129148", "paymentAllocations": [], "metadata": { "isDeleted": false } }, { "id": "b9cb06bf-89d1-ea11-bbaa-000d3a2b9185-108001", "reference": "108001", "supplierRef": { "id": "c01217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "First Up Consultants" }, "purchaseOrderRefs": [], "issueDate": "2019-01-01T00:00:00", "dueDate": "2019-01-01T00:00:00", "currency": "GBP", "lineItems": [ { "description": "ATHENS Desk", "unitAmount": 506.6, "quantity": 4, "discountAmount": 0, "subTotal": 2026.4, "taxAmount": 405.28, "totalAmount": 2431.68, "discountPercentage": 0, "accountRef": { "id": "6a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Inventory" }, "taxRateRef": { "id": "63bc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for DOMESTIC / STANDARD", "effectiveTaxRate": 10 }, "itemRef": { "id": "ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC", "name": "ATHENS Desk / General Business Posting Group: 'DOMESTIC' / VAT Business Posting Group: 'DOMESTIC'" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 2026.4, "taxAmount": 405.28, "totalAmount": 2431.68, "amountDue": 0, "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2022-05-17T16:29:02Z", "note": "107001", "paymentAllocations": [ { "payment": { "id": "57377f05-8ad1-ea11-bbaa-000d3a2b9185", "note": "Invoice 107001", "reference": "108001", "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2019-01-01T00:00:00", "totalAmount": 2431.68 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2019-01-01T00:00:00", "totalAmount": -2431.68 } } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 294, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "1c55118b-793e-4437-9c13-4f554b9ca989", "reference": "19600006", "supplierRef": { "id": "5e6f49b9-6489-4b82-83e7-291d308919bb", "supplierName": "Mickey Mouse" }, "purchaseOrderRefs": [], "issueDate": "2019-12-16T00:00:00Z", "dueDate": "2019-11-09T00:00:00Z", "currency": "EUR", "currencyRate": 1, "lineItems": [ { "description": "Cheesecake", "unitAmount": 10, "quantity": 1, "discountAmount": 0, "subTotal": 10, "taxAmount": 2.1, "totalAmount": 12.1, "accountRef": { "id": "5f139759-b554-4314-862e-b9d88e5b2e1b", "name": "Af te dragen loonheffing" }, "taxRateRef": { "id": "84277189-ad16-456c-b501-ca31f0a483cc", "name": "BTW prive gebruik", "effectiveTaxRate": 21 }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 10, "taxAmount": 2.1, "totalAmount": 12.1, "amountDue": 0, "modifiedDate": "2022-10-26T13:32:18Z", "sourceModifiedDate": "2020-01-03T15:06:02Z", "paymentAllocations": [ { "payment": { "id": "d9a2980b-2a43-46f2-9c7f-413d925b3cdd", "reference": "20200032", "accountRef": { "id": "d79d65bd-1d7d-4f55-95d3-76b3a7b7b823", "name": "Bank 1" }, "currency": "EUR", "currencyRate": 1, "paidOnDate": "2021-03-22T00:00:00", "totalAmount": 12.1 }, "allocation": { "currency": "EUR", "currencyRate": 1, "totalAmount": -12.1 } } ] }, { "id": "ec0c61a1-deb6-4496-b9ee-feb29b16019c", "reference": "19600008", "supplierRef": { "id": "fc189bfa-f083-438c-bf09-379a0631d4a1", "supplierName": "Mickey Mouse" }, "purchaseOrderRefs": [], "issueDate": "2019-12-16T00:00:00Z", "dueDate": "2019-11-09T00:00:00Z", "currency": "EUR", "currencyRate": 1, "lineItems": [ { "description": "Cheesecake", "unitAmount": 10, "quantity": 1, "discountAmount": 0, "subTotal": 10, "taxAmount": 2.1, "totalAmount": 12.1, "accountRef": { "id": "5f139759-b554-4314-862e-b9d88e5b2e1b", "name": "Af te dragen loonheffing" }, "taxRateRef": { "id": "84277189-ad16-456c-b501-ca31f0a483cc", "name": "BTW prive gebruik", "effectiveTaxRate": 21 }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Open", "subTotal": 10, "taxAmount": 2.1, "totalAmount": 12.1, "amountDue": 12.1, "modifiedDate": "2022-10-26T13:32:18Z", "sourceModifiedDate": "2020-01-03T15:06:39Z", "paymentAllocations": [ { "payment": { "id": "ef5d140b-16da-4fd2-a0c8-d5bfb89a13ee", "reference": "19900056", "accountRef": { "id": "a2d51b6f-677d-4bbf-ad0c-b45fd6231546", "name": "Activa herwaarderingen" }, "currency": "EUR", "currencyRate": 1, "paidOnDate": "2019-11-07T00:00:00", "totalAmount": 0.21 }, "allocation": { "currency": "EUR", "currencyRate": 1, "totalAmount": -0.21 } }, { "payment": { "id": "b69e7ad4-2b90-4a5f-a8a0-67418ac95531", "reference": "19900053", "accountRef": { "id": "a2d51b6f-677d-4bbf-ad0c-b45fd6231546", "name": "Activa herwaarderingen" }, "currency": "EUR", "currencyRate": 1, "paidOnDate": "2019-11-07T00:00:00", "totalAmount": 0.2 }, "allocation": { "currency": "EUR", "currencyRate": 1, "totalAmount": -0.2 } }, { "payment": { "id": "6ccd1256-6073-4bfc-8d88-700417685e72", "reference": "21200028", "accountRef": { "id": "d79d65bd-1d7d-4f55-95d3-76b3a7b7b823", "name": "Bank 1" }, "currency": "EUR", "currencyRate": 1, "paidOnDate": "2021-10-05T00:00:00", "totalAmount": 12.1 }, "allocation": { "currency": "EUR", "currencyRate": 1, "totalAmount": -12.1 } }, { "payment": { "id": "69a8533b-3e59-4d2d-9bca-bc37bc0f7984", "reference": "19900055", "accountRef": { "id": "a2d51b6f-677d-4bbf-ad0c-b45fd6231546", "name": "Activa herwaarderingen" }, "currency": "EUR", "currencyRate": 1, "paidOnDate": "2019-11-07T00:00:00", "totalAmount": 0.21 }, "allocation": { "currency": "EUR", "currencyRate": 1, "totalAmount": -0.21 } }, { "payment": { "id": "2dae3548-ff11-4ad8-886c-eb5cb7965024", "reference": "19900054", "accountRef": { "id": "a2d51b6f-677d-4bbf-ad0c-b45fd6231546", "name": "Activa herwaarderingen" }, "currency": "EUR", "currencyRate": 1, "paidOnDate": "2019-11-07T00:00:00", "totalAmount": 0.21 }, "allocation": { "currency": "EUR", "currencyRate": 1, "totalAmount": -0.21 } } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 80, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "e7a45898-2db3-424c-acb9-a51647740f26", "reference": "17600002", "supplierRef": { "id": "a7cad20d-44db-442b-ac1f-90475802d6fb", "supplierName": "Pencils Pencils Pencils" }, "purchaseOrderRefs": [], "issueDate": "2017-09-26T00:00:00Z", "dueDate": "2017-10-26T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Stationery", "unitAmount": 400, "quantity": 2, "discountAmount": 0, "subTotal": 800, "taxAmount": 160, "totalAmount": 960, "accountRef": { "id": "e5e9e994-0f14-4614-b162-7b5593b21276", "name": "Finished Goods Stock" }, "taxRateRef": { "id": "63cd143a-66ab-4320-8a6d-ab6be85ed048", "name": "UK purchases standard rate � Excluding", "effectiveTaxRate": 20 }, "itemRef": { "id": "001" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 800, "taxAmount": 160, "totalAmount": 960, "amountDue": 0, "modifiedDate": "2022-10-26T13:33:20Z", "sourceModifiedDate": "2019-01-11T14:18:17Z", "paymentAllocations": [ { "payment": { "id": "7a5f621b-739f-4ed8-b738-2aae3ef886ac", "reference": "17200006", "accountRef": { "id": "4a4e34b5-7f62-4b64-a44a-073398b14b41", "name": "Bank" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2017-10-11T00:00:00", "totalAmount": 123 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -123 } } ] }, { "id": "064fbab9-9b4d-4e83-b2df-0f4ce12bc2bf", "reference": "19600001", "supplierRef": { "id": "a4d5d739-c979-4819-b0ce-666db1ec3a7d", "supplierName": "Exact Software (UK) Ltd � Exact Online" }, "purchaseOrderRefs": [], "issueDate": "2019-01-11T00:00:00Z", "dueDate": "2019-02-10T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Basket balls", "unitAmount": 20, "quantity": 1, "discountAmount": 0, "subTotal": 20, "taxAmount": 0, "totalAmount": 20, "accountRef": { "id": "885ff551-664d-451b-995b-cb114c9877d0", "name": "Unallocated Cash" }, "itemRef": { "id": "23" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 20, "taxAmount": 0, "totalAmount": 20, "amountDue": 0, "modifiedDate": "2022-10-26T13:33:20Z", "sourceModifiedDate": "2019-01-11T12:03:31Z", "paymentAllocations": [ { "payment": { "id": "d871f677-c2df-4069-bda0-c6804a46b71b", "reference": "19200001", "accountRef": { "id": "4a4e34b5-7f62-4b64-a44a-073398b14b41", "name": "Bank" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2019-02-10T00:00:00", "totalAmount": 20 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -20 } } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 83, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "16609552", "reference": "MATT - U", "supplierRef": { "id": "7169654", "supplierName": "The Eagle" }, "purchaseOrderRefs": [], "issueDate": "2014-08-21T00:00:00", "dueDate": "2018-09-20T00:00:00", "currency": "GBP", "lineItems": [ { "unitAmount": 125, "quantity": 1, "taxAmount": 25, "totalAmount": 150, "accountRef": { "id": "285", "name": "Accommodation and Meals" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Open", "subTotal": 125, "taxAmount": 25, "totalAmount": 150, "amountDue": 150, "modifiedDate": "2023-04-25T14:19:10Z", "sourceModifiedDate": "2020-11-11T12:48:55Z", "paymentAllocations": [], "metadata": { "isDeleted": false } }, { "id": "16609589", "reference": "MATT - U", "supplierRef": { "id": "7169654", "supplierName": "The Eagle" }, "purchaseOrderRefs": [], "issueDate": "2014-08-21T00:00:00", "dueDate": "2018-09-20T00:00:00", "currency": "GBP", "lineItems": [ { "unitAmount": 125, "quantity": 1, "taxAmount": 25, "totalAmount": 150, "accountRef": { "id": "285", "name": "Accommodation and Meals" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Open", "subTotal": 125, "taxAmount": 25, "totalAmount": 150, "amountDue": 150, "modifiedDate": "2023-04-25T14:19:10Z", "sourceModifiedDate": "2020-11-11T12:50:41Z", "paymentAllocations": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 137, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "27", "supplierRef": { "id": "87" }, "purchaseOrderRefs": [], "issueDate": "2021-04-26T00:00:00", "dueDate": "2021-05-26T00:00:00", "currency": "USD", "lineItems": [ { "description": "Grocery", "unitAmount": 50, "quantity": 1, "subTotal": 50, "taxAmount": 0, "totalAmount": 50, "accountRef": { "id": "3384197", "name": "Advertising" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Open", "subTotal": 50, "taxAmount": 0, "totalAmount": 50, "amountDue": 50, "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2021-04-26T19:34:22", "paymentAllocations": [], "metadata": { "isDeleted": false } }, { "id": "29", "supplierRef": { "id": "89" }, "purchaseOrderRefs": [], "issueDate": "2021-04-28T00:00:00", "dueDate": "2021-05-28T00:00:00", "currency": "GBP", "lineItems": [ { "description": "Advertising refund", "unitAmount": 10, "quantity": 1, "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "accountRef": { "id": "3384197", "name": "Advertising" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "amountDue": 0, "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2021-08-18T13:52:33", "paymentAllocations": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 16, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills?page=2&pageSize=2" } } } }, "KashFlow": { "value": { "results": [ { "id": "97615244", "reference": "25", "supplierRef": { "id": "9272052", "supplierName": "Supplier man" }, "purchaseOrderRefs": [], "issueDate": "2000-01-01T00:00:00", "dueDate": "2000-01-01T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "", "unitAmount": 8.33, "quantity": 1, "subTotal": 8.33, "taxAmount": 1.67, "totalAmount": 10, "accountRef": { "id": "21481884", "name": "Computer equipment cost" }, "itemRef": { "id": "122990246" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 8.33, "taxAmount": 1.67, "totalAmount": 10, "amountDue": 0, "modifiedDate": "2022-09-30T10:29:15Z", "paymentAllocations": [] }, { "id": "76144089", "reference": "1", "supplierRef": { "id": "6202387", "supplierName": "Dell" }, "purchaseOrderRefs": [], "issueDate": "2019-01-28T00:00:00", "dueDate": "2019-02-27T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "", "unitAmount": 120, "quantity": 5, "subTotal": 600, "taxAmount": 0, "totalAmount": 600, "accountRef": { "id": "21481820", "name": "Materials purchased" }, "itemRef": { "id": "95293985" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 600, "taxAmount": 0, "totalAmount": 600, "amountDue": 0, "modifiedDate": "2022-09-30T10:29:15Z", "paymentAllocations": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 19, "_links": { "current": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills" }, "next": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "7", "supplierRef": { "id": "724", "supplierName": "Vendor A.A.A" }, "purchaseOrderRefs": [], "issueDate": "2021-03-26T00:00:00", "dueDate": "2021-03-26T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "unitAmount": 120, "quantity": 1, "unitOfMeasurement": "litre", "subTotal": 120, "totalAmount": 120, "accountRef": { "id": "716", "name": "Inventory In Transit" }, "trackingCategoryRefs": [ { "id": "location-4", "name": "Europe" } ], "tracking": { "categoryRefs": [ { "id": "location-4", "name": "Europe" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false } ], "withholdingTax": [], "status": "PartiallyPaid", "subTotal": 120, "taxAmount": 24, "totalAmount": 144, "amountDue": 24, "modifiedDate": "2023-01-30T14:47:34Z", "sourceModifiedDate": "2022-07-05T13:38:10", "paymentAllocations": [ { "payment": { "id": "112", "reference": "Bill Payment #1", "accountRef": { "id": "825", "name": "Codat Europe Bank" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-03-26T00:00:00", "totalAmount": 120 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -120 } } ] }, { "id": "165372", "supplierRef": { "id": "724", "supplierName": "Vendor A.A.A" }, "purchaseOrderRefs": [], "issueDate": "2022-07-15T00:00:00", "dueDate": "2022-07-15T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "unitAmount": 555.78, "quantity": 1, "subTotal": 555.78, "totalAmount": 555.78, "accountRef": { "id": "844", "name": "Asset account test 2" }, "trackingCategoryRefs": [ { "id": "location-4", "name": "Europe" } ], "tracking": { "categoryRefs": [ { "id": "location-4", "name": "Europe" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false } ], "withholdingTax": [], "status": "PartiallyPaid", "subTotal": 555.78, "taxAmount": 0, "totalAmount": 555.78, "amountDue": 500, "modifiedDate": "2023-01-30T14:47:34Z", "sourceModifiedDate": "2022-07-15T11:35:47", "paymentAllocations": [ { "payment": { "id": "165373", "reference": "Bill Payment #2", "accountRef": { "id": "825", "name": "Codat Europe Bank" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-07-15T00:00:00", "totalAmount": 555.78 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -55.78 } } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 3, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills" }, "next": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "3691-1071520776", "reference": "3847498", "supplierRef": { "id": "B0000-933272656", "supplierName": "Patton Hardware Supplies" }, "purchaseOrderRefs": [ { "id": "3684-1071520443", "purchaseOrderNumber": "6225" } ], "issueDate": "2022-12-02T00:00:00", "dueDate": "2024-01-01T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Cabinets:Light Pine - Light pine kitchen cabinet wall unit \n#CLD- 1235-p", "unitAmount": 1500, "quantity": 5, "discountAmount": 0, "subTotal": 7500, "taxAmount": 0, "totalAmount": 7500, "discountPercentage": 0, "accountRef": { "id": "C0000-933270541", "name": "Accounts Payable" }, "itemRef": { "id": "110000-933272656", "name": "Cabinets:Light Pine" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "tracking": { "categoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false }, { "description": "Hardware:Doorknobs Std - Doorknobs Part # DK 3704", "unitAmount": 27, "quantity": 100, "discountAmount": 0, "subTotal": 2700, "taxAmount": 0, "totalAmount": 2700, "discountPercentage": 0, "accountRef": { "id": "C0000-933270541", "name": "Accounts Payable" }, "itemRef": { "id": "130000-933272656", "name": "Hardware:Doorknobs Std" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "tracking": { "categoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false }, { "description": "Hardware:Lk Doorknobs - Locking interior doorknobs Part # DK415", "unitAmount": 34.95, "quantity": 100, "discountAmount": 0, "subTotal": 3495, "taxAmount": 0, "totalAmount": 3495, "discountPercentage": 0, "accountRef": { "id": "C0000-933270541", "name": "Accounts Payable" }, "itemRef": { "id": "140000-933272656", "name": "Hardware:Lk Doorknobs" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "tracking": { "categoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 13695, "taxAmount": 0, "totalAmount": 13695, "amountDue": 0, "modifiedDate": "2023-04-26T09:06:42Z", "sourceModifiedDate": "2023-12-16T05:06:30", "paymentAllocations": [ { "payment": { "id": "9E4C-1182131999", "reference": "115", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-01-31T00:00:00", "totalAmount": 13759 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -8695 } }, { "payment": { "id": "36AD-1071520917", "note": "RC 93", "reference": "484", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2024-12-05T00:00:00", "totalAmount": 5325 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5000 } } ], "metadata": { "isDeleted": false } }, { "id": "5CAB-1197713763", "reference": "8374892", "supplierRef": { "id": "30000-933272656", "supplierName": "C. U. Electric" }, "purchaseOrderRefs": [], "issueDate": "2022-12-15T00:00:00", "dueDate": "2024-01-14T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "unitAmount": 532, "quantity": 1, "discountAmount": 0, "subTotal": 532, "taxAmount": 0, "totalAmount": 532, "discountPercentage": 0, "accountRef": { "id": "490000-933270542", "name": "Gas and Electric" }, "trackingCategoryRefs": [ { "id": "80000007-1197713802", "name": "Overhead" } ], "tracking": { "categoryRefs": [ { "id": "80000007-1197713802", "name": "Overhead" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 532, "taxAmount": 0, "totalAmount": 532, "amountDue": 0, "modifiedDate": "2023-04-26T09:06:42Z", "sourceModifiedDate": "2023-12-16T05:06:30", "paymentAllocations": [ { "payment": { "id": "9E42-1182131999", "reference": "113", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-01-31T00:00:00", "totalAmount": 532 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -532 } } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 239, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "18", "reference": "12", "supplierRef": { "id": "4", "supplierName": "BILLy elliot" }, "purchaseOrderRefs": [], "issueDate": "2019-05-13T00:00:00", "dueDate": "2019-05-13T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "unitAmount": 5, "quantity": 1, "discountAmount": 0, "subTotal": 5, "taxAmount": 0, "totalAmount": 5, "accountRef": { "id": "16", "name": "Advertising" }, "taxRateRef": { "id": "NON", "name": "NON", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 5, "taxAmount": 0, "totalAmount": 5, "amountDue": 0, "modifiedDate": "2023-01-18T11:02:41Z", "sourceModifiedDate": "2022-05-26T10:34:10Z", "paymentAllocations": [ { "payment": { "id": "20", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2019-05-13T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } } ] }, { "id": "22", "reference": "12", "supplierRef": { "id": "4", "supplierName": "BILLy elliot" }, "purchaseOrderRefs": [], "issueDate": "2019-05-13T00:00:00", "dueDate": "2019-05-13T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "unitAmount": 5, "quantity": 1, "discountAmount": 0, "subTotal": 5, "taxAmount": 0, "totalAmount": 5, "accountRef": { "id": "16", "name": "Advertising" }, "taxRateRef": { "id": "NON", "name": "NON", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 5, "taxAmount": 0, "totalAmount": 5, "amountDue": 0, "modifiedDate": "2023-01-18T11:02:41Z", "sourceModifiedDate": "2020-03-23T10:44:06Z", "paymentAllocations": [ { "payment": { "id": "678", "note": "payment note test", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-03-23T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 147, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "157", "supplierRef": { "id": "57", "supplierName": "Hall's Promo Items" }, "purchaseOrderRefs": [], "issueDate": "2016-01-06T00:00:00", "dueDate": "2016-01-16T00:00:00", "currency": "HKD", "currencyRate": 0.081142, "lineItems": [ { "description": "Water bottles -- generic", "unitAmount": 66.1717023, "quantity": 100, "discountAmount": 0, "subTotal": 6617.17, "taxAmount": 1323.43, "totalAmount": 7940.6, "taxRateRef": { "id": "3_Bills", "name": "20.0% S Bills", "effectiveTaxRate": 20 }, "itemRef": { "id": "19", "name": "Water Bottles" }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "customerRef": { "id": "55", "companyName": "Oxon Insurance - Holiday Party" }, "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 6617.17, "taxAmount": 1323.43, "totalAmount": 7940.6, "amountDue": 0, "modifiedDate": "2023-04-26T09:35:58Z", "sourceModifiedDate": "2023-01-26T11:20:45Z", "paymentAllocations": [ { "payment": { "id": "158", "reference": "1067", "accountRef": { "id": "81", "name": "Current" }, "currency": "HKD", "currencyRate": 0.078807, "paidOnDate": "2016-01-23T00:00:00", "totalAmount": 7940.6 }, "allocation": { "currency": "HKD", "currencyRate": 1, "totalAmount": -7940.6 } } ], "metadata": { "isDeleted": false } }, { "id": "28", "supplierRef": { "id": "57", "supplierName": "Hall's Promo Items" }, "purchaseOrderRefs": [], "issueDate": "2016-01-06T00:00:00", "dueDate": "2016-01-06T00:00:00", "currency": "HKD", "currencyRate": 0.081142, "lineItems": [ { "description": "promotional items -- misc engraved items", "unitAmount": 8.25, "quantity": 75, "discountAmount": 0, "subTotal": 618.75, "taxAmount": 123.75, "totalAmount": 742.5, "taxRateRef": { "id": "3_Bills", "name": "20.0% S Bills", "effectiveTaxRate": 20 }, "itemRef": { "id": "12", "name": "Misc" }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "customerRef": { "id": "59", "companyName": "Ecker Holiday event" }, "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 618.75, "taxAmount": 123.75, "totalAmount": 742.5, "amountDue": 0, "modifiedDate": "2023-04-26T09:35:58Z", "sourceModifiedDate": "2016-09-13T21:19:49Z", "paymentAllocations": [ { "payment": { "id": "159", "reference": "1068", "accountRef": { "id": "81", "name": "Current" }, "currency": "HKD", "currencyRate": 0.078807, "paidOnDate": "2016-01-23T00:00:00", "totalAmount": 742.5 }, "allocation": { "currency": "HKD", "currencyRate": 1, "totalAmount": -742.5 } } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 711, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "45121", "reference": "Order no 1", "supplierRef": { "id": "CON001", "supplierName": "Concept Stationery Supplies" }, "purchaseOrderRefs": [], "issueDate": "2020-07-22T00:00:00Z", "dueDate": "2020-02-15T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Tax Summary - Tax Rate 1", "unitAmount": 0, "quantity": 0, "discountAmount": 0.5, "subTotal": 0, "taxAmount": 20, "totalAmount": 20, "taxRateRef": { "id": "1729", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Goods Summary", "unitAmount": 0, "quantity": 0, "discountAmount": 2.5, "subTotal": 100, "taxAmount": 0, "totalAmount": 100, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Open", "subTotal": 100, "taxAmount": 20, "totalAmount": 120, "amountDue": 120, "modifiedDate": "2022-10-14T09:36:01Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "note": "No1", "paymentAllocations": [] }, { "id": "45131", "reference": "Order 2", "supplierRef": { "id": "CON001", "supplierName": "Concept Stationery Supplies" }, "purchaseOrderRefs": [], "issueDate": "2020-07-22T00:00:00Z", "dueDate": "2020-03-01T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Tax Summary - Tax Rate 1", "unitAmount": 0, "quantity": 0, "discountAmount": 0, "subTotal": 0, "taxAmount": 31.6, "totalAmount": 31.6, "taxRateRef": { "id": "1729", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Goods Summary", "unitAmount": 0, "quantity": 0, "discountAmount": 0, "subTotal": 158, "taxAmount": 0, "totalAmount": 158, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "PartiallyPaid", "subTotal": 158, "taxAmount": 31.6, "totalAmount": 189.6, "amountDue": 179.1, "modifiedDate": "2022-10-14T09:36:01Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "note": "No2", "paymentAllocations": [ { "payment": { "id": "45391", "note": "ret1", "reference": "Return 1", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-20T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 10.5 } } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 162, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "92", "reference": "2569", "supplierRef": { "id": "THO001", "supplierName": "Thompsons Electricals" }, "purchaseOrderRefs": [], "issueDate": "2021-01-01T00:00:00", "dueDate": "2022-01-31T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Goods", "unitAmount": 5875, "quantity": 1, "subTotal": 5000, "taxAmount": 875, "totalAmount": 5875, "accountRef": { "id": "5000", "name": "Materials Purchased" }, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_7", "name": "Workshop" } ], "tracking": { "categoryRefs": [ { "id": "department_7", "name": "Workshop" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 5000, "taxAmount": 875, "totalAmount": 5875, "amountDue": 0, "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54", "note": "Goods", "paymentAllocations": [ { "payment": { "id": "260", "note": "Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 7141.98 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5875 } } ], "metadata": { "isDeleted": false } }, { "id": "93", "reference": "2570", "supplierRef": { "id": "THO001", "supplierName": "Thompsons Electricals" }, "purchaseOrderRefs": [], "issueDate": "2021-01-15T00:00:00", "dueDate": "2022-02-14T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Goods", "unitAmount": 1175, "quantity": 1, "subTotal": 1000, "taxAmount": 175, "totalAmount": 1175, "accountRef": { "id": "5000", "name": "Materials Purchased" }, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_7", "name": "Workshop" } ], "tracking": { "categoryRefs": [ { "id": "department_7", "name": "Workshop" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 1000, "taxAmount": 175, "totalAmount": 1175, "amountDue": 0, "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54", "note": "Goods", "paymentAllocations": [ { "payment": { "id": "260", "note": "Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 7141.98 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -1175 } } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 95, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "15a7a15773b011e8aaa5027d54329956", "reference": "19/06/2018 - 435.60", "supplierRef": { "id": "ca430e0d156011e8b45c025132dab352", "supplierName": "Test Supplier" }, "purchaseOrderRefs": [], "issueDate": "2018-06-19T00:00:00", "dueDate": "2018-07-19T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Consulting services", "unitAmount": 11, "quantity": 33, "subTotal": 363, "taxAmount": 72.6, "totalAmount": 435.6, "accountRef": { "id": "9a995955267a11e797950a57719b2edb", "name": "Cost of sales - goods" }, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 }, "itemRef": { "id": "a87b922b33de11e797950a57719b2edb", "name": "Consulting services" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "PartiallyPaid", "subTotal": 363, "taxAmount": 72.6, "totalAmount": 435.6, "amountDue": 405.6, "modifiedDate": "2022-10-24T14:56:08Z", "sourceModifiedDate": "2020-02-05T15:19:28Z", "paymentAllocations": [ { "payment": { "id": "f11134e299cb4456be096265136a7770", "note": "Supplier payment using credit/debit card - string", "accountRef": { "id": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } }, { "payment": { "id": "e3e35dcda09642ca8880fc603b0a98e9", "note": "Supplier payment using credit/debit card - string", "accountRef": { "id": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } }, { "payment": { "id": "d9b643b9d6e149f4b443cbc6f22fe1dd", "note": "Supplier payment using credit/debit card - string", "accountRef": { "id": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } }, { "payment": { "id": "cbff2fed2f1641b7bee59f5dd68d29a1", "note": "Supplier payment using credit/debit card - string", "accountRef": { "id": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } }, { "payment": { "id": "3c3ed62353cf4d148352a14027738dbe", "note": "Supplier payment using credit/debit card - string", "accountRef": { "id": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } }, { "payment": { "id": "332e402b9d4b4614af82594d186f5f29", "note": "Supplier payment using credit/debit card - string", "accountRef": { "id": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } } ] }, { "id": "09034445789211e8aaa5027d54329956", "reference": "25/06/2018 - 1,000.00", "supplierRef": { "id": "ec716559789111e8aaa5027d54329956", "supplierName": "Bagels Limited" }, "purchaseOrderRefs": [], "issueDate": "2018-06-25T00:00:00", "dueDate": "2018-07-25T00:00:00", "currency": "USD", "currencyRate": 0.752601305, "lineItems": [ { "description": "Bagels", "unitAmount": 1000, "quantity": 1, "subTotal": 1000, "taxAmount": 0, "totalAmount": 1000, "accountRef": { "id": "9a995955267a11e797950a57719b2edb", "name": "Cost of sales - goods" }, "taxRateRef": { "id": "GB_ZERO", "name": "Zero Rated 0.00%", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 1000, "taxAmount": 0, "totalAmount": 1000, "amountDue": 0, "modifiedDate": "2022-10-24T14:56:08Z", "sourceModifiedDate": "2022-02-22T13:48:56Z", "paymentAllocations": [ { "payment": { "id": "66d010243e3441ba89a793446eb9c74b", "note": "Supplier payment using credit/debit card - Test note", "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "currency": "USD", "currencyRate": 0.734679838, "paidOnDate": "2022-02-16T00:00:00", "totalAmount": 1000 }, "allocation": { "currency": "USD", "currencyRate": 1, "totalAmount": -1000 } } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 4658, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/bills" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/bills?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "4470", "reference": "test", "supplierRef": { "id": "3", "supplierName": "ADP" }, "purchaseOrderRefs": [], "issueDate": "2021-10-19T00:00:00", "dueDate": "2021-10-29T00:00:00", "currency": "GBP", "lineItems": [ { "unitAmount": 25, "quantity": 1, "subTotal": 25, "taxAmount": 0, "totalAmount": 25, "accountRef": { "id": "3", "name": "Accounts Payable" }, "taxRateRef": { "id": "82", "name": "UK Purchase Goods Zero Rate", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [ { "id": "DEPARTMENT-3", "name": "Admin" }, { "id": "LOCATION-11", "name": "Codat Test Entity" } ], "tracking": { "categoryRefs": [ { "id": "DEPARTMENT-3", "name": "Admin" }, { "id": "LOCATION-11", "name": "Codat Test Entity" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 25, "taxAmount": 0, "totalAmount": 25, "amountDue": 0, "modifiedDate": "2023-04-04T16:31:37Z", "sourceModifiedDate": "2022-02-23T12:06:58", "note": "", "paymentAllocations": [ { "payment": { "id": "4471", "note": "", "accountRef": { "id": "353", "name": "Current Account" }, "currency": "GBP", "paidOnDate": "2022-01-06T00:00:00", "totalAmount": 20 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -20 } }, { "payment": { "id": "4472", "note": "", "accountRef": { "id": "353", "name": "Current Account" }, "currency": "GBP", "paidOnDate": "2022-01-06T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } } ], "metadata": { "isDeleted": false } }, { "id": "4705", "reference": "JohnAndRob", "supplierRef": { "id": "8", "supplierName": "Worldwide Commercial" }, "purchaseOrderRefs": [], "issueDate": "2022-02-04T00:00:00", "dueDate": "2022-02-19T00:00:00", "currency": "USD", "currencyRate": 14, "lineItems": [ { "description": "Some text for a description", "unitAmount": 10, "quantity": 1, "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "accountRef": { "id": "3", "name": "Accounts Payable" }, "taxRateRef": { "id": "49", "name": "EC Purchase Goods Zero Rate", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [ { "id": "DEPARTMENT-3", "name": "Admin" }, { "id": "LOCATION-11", "name": "Codat Test Entity" } ], "tracking": { "categoryRefs": [ { "id": "DEPARTMENT-3", "name": "Admin" }, { "id": "LOCATION-11", "name": "Codat Test Entity" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Open", "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "amountDue": 10, "modifiedDate": "2023-04-04T16:31:37Z", "sourceModifiedDate": "2022-04-22T12:24:59", "note": "Some note on my bill", "paymentAllocations": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 17, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills" }, "next": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "3945273c-cc04-479f-a4b5-1e3dc7a55ed1", "reference": "", "supplierRef": { "id": "1262c350-fe0f-40ec-aeff-41c95b4a45af", "supplierName": "DIISR - Small Business Services" }, "purchaseOrderRefs": [], "issueDate": "2021-11-19T00:00:00", "dueDate": "2021-12-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Half day training - Microsoft Office", "unitAmount": 1800, "quantity": 1, "discountAmount": 0, "subTotal": 1800, "taxAmount": 360, "totalAmount": 2160, "discountPercentage": 0, "accountRef": { "id": "46f9461e-788b-4906-8b74-d1ea17f6dc10", "name": "Consulting" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "itemRef": { "id": "489558f5-27b7-4f37-ad9f-d84611c2e2ab", "name": "Half day training - Microsoft Office" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month.", "unitAmount": 4000, "quantity": 1, "discountAmount": 0, "subTotal": 4000, "taxAmount": 800, "totalAmount": 4800, "discountPercentage": 0, "accountRef": { "id": "f96c9458-d724-47bf-8f74-a9d5726465ce", "name": "General Expenses" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "itemRef": { "id": "f8fb7e00-5e5d-466c-aef0-15861f73d04f", "name": "Desktop/network support via email & phone" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Stationery charges", "unitAmount": 32, "quantity": 8, "discountAmount": 0, "subTotal": 256, "taxAmount": 51.2, "totalAmount": 307.2, "discountPercentage": 0, "accountRef": { "id": "cba6527d-f102-4538-b421-e483233e9d5a", "name": "Printing & Stationery" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 6056, "taxAmount": 1211.2, "totalAmount": 7267.2, "amountDue": 0, "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2021-01-02T21:07:23", "paymentAllocations": [ { "payment": { "id": "74004690-82a1-4810-aaca-6ce575af94b4", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-12-20T00:00:00", "totalAmount": 7267.2 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7267.2 } } ], "metadata": { "isDeleted": false } }, { "id": "09aa506f-cb81-4cd3-a1ea-6a0b91804d5a", "reference": "", "supplierRef": { "id": "1262c350-fe0f-40ec-aeff-41c95b4a45af", "supplierName": "DIISR - Small Business Services" }, "purchaseOrderRefs": [], "issueDate": "2022-01-17T00:00:00", "dueDate": "2022-02-17T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Half day training - Microsoft Office", "unitAmount": 1800, "quantity": 1, "discountAmount": 0, "subTotal": 1800, "taxAmount": 360, "totalAmount": 2160, "discountPercentage": 0, "accountRef": { "id": "46f9461e-788b-4906-8b74-d1ea17f6dc10", "name": "Consulting" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "itemRef": { "id": "489558f5-27b7-4f37-ad9f-d84611c2e2ab", "name": "Half day training - Microsoft Office" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month.", "unitAmount": 4000, "quantity": 1, "discountAmount": 0, "subTotal": 4000, "taxAmount": 800, "totalAmount": 4800, "discountPercentage": 0, "accountRef": { "id": "f96c9458-d724-47bf-8f74-a9d5726465ce", "name": "General Expenses" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "itemRef": { "id": "f8fb7e00-5e5d-466c-aef0-15861f73d04f", "name": "Desktop/network support via email & phone" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Stationery charges", "unitAmount": 32, "quantity": 8, "discountAmount": 0, "subTotal": 256, "taxAmount": 51.2, "totalAmount": 307.2, "discountPercentage": 0, "accountRef": { "id": "cba6527d-f102-4538-b421-e483233e9d5a", "name": "Printing & Stationery" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 6056, "taxAmount": 1211.2, "totalAmount": 7267.2, "amountDue": 0, "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2021-01-02T21:06:22", "paymentAllocations": [ { "payment": { "id": "f2062172-b444-4c8b-b797-9f4c7a4244c7", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-17T00:00:00", "totalAmount": 7267.2 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7267.2 } } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 44, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/bills" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/bills?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000152027", "reference": "1", "supplierRef": { "id": "104957000000152001", "supplierName": "Mr. P N" }, "purchaseOrderRefs": [], "issueDate": "2020-06-23T00:00:00", "dueDate": "2020-06-23T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [], "withholdingTax": [], "status": "Paid", "subTotal": 0, "taxAmount": 0, "totalAmount": 10, "amountDue": 0, "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2020-06-23T13:47:17", "paymentAllocations": [] }, { "id": "104957000000152067", "reference": "2", "supplierRef": { "id": "104957000000152001", "supplierName": "Mr. P N" }, "purchaseOrderRefs": [], "issueDate": "2020-06-23T00:00:00", "dueDate": "2020-06-23T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [], "withholdingTax": [], "status": "Paid", "subTotal": 0, "taxAmount": 0, "totalAmount": 12, "amountDue": 0, "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2020-11-04T13:07:23", "paymentAllocations": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 36, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List bills* endpoint returns a list of [bills](https://docs.codat.io/accounting-api#/schemas/Bill) for a given company's connection.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n\n### Tips and traps\n\nTo access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache.\n", "operationId": "list-bills" } }, "/companies/{companyId}/data/bills/{billId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/billId" } ], "get": { "tags": [ "Bills" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bill" }, "examples": { "Clear Books": { "value": { "id": "81539597-e681-40c9-a4dd-ec2fffcde572", "reference": "b465a2c9-3212-4620-889b-6328ba148215", "supplierRef": { "id": "8GeHBdBZiZ", "supplierName": "DuBuque, Goyette and Franecki" }, "purchaseOrderRefs": [], "issueDate": "2022-04-29T00:00:00", "dueDate": "2022-05-06T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Grease Trap", "unitAmount": 2781.94, "quantity": 5, "discountAmount": 0, "subTotal": 13909.7, "taxAmount": 1390.97, "totalAmount": 15300.67, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 1371.39, "quantity": 5, "discountAmount": 0, "subTotal": 6856.95, "taxAmount": 685.7, "totalAmount": 7542.65, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 1371.39, "quantity": 6, "discountAmount": 0, "subTotal": 8228.34, "taxAmount": 822.83, "totalAmount": 9051.17, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 2781.94, "quantity": 3, "discountAmount": 0, "subTotal": 8345.82, "taxAmount": 834.58, "totalAmount": 9180.4, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Underground - Trapped Road Gully 450mm x 450mm", "unitAmount": 402.89, "quantity": 8, "discountAmount": 0, "subTotal": 3223.12, "taxAmount": 322.31, "totalAmount": 3545.43, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "3abf0883-03f7-44c6-bc15-1372522d25e1", "name": "Heavy Duty Hinged Gully Grating" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Underground - Drain Bottle Gullies 90 degree Rectangular", "unitAmount": 95.08, "quantity": 7, "discountAmount": 0, "subTotal": 665.56, "taxAmount": 66.56, "totalAmount": 732.12, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "6", "name": "Back Inlet Roddable Gully 90� Outlet Rectangular Grid" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Underground - Drain Bottle Gullies 90 degree Rectangular", "unitAmount": 95.08, "quantity": 1, "discountAmount": 0, "subTotal": 95.08, "taxAmount": 9.51, "totalAmount": 104.59, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "6", "name": "Back Inlet Roddable Gully 90� Outlet Rectangular Grid" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 1371.39, "quantity": 2, "discountAmount": 0, "subTotal": 2742.78, "taxAmount": 274.28, "totalAmount": 3017.06, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 2781.94, "quantity": 1, "discountAmount": 0, "subTotal": 2781.94, "taxAmount": 278.19, "totalAmount": 3060.13, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Underground - Drain Bottle Gullies 90 degree Rectangular", "unitAmount": 95.08, "quantity": 7, "discountAmount": 0, "subTotal": 665.56, "taxAmount": 66.56, "totalAmount": 732.12, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "6", "name": "Back Inlet Roddable Gully 90� Outlet Rectangular Grid" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 1251.89, "quantity": 4, "discountAmount": 0, "subTotal": 5007.56, "taxAmount": 500.76, "totalAmount": 5508.32, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "51077072-d5c3-463b-9cb4-7da2e11886f9", "name": "150 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Grease Trap", "unitAmount": 1371.39, "quantity": 9, "discountAmount": 0, "subTotal": 12342.51, "taxAmount": 1234.25, "totalAmount": 13576.76, "discountPercentage": 0, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 64864.92, "taxAmount": 6486.5, "totalAmount": 71351.42, "amountDue": 0, "modifiedDate": "2023-04-26T12:38:16Z", "sourceModifiedDate": "2023-02-14T17:09:02", "note": "Bill with 12 line items, totaling 71351.42", "paymentAllocations": [ { "payment": { "id": "dcb18480-8b69-44d8-aa26-268b6a80d170", "note": "Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572", "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-05-06T00:00:00", "totalAmount": 71351.42 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-05-06T00:00:00", "totalAmount": -71351.42 } } ], "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "4019ee2b-d05a-ed11-8c34-000d3a0d28a2-108276", "reference": "108276", "supplierRef": { "id": "c01217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "First Up Consultants" }, "purchaseOrderRefs": [], "issueDate": "2019-01-01T00:00:00", "dueDate": "2019-01-01T00:00:00", "currency": "GBP", "lineItems": [ { "description": "ATHENS Desk", "unitAmount": 506.6, "quantity": 4, "discountAmount": 202.64, "subTotal": 1823.76, "taxAmount": 364.75, "totalAmount": 2188.51, "discountPercentage": 10, "accountRef": { "id": "6a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Inventory" }, "taxRateRef": { "id": "63bc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for DOMESTIC / STANDARD", "effectiveTaxRate": 10 }, "itemRef": { "id": "ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC", "name": "ATHENS Desk / General Business Posting Group: 'DOMESTIC' / VAT Business Posting Group: 'DOMESTIC'" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Open", "subTotal": 1823.76, "taxAmount": 364.75, "totalAmount": 2188.51, "amountDue": 2188.51, "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2022-11-02T17:02:48Z", "note": "129148", "paymentAllocations": [], "metadata": { "isDeleted": false } } }, "Exact (Netherlands)": { "value": { "id": "1c55118b-793e-4437-9c13-4f554b9ca989", "reference": "19600006", "supplierRef": { "id": "5e6f49b9-6489-4b82-83e7-291d308919bb", "supplierName": "Mickey Mouse" }, "purchaseOrderRefs": [], "issueDate": "2019-12-16T00:00:00Z", "dueDate": "2019-11-09T00:00:00Z", "currency": "EUR", "currencyRate": 1, "lineItems": [ { "description": "Cheesecake", "unitAmount": 10, "quantity": 1, "discountAmount": 0, "subTotal": 10, "taxAmount": 2.1, "totalAmount": 12.1, "accountRef": { "id": "5f139759-b554-4314-862e-b9d88e5b2e1b", "name": "Af te dragen loonheffing" }, "taxRateRef": { "id": "84277189-ad16-456c-b501-ca31f0a483cc", "name": "BTW prive gebruik", "effectiveTaxRate": 21 }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 10, "taxAmount": 2.1, "totalAmount": 12.1, "amountDue": 0, "modifiedDate": "2022-10-26T13:32:18Z", "sourceModifiedDate": "2020-01-03T15:06:02Z", "paymentAllocations": [ { "payment": { "id": "d9a2980b-2a43-46f2-9c7f-413d925b3cdd", "reference": "20200032", "accountRef": { "id": "d79d65bd-1d7d-4f55-95d3-76b3a7b7b823", "name": "Bank 1" }, "currency": "EUR", "currencyRate": 1, "paidOnDate": "2021-03-22T00:00:00", "totalAmount": 12.1 }, "allocation": { "currency": "EUR", "currencyRate": 1, "totalAmount": -12.1 } } ] } }, "Exact (UK)": { "value": { "id": "e7a45898-2db3-424c-acb9-a51647740f26", "reference": "17600002", "supplierRef": { "id": "a7cad20d-44db-442b-ac1f-90475802d6fb", "supplierName": "Pencils Pencils Pencils" }, "purchaseOrderRefs": [], "issueDate": "2017-09-26T00:00:00Z", "dueDate": "2017-10-26T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Stationery", "unitAmount": 400, "quantity": 2, "discountAmount": 0, "subTotal": 800, "taxAmount": 160, "totalAmount": 960, "accountRef": { "id": "e5e9e994-0f14-4614-b162-7b5593b21276", "name": "Finished Goods Stock" }, "taxRateRef": { "id": "63cd143a-66ab-4320-8a6d-ab6be85ed048", "name": "UK purchases standard rate � Excluding", "effectiveTaxRate": 20 }, "itemRef": { "id": "001" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 800, "taxAmount": 160, "totalAmount": 960, "amountDue": 0, "modifiedDate": "2022-10-26T13:33:20Z", "sourceModifiedDate": "2019-01-11T14:18:17Z", "paymentAllocations": [ { "payment": { "id": "7a5f621b-739f-4ed8-b738-2aae3ef886ac", "reference": "17200006", "accountRef": { "id": "4a4e34b5-7f62-4b64-a44a-073398b14b41", "name": "Bank" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2017-10-11T00:00:00", "totalAmount": 123 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -123 } } ] } }, "FreeAgent": { "value": { "id": "16609552", "reference": "MATT - U", "supplierRef": { "id": "7169654", "supplierName": "The Eagle" }, "purchaseOrderRefs": [], "issueDate": "2014-08-21T00:00:00", "dueDate": "2018-09-20T00:00:00", "currency": "GBP", "lineItems": [ { "unitAmount": 125, "quantity": 1, "taxAmount": 25, "totalAmount": 150, "accountRef": { "id": "285", "name": "Accommodation and Meals" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Open", "subTotal": 125, "taxAmount": 25, "totalAmount": 150, "amountDue": 150, "modifiedDate": "2023-04-25T14:19:10Z", "sourceModifiedDate": "2020-11-11T12:48:55Z", "paymentAllocations": [], "metadata": { "isDeleted": false } } }, "FreshBooks": { "value": { "id": "27", "supplierRef": { "id": "87" }, "purchaseOrderRefs": [], "issueDate": "2021-04-26T00:00:00", "dueDate": "2021-05-26T00:00:00", "currency": "USD", "lineItems": [ { "description": "Grocery", "unitAmount": 50, "quantity": 1, "subTotal": 50, "taxAmount": 0, "totalAmount": 50, "accountRef": { "id": "3384197", "name": "Advertising" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Open", "subTotal": 50, "taxAmount": 0, "totalAmount": 50, "amountDue": 50, "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2021-04-26T19:34:22", "paymentAllocations": [], "metadata": { "isDeleted": false } } }, "KashFlow": { "value": { "id": "97615244", "reference": "25", "supplierRef": { "id": "9272052", "supplierName": "Supplier man" }, "purchaseOrderRefs": [], "issueDate": "2000-01-01T00:00:00", "dueDate": "2000-01-01T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "", "unitAmount": 8.33, "quantity": 1, "subTotal": 8.33, "taxAmount": 1.67, "totalAmount": 10, "accountRef": { "id": "21481884", "name": "Computer equipment cost" }, "itemRef": { "id": "122990246" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 8.33, "taxAmount": 1.67, "totalAmount": 10, "amountDue": 0, "modifiedDate": "2022-09-30T10:29:15Z", "paymentAllocations": [] } }, "Oracle NetSuite": { "value": { "id": "7", "supplierRef": { "id": "724", "supplierName": "Vendor A.A.A" }, "purchaseOrderRefs": [], "issueDate": "2021-03-26T00:00:00", "dueDate": "2021-03-26T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "unitAmount": 120, "quantity": 1, "unitOfMeasurement": "litre", "subTotal": 120, "totalAmount": 120, "accountRef": { "id": "716", "name": "Inventory In Transit" }, "trackingCategoryRefs": [ { "id": "location-4", "name": "Europe" } ], "tracking": { "categoryRefs": [ { "id": "location-4", "name": "Europe" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false } ], "withholdingTax": [], "status": "PartiallyPaid", "subTotal": 120, "taxAmount": 24, "totalAmount": 144, "amountDue": 24, "modifiedDate": "2023-01-30T14:47:34Z", "sourceModifiedDate": "2022-07-05T13:38:10", "paymentAllocations": [ { "payment": { "id": "112", "reference": "Bill Payment #1", "accountRef": { "id": "825", "name": "Codat Europe Bank" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-03-26T00:00:00", "totalAmount": 120 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -120 } } ] } }, "QuickBooks Desktop": { "value": { "id": "3691-1071520776", "reference": "3847498", "supplierRef": { "id": "B0000-933272656", "supplierName": "Patton Hardware Supplies" }, "purchaseOrderRefs": [ { "id": "3684-1071520443", "purchaseOrderNumber": "6225" } ], "issueDate": "2022-12-02T00:00:00", "dueDate": "2024-01-01T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Cabinets:Light Pine - Light pine kitchen cabinet wall unit \n#CLD- 1235-p", "unitAmount": 1500, "quantity": 5, "discountAmount": 0, "subTotal": 7500, "taxAmount": 0, "totalAmount": 7500, "discountPercentage": 0, "accountRef": { "id": "C0000-933270541", "name": "Accounts Payable" }, "itemRef": { "id": "110000-933272656", "name": "Cabinets:Light Pine" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "tracking": { "categoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false }, { "description": "Hardware:Doorknobs Std - Doorknobs Part # DK 3704", "unitAmount": 27, "quantity": 100, "discountAmount": 0, "subTotal": 2700, "taxAmount": 0, "totalAmount": 2700, "discountPercentage": 0, "accountRef": { "id": "C0000-933270541", "name": "Accounts Payable" }, "itemRef": { "id": "130000-933272656", "name": "Hardware:Doorknobs Std" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "tracking": { "categoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false }, { "description": "Hardware:Lk Doorknobs - Locking interior doorknobs Part # DK415", "unitAmount": 34.95, "quantity": 100, "discountAmount": 0, "subTotal": 3495, "taxAmount": 0, "totalAmount": 3495, "discountPercentage": 0, "accountRef": { "id": "C0000-933270541", "name": "Accounts Payable" }, "itemRef": { "id": "140000-933272656", "name": "Hardware:Lk Doorknobs" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "tracking": { "categoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 13695, "taxAmount": 0, "totalAmount": 13695, "amountDue": 0, "modifiedDate": "2023-04-26T09:06:42Z", "sourceModifiedDate": "2023-12-16T05:06:30", "paymentAllocations": [ { "payment": { "id": "36AD-1071520917", "note": "RC 93", "reference": "484", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2024-12-05T00:00:00", "totalAmount": 5325 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5000 } }, { "payment": { "id": "9E4C-1182131999", "reference": "115", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-01-31T00:00:00", "totalAmount": 13759 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -8695 } } ], "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "18", "reference": "12", "supplierRef": { "id": "4", "supplierName": "BILLy elliot" }, "purchaseOrderRefs": [], "issueDate": "2019-05-13T00:00:00", "dueDate": "2019-05-13T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "unitAmount": 5, "quantity": 1, "discountAmount": 0, "subTotal": 5, "taxAmount": 0, "totalAmount": 5, "accountRef": { "id": "16", "name": "Advertising" }, "taxRateRef": { "id": "NON", "name": "NON", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 5, "taxAmount": 0, "totalAmount": 5, "amountDue": 0, "modifiedDate": "2023-01-18T11:02:41Z", "sourceModifiedDate": "2022-05-26T10:34:10Z", "paymentAllocations": [ { "payment": { "id": "20", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2019-05-13T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } } ] } }, "QuickBooks Online Sandbox": { "value": { "id": "157", "supplierRef": { "id": "57", "supplierName": "Hall's Promo Items" }, "purchaseOrderRefs": [], "issueDate": "2016-01-06T00:00:00", "dueDate": "2016-01-16T00:00:00", "currency": "HKD", "currencyRate": 0.081142, "lineItems": [ { "description": "Water bottles -- generic", "unitAmount": 66.1717023, "quantity": 100, "discountAmount": 0, "subTotal": 6617.17, "taxAmount": 1323.43, "totalAmount": 7940.6, "taxRateRef": { "id": "3_Bills", "name": "20.0% S Bills", "effectiveTaxRate": 20 }, "itemRef": { "id": "19", "name": "Water Bottles" }, "trackingCategoryRefs": [], "tracking": { "categoryRefs": [], "customerRef": { "id": "55", "companyName": "Oxon Insurance - Holiday Party" }, "isBilledTo": "Unknown", "isRebilledTo": "NotApplicable" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 6617.17, "taxAmount": 1323.43, "totalAmount": 7940.6, "amountDue": 0, "modifiedDate": "2023-04-26T09:35:58Z", "sourceModifiedDate": "2023-01-26T11:20:45Z", "paymentAllocations": [ { "payment": { "id": "158", "reference": "1067", "accountRef": { "id": "81", "name": "Current" }, "currency": "HKD", "currencyRate": 0.078807, "paidOnDate": "2016-01-23T00:00:00", "totalAmount": 7940.6 }, "allocation": { "currency": "HKD", "currencyRate": 1, "totalAmount": -7940.6 } } ], "metadata": { "isDeleted": false } } }, "Sage 200cloud": { "value": { "id": "45121", "reference": "Order no 1", "supplierRef": { "id": "CON001", "supplierName": "Concept Stationery Supplies" }, "purchaseOrderRefs": [], "issueDate": "2020-07-22T00:00:00Z", "dueDate": "2020-02-15T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Tax Summary - Tax Rate 1", "unitAmount": 0, "quantity": 0, "discountAmount": 0.5, "subTotal": 0, "taxAmount": 20, "totalAmount": 20, "taxRateRef": { "id": "1729", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Goods Summary", "unitAmount": 0, "quantity": 0, "discountAmount": 2.5, "subTotal": 100, "taxAmount": 0, "totalAmount": 100, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Open", "subTotal": 100, "taxAmount": 20, "totalAmount": 120, "amountDue": 120, "modifiedDate": "2022-10-14T09:36:01Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "note": "No1", "paymentAllocations": [] } }, "Sage 50 (UK)": { "value": { "id": "92", "reference": "2569", "supplierRef": { "id": "THO001", "supplierName": "Thompsons Electricals" }, "purchaseOrderRefs": [], "issueDate": "2021-01-01T00:00:00", "dueDate": "2022-01-31T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Goods", "unitAmount": 5875, "quantity": 1, "subTotal": 5000, "taxAmount": 875, "totalAmount": 5875, "accountRef": { "id": "5000", "name": "Materials Purchased" }, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_7", "name": "Workshop" } ], "tracking": { "categoryRefs": [ { "id": "department_7", "name": "Workshop" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 5000, "taxAmount": 875, "totalAmount": 5875, "amountDue": 0, "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54", "note": "Goods", "paymentAllocations": [ { "payment": { "id": "260", "note": "Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 7141.98 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5875 } } ], "metadata": { "isDeleted": false } } }, "Sage Business Cloud Accounting": { "value": { "id": "15a7a15773b011e8aaa5027d54329956", "reference": "19/06/2018 - 435.60", "supplierRef": { "id": "ca430e0d156011e8b45c025132dab352", "supplierName": "Test Supplier" }, "purchaseOrderRefs": [], "issueDate": "2018-06-19T00:00:00", "dueDate": "2018-07-19T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Consulting services", "unitAmount": 11, "quantity": 33, "subTotal": 363, "taxAmount": 72.6, "totalAmount": 435.6, "accountRef": { "id": "9a995955267a11e797950a57719b2edb", "name": "Cost of sales - goods" }, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 }, "itemRef": { "id": "a87b922b33de11e797950a57719b2edb", "name": "Consulting services" }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "PartiallyPaid", "subTotal": 363, "taxAmount": 72.6, "totalAmount": 435.6, "amountDue": 405.6, "modifiedDate": "2022-10-24T14:56:08Z", "sourceModifiedDate": "2020-02-05T15:19:28Z", "paymentAllocations": [ { "payment": { "id": "332e402b9d4b4614af82594d186f5f29", "note": "Supplier payment using credit/debit card - string", "accountRef": { "id": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } }, { "payment": { "id": "3c3ed62353cf4d148352a14027738dbe", "note": "Supplier payment using credit/debit card - string", "accountRef": { "id": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } }, { "payment": { "id": "cbff2fed2f1641b7bee59f5dd68d29a1", "note": "Supplier payment using credit/debit card - string", "accountRef": { "id": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } }, { "payment": { "id": "d9b643b9d6e149f4b443cbc6f22fe1dd", "note": "Supplier payment using credit/debit card - string", "accountRef": { "id": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } }, { "payment": { "id": "e3e35dcda09642ca8880fc603b0a98e9", "note": "Supplier payment using credit/debit card - string", "accountRef": { "id": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } }, { "payment": { "id": "f11134e299cb4456be096265136a7770", "note": "Supplier payment using credit/debit card - string", "accountRef": { "id": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } } ] } }, "Sage Intacct": { "value": { "id": "4470", "reference": "test", "supplierRef": { "id": "3", "supplierName": "ADP" }, "purchaseOrderRefs": [], "issueDate": "2021-10-19T00:00:00", "dueDate": "2021-10-29T00:00:00", "currency": "GBP", "lineItems": [ { "unitAmount": 25, "quantity": 1, "subTotal": 25, "taxAmount": 0, "totalAmount": 25, "accountRef": { "id": "3", "name": "Accounts Payable" }, "taxRateRef": { "id": "82", "name": "UK Purchase Goods Zero Rate", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [ { "id": "DEPARTMENT-3", "name": "Admin" }, { "id": "LOCATION-11", "name": "Codat Test Entity" } ], "tracking": { "categoryRefs": [ { "id": "DEPARTMENT-3", "name": "Admin" }, { "id": "LOCATION-11", "name": "Codat Test Entity" } ], "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 25, "taxAmount": 0, "totalAmount": 25, "amountDue": 0, "modifiedDate": "2023-04-04T16:31:37Z", "sourceModifiedDate": "2022-02-23T12:06:58", "note": "", "paymentAllocations": [ { "payment": { "id": "4472", "note": "", "accountRef": { "id": "353", "name": "Current Account" }, "currency": "GBP", "paidOnDate": "2022-01-06T00:00:00", "totalAmount": 5 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } }, { "payment": { "id": "4471", "note": "", "accountRef": { "id": "353", "name": "Current Account" }, "currency": "GBP", "paidOnDate": "2022-01-06T00:00:00", "totalAmount": 20 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -20 } } ], "metadata": { "isDeleted": false } } }, "Xero": { "value": { "id": "3945273c-cc04-479f-a4b5-1e3dc7a55ed1", "reference": "", "supplierRef": { "id": "1262c350-fe0f-40ec-aeff-41c95b4a45af", "supplierName": "DIISR - Small Business Services" }, "purchaseOrderRefs": [], "issueDate": "2021-11-19T00:00:00", "dueDate": "2021-12-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Half day training - Microsoft Office", "unitAmount": 1800, "quantity": 1, "discountAmount": 0, "subTotal": 1800, "taxAmount": 360, "totalAmount": 2160, "discountPercentage": 0, "accountRef": { "id": "46f9461e-788b-4906-8b74-d1ea17f6dc10", "name": "Consulting" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "itemRef": { "id": "489558f5-27b7-4f37-ad9f-d84611c2e2ab", "name": "Half day training - Microsoft Office" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month.", "unitAmount": 4000, "quantity": 1, "discountAmount": 0, "subTotal": 4000, "taxAmount": 800, "totalAmount": 4800, "discountPercentage": 0, "accountRef": { "id": "f96c9458-d724-47bf-8f74-a9d5726465ce", "name": "General Expenses" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "itemRef": { "id": "f8fb7e00-5e5d-466c-aef0-15861f73d04f", "name": "Desktop/network support via email & phone" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Stationery charges", "unitAmount": 32, "quantity": 8, "discountAmount": 0, "subTotal": 256, "taxAmount": 51.2, "totalAmount": 307.2, "discountPercentage": 0, "accountRef": { "id": "cba6527d-f102-4538-b421-e483233e9d5a", "name": "Printing & Stationery" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Paid", "subTotal": 6056, "taxAmount": 1211.2, "totalAmount": 7267.2, "amountDue": 0, "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2021-01-02T21:07:23", "paymentAllocations": [ { "payment": { "id": "74004690-82a1-4810-aaca-6ce575af94b4", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-12-20T00:00:00", "totalAmount": 7267.2 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7267.2 } } ], "metadata": { "isDeleted": false } } }, "Zoho Books": { "value": { "id": "104957000000152027", "reference": "1", "supplierRef": { "id": "104957000000152001", "supplierName": "Mr. P N" }, "purchaseOrderRefs": [], "issueDate": "2020-06-23T00:00:00", "dueDate": "2020-06-23T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [], "withholdingTax": [], "status": "Paid", "subTotal": 0, "taxAmount": 0, "totalAmount": 10, "amountDue": 0, "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2020-06-23T13:47:17", "paymentAllocations": [] } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get bill", "description": "The *Get bill* endpoint returns a single bill for a given billId.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a specific bill.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n\n\n### Tips and traps\n\nTo access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache.\n", "operationId": "get-bill" } }, "/companies/{companyId}/connections/{connectionId}/options/bills": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create/update bill model", "tags": [ "Bills" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Dynamics 365 Business Central": { "value": { "type": "Object", "displayName": "Bill", "description": "A bill is an itemised record of goods purchased from or services provided by a supplier", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the bill has been received from", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "status": { "type": "String", "displayName": "Bill Status", "description": "The current state of the bill", "options": [ { "value": "Draft", "type": "Array", "displayName": "Draft", "required": false }, { "value": "Void", "type": "Array", "displayName": "Void", "required": false }, { "value": "Open", "type": "Array", "displayName": "Open", "required": false } ], "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the bill is due to be paid by", "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date of the bill as recorded in the originating system.", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the bill", "required": true, "validation": { "warnings": [ { "field": "Note", "details": "Supplier Invoice Number must be specified in this field" } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the bill", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Either AccountRef or ItemRef should be specified. If ItemRef is chosen, ID must be specified" } ], "information": [] } } }, "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Please ensure that the account posting setup for this account is valid before pushing" }, { "field": "AccountRef.Id", "details": "Either AccountRef or ItemRef should be specified. If AccountRef is chosen, ID must be specified" } ], "information": [] } } }, "required": false }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true, "validation": { "warnings": [ { "field": "LineItems.Quantity", "details": "Must be positive" } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": false }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": false }, "tracking": { "type": "Object", "displayName": "Accounts Payable Tracking", "description": "A collection of items this line item is being tracked against", "properties": { "categoryRefs": { "type": "Array", "displayName": "Category References", "description": "A collection of categories this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "CategoryRefs.Id", "details": "Must not be a parent Tracking Category. All Tracking Category specified must have different parent categories" } ], "information": [ { "field": "CategoryRefs.Id", "details": "Every Tracking Category specified will be applied to every line item" } ] } } }, "required": true } }, "required": false } }, "required": true } }, "required": true } }, "FreeAgent": { "value": { "type": "Object", "displayName": "Bill", "description": "A bill is an itemised record of goods purchased from or services provided by a supplier", "properties": { "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the bill", "required": true }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the bill has been received from", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must match the ID of an existing supplier." } ], "information": [] } } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the bill, inclusive of tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must be greater than or equal to 0 and must be equal to the total value of the bill item total amounts." } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the bill", "properties": { "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxAmount", "details": "Must be positive for bill items and negative for credit items. If not specified, defaults to the tax correct tax rate amount for the category of the bill." } ], "information": [ { "field": "LineItems.TaxAmount", "details": "Amount of sales tax for the BillLineItem in company's native currency." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [] } } }, "required": true } }, "required": true, "validation": { "warnings": [ { "field": "LineItems", "details": "Must contain at least one line item and up to a maximum of 40 line items allowed." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the bill", "options": [ { "value": "AED", "type": "String", "displayName": "AED", "required": false }, { "value": "AMD", "type": "String", "displayName": "AMD", "required": false }, { "value": "AOA", "type": "String", "displayName": "AOA", "required": false }, { "value": "ARS", "type": "String", "displayName": "ARS", "required": false }, { "value": "AUD", "type": "String", "displayName": "AUD", "required": false }, { "value": "AWG", "type": "String", "displayName": "AWG", "required": false }, { "value": "AZN", "type": "String", "displayName": "AZN", "required": false }, { "value": "BBD", "type": "String", "displayName": "BBD", "required": false }, { "value": "BDT", "type": "String", "displayName": "BDT", "required": false }, { "value": "BGN", "type": "String", "displayName": "BGN", "required": false }, { "value": "BRL", "type": "String", "displayName": "BRL", "required": false }, { "value": "BWP", "type": "String", "displayName": "BWP", "required": false }, { "value": "CAD", "type": "String", "displayName": "CAD", "required": false }, { "value": "CHF", "type": "String", "displayName": "CHF", "required": false }, { "value": "CLP", "type": "String", "displayName": "CLP", "required": false }, { "value": "CNY", "type": "String", "displayName": "CNY", "required": false }, { "value": "COP", "type": "String", "displayName": "COP", "required": false }, { "value": "CRC", "type": "String", "displayName": "CRC", "required": false }, { "value": "CUC", "type": "String", "displayName": "CUC", "required": false }, { "value": "CUP", "type": "String", "displayName": "CUP", "required": false }, { "value": "CZK", "type": "String", "displayName": "CZK", "required": false }, { "value": "DKK", "type": "String", "displayName": "DKK", "required": false }, { "value": "DOP", "type": "String", "displayName": "DOP", "required": false }, { "value": "EGP", "type": "String", "displayName": "EGP", "required": false }, { "value": "EUR", "type": "String", "displayName": "EUR", "required": false }, { "value": "FJD", "type": "String", "displayName": "FJD", "required": false }, { "value": "GBP", "type": "String", "displayName": "GBP", "required": false }, { "value": "GEL", "type": "String", "displayName": "GEL", "required": false }, { "value": "GHS", "type": "String", "displayName": "GHS", "required": false }, { "value": "GTQ", "type": "String", "displayName": "GTQ", "required": false }, { "value": "GYD", "type": "String", "displayName": "GYD", "required": false }, { "value": "HKD", "type": "String", "displayName": "HKD", "required": false }, { "value": "HNL", "type": "String", "displayName": "HNL", "required": false }, { "value": "HRK", "type": "String", "displayName": "HRK", "required": false }, { "value": "HUF", "type": "String", "displayName": "HUF", "required": false }, { "value": "IDR", "type": "String", "displayName": "IDR", "required": false }, { "value": "ILS", "type": "String", "displayName": "ILS", "required": false }, { "value": "INR", "type": "String", "displayName": "INR", "required": false }, { "value": "ISK", "type": "String", "displayName": "ISK", "required": false }, { "value": "JMD", "type": "String", "displayName": "JMD", "required": false }, { "value": "JPY", "type": "String", "displayName": "JPY", "required": false }, { "value": "KES", "type": "String", "displayName": "KES", "required": false }, { "value": "KRW", "type": "String", "displayName": "KRW", "required": false }, { "value": "KWD", "type": "String", "displayName": "KWD", "required": false }, { "value": "KYD", "type": "String", "displayName": "KYD", "required": false }, { "value": "KZT", "type": "String", "displayName": "KZT", "required": false }, { "value": "LAK", "type": "String", "displayName": "LAK", "required": false }, { "value": "LBP", "type": "String", "displayName": "LBP", "required": false }, { "value": "LKR", "type": "String", "displayName": "LKR", "required": false }, { "value": "LTL", "type": "String", "displayName": "LTL", "required": false }, { "value": "LVL", "type": "String", "displayName": "LVL", "required": false }, { "value": "MAD", "type": "String", "displayName": "MAD", "required": false }, { "value": "MDL", "type": "String", "displayName": "MDL", "required": false }, { "value": "MGA", "type": "String", "displayName": "MGA", "required": false }, { "value": "MUR", "type": "String", "displayName": "MUR", "required": false }, { "value": "MVR", "type": "String", "displayName": "MVR", "required": false }, { "value": "MWK", "type": "String", "displayName": "MWK", "required": false }, { "value": "MXN", "type": "String", "displayName": "MXN", "required": false }, { "value": "MYR", "type": "String", "displayName": "MYR", "required": false }, { "value": "MZN", "type": "String", "displayName": "MZN", "required": false }, { "value": "NAD", "type": "String", "displayName": "NAD", "required": false }, { "value": "NGN", "type": "String", "displayName": "NGN", "required": false }, { "value": "NOK", "type": "String", "displayName": "NOK", "required": false }, { "value": "NPR", "type": "String", "displayName": "NPR", "required": false }, { "value": "NZD", "type": "String", "displayName": "NZD", "required": false }, { "value": "OMR", "type": "String", "displayName": "OMR", "required": false }, { "value": "PEN", "type": "String", "displayName": "PEN", "required": false }, { "value": "PHP", "type": "String", "displayName": "PHP", "required": false }, { "value": "PKR", "type": "String", "displayName": "PKR", "required": false }, { "value": "PLN", "type": "String", "displayName": "PLN", "required": false }, { "value": "QAR", "type": "String", "displayName": "QAR", "required": false }, { "value": "RON", "type": "String", "displayName": "RON", "required": false }, { "value": "RSD", "type": "String", "displayName": "RSD", "required": false }, { "value": "RUB", "type": "String", "displayName": "RUB", "required": false }, { "value": "RWF", "type": "String", "displayName": "RWF", "required": false }, { "value": "SAR", "type": "String", "displayName": "SAR", "required": false }, { "value": "SCR", "type": "String", "displayName": "SCR", "required": false }, { "value": "SEK", "type": "String", "displayName": "SEK", "required": false }, { "value": "SGD", "type": "String", "displayName": "SGD", "required": false }, { "value": "THB", "type": "String", "displayName": "THB", "required": false }, { "value": "TND", "type": "String", "displayName": "TND", "required": false }, { "value": "TRY", "type": "String", "displayName": "TRY", "required": false }, { "value": "TTD", "type": "String", "displayName": "TTD", "required": false }, { "value": "TWD", "type": "String", "displayName": "TWD", "required": false }, { "value": "TZS", "type": "String", "displayName": "TZS", "required": false }, { "value": "UAH", "type": "String", "displayName": "UAH", "required": false }, { "value": "UGX", "type": "String", "displayName": "UGX", "required": false }, { "value": "USD", "type": "String", "displayName": "USD", "required": false }, { "value": "UYU", "type": "String", "displayName": "UYU", "required": false }, { "value": "VEF", "type": "String", "displayName": "VEF", "required": false }, { "value": "VND", "type": "String", "displayName": "VND", "required": false }, { "value": "VUV", "type": "String", "displayName": "VUV", "required": false }, { "value": "XAF", "type": "String", "displayName": "XAF", "required": false }, { "value": "XCD", "type": "String", "displayName": "XCD", "required": false }, { "value": "XOF", "type": "String", "displayName": "XOF", "required": false }, { "value": "ZAR", "type": "String", "displayName": "ZAR", "required": false }, { "value": "ZMK", "type": "String", "displayName": "ZMK", "required": false } ], "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "If not specified, defaults to the company's native currency" } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the bill and the base currency of the company", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the bill", "required": true, "validation": { "warnings": [ { "field": "TaxAmount", "details": "Must be greater than or equal to 0, less than or equal to the Bill.TotalAmount and equal to the total value of the bill item tax amounts." } ], "information": [] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date of the bill as recorded in the originating system.", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the bill is due to be paid by", "required": true } }, "required": true } }, "MYOB AccountRight and Essentials": { "value": { "type": "Object", "displayName": "Bill", "description": "A bill is an itemised record of goods purchased from or services provided by a supplier", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the bill, inclusive of tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Precision must be maximum of two decimal places." }, { "field": "TotalAmount", "details": "Must be greater than zero." } ], "information": [ { "field": "TotalAmount", "details": "Must be provided." } ] } }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the bill", "required": false, "validation": { "warnings": [], "information": [ { "field": "Reference", "details": "Must not be greater than 8 characters long." } ] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the bill excluding any taxes", "required": false, "validation": { "warnings": [ { "field": "SubTotal", "details": "Precision must be maximum of two decimal places." } ], "information": [] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the bill", "required": false, "validation": { "warnings": [ { "field": "TaxAmount", "details": "Precision must be maximum of two decimal places." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the bill", "options": [ { "value": "AUD", "type": "String", "displayName": "Australian Dollar", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Must be provided." } ] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date of the bill as recorded in the originating system.", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must not be before the due date." } ] } }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the bill is due to be paid by", "required": true, "validation": { "warnings": [], "information": [ { "field": "DueDate", "details": "Must be provided." } ] } }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the bill has been received from", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [], "information": [ { "field": "SupplierRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "SupplierRef", "details": "Must be provided." } ] } }, "amountDue": { "type": "Number", "displayName": "Amount Due", "description": "The amount outstanding on the bill", "required": false, "validation": { "warnings": [ { "field": "AmountDue", "details": "Precision must be maximum of two decimal places." } ], "information": [ { "field": "AmountDue", "details": "Must be at least zero and no more than that the total amount." } ] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the bill", "properties": { "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [ { "field": "LineItems.AccountRef", "details": "Must match the Inventory Item's AccountRef if supplied" }, { "field": "LineItems.AccountRef", "details": "Must be supplied except when an ItemRef is supplied" } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [], "information": [ { "field": "TaxRateRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxRateRef", "details": "Must be provided." } ] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true } }, "required": false }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.Description", "details": "Must not be greater than 225 characters long." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "LineItems.TotalAmount", "details": "Precision must be maximum of two decimal places." } ], "information": [ { "field": "LineItems.TotalAmount", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [ { "field": "LineItems.UnitAmount", "details": "Precision must be maximum of two decimal places." } ], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxAmount", "details": "Precision must be maximum of two decimal places." } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must be provided." } ] } } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "Bill", "description": "A bill is an itemised record of goods purchased from or services provided by a supplier", "properties": { "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the bill", "required": false }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the bill has been received from", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date of the bill as recorded in the originating system.", "required": false }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the bill is due to be paid by", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the bill", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the bill and the base currency of the company", "required": true }, "status": { "type": "String", "displayName": "Bill Status", "description": "The current state of the bill", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the bill", "required": false }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the bill", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": false }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": false, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Should only be specified when pushing an expense" } ] } } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true } }, "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [], "information": [ { "field": "ItemRef.Id", "details": "Should only be specified when pushing an item (not an expense)" } ] } } }, "required": true }, "tracking": { "type": "Object", "displayName": "Accounts Payable Tracking", "description": "A collection of items this line item is being tracked against", "properties": { "categoryRefs": { "type": "Array", "displayName": "Category References", "description": "A collection of categories this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true } }, "required": false } }, "required": false } }, "required": true } }, "options": [ { "value": "Open", "type": "String", "displayName": "Open", "required": false } ], "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Bill", "description": "A bill is an itemised record of goods purchased from or services provided by a supplier", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the bill has been received from", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must match the ID of an existing supplier." } ], "information": [] } } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date of the bill as recorded in the originating system.", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the bill is due to be paid by", "required": false }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the bill", "required": false, "validation": { "warnings": [ { "field": "Reference", "details": "Max length of 20 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the bill", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "Must be a three letter ISO code that matches the currency of the supplier" }, { "field": "Currency", "details": "Can only be set if the QuickBooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "Currency", "details": "If not set, will default to the default currency of the supplier" } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the bill", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Max length of 4000 characters." } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the bill and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1." }, { "field": "CurrencyRate", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ] } }, "status": { "type": "String", "displayName": "Bill Status", "description": "The current state of the bill", "options": [ { "value": "Open", "type": "String", "displayName": "Open", "required": false }, { "value": "Paid", "type": "String", "displayName": "Paid", "required": false }, { "value": "Void", "type": "String", "displayName": "Void", "required": false } ], "required": true, "validation": { "warnings": [ { "field": "Status", "details": "If a bill is pushed with a total amount of 0, then the status must be Paid or Void" } ], "information": [ { "field": "Status", "details": "If a bill is pushed with a status of void, then all the amounts in the bill must be 0" }, { "field": "Status", "details": "If a bill is pushed without payment allocations, then the status must be Open, if pushed with payment allocations, then the status must be paid" } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the bill", "required": true, "validation": { "warnings": [ { "field": "TaxAmount", "details": "Cannot be mapped directly into QuickBooks Desktop and will only be used for validation purposes" }, { "field": "TaxAmount", "details": "Must match sum of total of tax from the line items" } ], "information": [] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the bill excluding any taxes", "required": true, "validation": { "warnings": [ { "field": "SubTotal", "details": "Must match the totalAmount - taxAmount" } ], "information": [] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the bill, inclusive of tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must match the sum of line items ((quantity * unit price) - discount + tax)" } ], "information": [ { "field": "TotalAmount", "details": "If a bill is pushed with a total amount of 0, it will automatically be marked as paid in QuickBooks Desktop" } ] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the bill", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Max length of 4000 characters." } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TotalAmount", "details": "Must match subtotal + tax amount of line" } ] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.SubTotal", "details": "Must match quantity * unit amount of line" } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true, "validation": { "warnings": [ { "field": "LineItems.TaxAmount", "details": "Cannot be mapped directly into QuickBooks Desktop and will only be used for validation purposes" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing nominal account." } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "LineItems.AccountRef", "details": "Can't include both AccountRef and ItemRef" } ], "information": [ { "field": "LineItems.AccountRef", "details": "Account type must be Asset, Liability or Expense and not Accounts Payable" } ] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item type." } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "LineItems.ItemRef", "details": "Can't include both AccountRef and ItemRef" } ], "information": [ { "field": "LineItems.ItemRef", "details": "Item type must not be Discount or Sale-Tax items" } ] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Only valid for UK or CA versions of QuickBooks Desktop with VAT enabled" }, { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax rate" } ], "information": [] } } }, "required": false }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.Id", "details": "Must match the ID of an existing tracking category." } ], "information": [] } } }, "required": false } }, "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the bill", "properties": { "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": false, "validation": { "warnings": [ { "field": "Allocation.Currency", "details": "If set, must match currency on the bill" } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the transaction", "required": false, "validation": { "warnings": [ { "field": "Allocation.CurrencyRate", "details": "If set, must match currency rate on the bill" } ], "information": [] } }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": false, "validation": { "warnings": [ { "field": "Allocation.AllocatedOnDate", "details": "If set, must match issue date on the bill" } ], "information": [] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": true, "validation": { "warnings": [ { "field": "Allocation.TotalAmount", "details": "Must match total amount on the bill" } ], "information": [] } } }, "required": true }, "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": false, "validation": { "warnings": [ { "field": "Payment.Currency", "details": "$ set, must match currency on the {topLevelItem}" } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the base company", "required": false, "validation": { "warnings": [ { "field": "Payment.CurrencyRate", "details": "If set, must match currency rate on the bill" } ], "information": [] } }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": true, "validation": { "warnings": [ { "field": "Payment.PaidOnDate", "details": "Must match issue date on the bill" } ], "information": [] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": true, "validation": { "warnings": [ { "field": "Payment.TotalAmount", "details": " Must match total amount on the bill" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing credit card account." } ], "information": [] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Payment.AccountRef", "details": " Account type must be of type Credit Card" } ] } } }, "required": true } }, "required": false, "validation": { "warnings": [ { "field": "PaymentAllocations", "details": "A maximum of one payment allocation may be provided per bill" } ], "information": [ { "field": "PaymentAllocations", "details": "If a payment allocation is provided, a credit card charge will created in QuickBooksDesktop, if left as null or empty, a {topLevelItem} will be created" } ] } } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Bill", "description": "A bill is an itemised record of goods purchased from or services provided by a supplier", "properties": { "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the bill is due to be paid by", "required": true }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the bill", "required": false, "validation": { "warnings": [], "information": [ { "field": "Reference", "details": "Should be unique if WarnDuplicateBillNumber setting is On." }, { "field": "Reference", "details": "Should not be longer than 21 characters." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the bill", "options": [ { "value": "USD", "type": "String", "displayName": "USD", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Required if multi-currency is enabled for the company." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the bill and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "Required if Currency is not the base currency." } ] } }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the bill has been received from", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date of the bill as recorded in the originating system.", "required": false, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "If the issue date is not supplied, the current date on the server is used." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the bill, inclusive of tax", "required": false }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the bill excluding any taxes", "required": false }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the bill", "properties": { "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": true } }, "required": true }, "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [] } } }, "required": true } }, "required": true } }, "required": false, "validation": { "warnings": [ { "field": "PaymentAllocations", "details": "Payment Allocations are no longer valid for Bills and must not be provided, use the DirectCost data type to push Expenses." } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the bill", "required": false }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the bill", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Should not be longer than 4000 characters." } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Required if the expense line is account based. If AccountRef is specified, ItemRef must be null." } ] } } }, "required": false }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.Id", "details": "Must match the ID of an existing tracking category and be of type DEPARTMENT or CLASS." } ], "information": [] } } }, "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [ { "field": "ItemRef.Id", "details": "Required if the expense line is item based. If ItemRef is specified, AccountRef must be null." } ] } } }, "required": false }, "tracking": { "type": "Object", "displayName": "Accounts Payable Tracking", "description": "A collection of items this line item is being tracked against", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": false } }, "required": false }, "isRebilledTo": { "type": "String", "displayName": "Is Rebilled To", "description": "The type of item this line item is billed to", "required": false, "validation": { "warnings": [ { "field": "Tracking.IsRebilledTo", "details": "Must be set to 'Customer' when Tracking.CustomerRef is supplied" } ], "information": [] } } }, "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax code." } ], "information": [ { "field": "TaxRateRef.Id", "details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used, or the tax rate must be unset." } ] } } }, "required": true } }, "required": true } }, "required": true } }, "Sage 50 (UK)": { "value": { "type": "Object", "displayName": "Bill", "description": "A bill is an itemised record of goods purchased from or services provided by a supplier", "properties": { "issueDate": { "type": "DateTime", "displayName": "Date", "description": "Date when the bill was issued.", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "Date when the bill is due.", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency in which the bill is issued in.", "required": true, "validation": { "warnings": [ { "field": "currency", "details": "This must match the supplier's default currency." } ], "information": [] } }, "status": { "type": "String", "displayName": "Status", "description": "The status of the bill", "options": [ { "value": "Open", "type": "String", "displayName": "Open", "required": false } ], "required": false, "validation": { "warnings": [], "information": [ { "field": "status", "details": "If this is not set, it will default to 'Open'." } ] } }, "supplierRef": { "type": "Object", "displayName": "Supplier", "description": "Supplier on the bill.", "properties": { "id": { "type": "String", "displayName": "Supplier Id", "description": "Identifier of the supplier.", "required": true, "validation": { "warnings": [ { "field": "supplierRef.id", "details": "Must match the ID of an existing supplier and have a max length of 8 characters." } ], "information": [] } } }, "required": true }, "reference": { "type": "String", "displayName": "Bill Reference", "description": "The reference to the bill.", "required": false, "validation": { "warnings": [ { "field": "reference", "details": "Max length of 30 characters." } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "To be used for any additional information associated with the Bill line item.", "required": false, "validation": { "warnings": [ { "field": "note", "details": "Maximum 60 characters" } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "Line items of the bill.", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Description of the bill line item.", "required": true, "validation": { "warnings": [ { "field": "lineItems.description", "details": "Max length of 60 characters." } ], "information": [] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "Tax of the bill line item.", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the bill line item, inclusive of the tax amount.", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Identifier for the account.", "properties": { "id": { "type": "String", "displayName": "Account Id", "description": "Identifier of the account.", "required": true, "validation": { "warnings": [ { "field": "accountRef.id", "details": "Must match the ID of an existing account." } ], "information": [] } } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Tax rate reference of a bill line item.", "properties": { "id": { "type": "String", "displayName": "Tax Rate Id", "description": "ID of the tax rate.", "required": true, "validation": { "warnings": [ { "field": "taxRateRef.id", "details": "Must match the ID of an existing tax rate." } ], "information": [] } } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Categories", "description": "Tracking categories for the line item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "Prefixed identifier for tracking category e.g. project_{x}, department_{x}, costcode_{x}", "required": true, "validation": { "warnings": [ { "field": "trackingCategoryRefs.id", "details": "Cost codes assigned with costcode_{x} must exist in Sage50 and must be assigned in conjunction with a project" }, { "field": "trackingCategoryRefs.id", "details": "Projects assigned with project_{x} must exist in Sage50 and must be assigned in conjunction with a cost code" }, { "field": "trackingCategoryRefs.id", "details": "Departments assigned with department_{x} must exist in Sage50" } ], "information": [] } } }, "required": false } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company." } ] } } }, "Sage Business Cloud Accounting": { "value": { "type": "Object", "displayName": "Bill", "description": "A bill is an itemised record of goods purchased from or services provided by a supplier", "properties": { "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date of the bill as recorded in the originating system.", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must be provided." } ] } }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the bill is due to be paid by", "required": true, "validation": { "warnings": [], "information": [ { "field": "DueDate", "details": "Must be provided." } ] } }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the bill has been received from", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must match the ID of an existing supplier." } ], "information": [ { "field": "SupplierRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the bill", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "If supplied, must match the currency of the supplier." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the bill and the base currency of the company", "required": false }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the bill", "required": false, "validation": { "warnings": [ { "field": "Reference", "details": "Should not be longer than 25 characters." } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the bill", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Should not be longer than 2000 characters." } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the bill", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Should not be longer than 2000 characters." } ], "information": [ { "field": "LineItems.Description", "details": "Must be provided." } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [ { "field": "ItemRef.Id", "details": "If ItemRef is provided, then ID is required." } ] } } }, "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxAmount", "details": "Must be provided." } ] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax code." } ], "information": [ { "field": "TaxRateRef.Id", "details": "Must be provided." } ] } } }, "required": true } }, "required": true } }, "required": true } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "Bill", "description": "A bill is an itemised record of goods purchased from or services provided by a supplier", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the bill, unique for the company", "required": false, "validation": { "warnings": [ { "field": "Id", "details": "Not supported for account based line items. Required for item based line items. A unique number for the bill will be appended to the value supplied, to ensure the ID is unique." } ], "information": [] } }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the bill", "required": true, "validation": { "warnings": [ { "field": "Reference", "details": "For account based line items, must be between 1 and 100 characters. For item based line items, must be between 1 and 45 characters." } ], "information": [] } }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the bill has been received from", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must match to an existing Supplier Id." } ], "information": [] } } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date of the bill as recorded in the originating system.", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the bill is due to be paid by", "required": false, "validation": { "warnings": [ { "field": "DueDate", "details": "For item based line items, must be provided and must not be earlier than IssueDate." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the bill", "options": [ { "value": "AUD", "type": "String", "displayName": "Australian Dollar", "required": false }, { "value": "CAD", "type": "String", "displayName": "Canadian Dollar", "required": false }, { "value": "GBP", "type": "String", "displayName": "Pound Sterling", "required": false }, { "value": "USD", "type": "String", "displayName": "US Dollar", "required": false }, { "value": "ZAR", "type": "String", "displayName": "Rand", "required": false } ], "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "Must be provided if CurrencyRate is set." } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the bill and the base currency of the company", "required": false, "validation": { "warnings": [ { "field": "CurrencyRate", "details": "Must be greater than 0." } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the bill", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Is not supported for item based line items." } ], "information": [] } }, "status": { "type": "String", "displayName": "Bill Status", "description": "The current state of the bill", "required": false, "validation": { "warnings": [ { "field": "Status", "details": "Must be provided for item based line items." } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the bill", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "For account based line items, must be between 1 and 1000 characters. For item based line items, must be between 1 and 400 characters." } ], "information": [] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.Id", "details": "Must contain the type of the tracking category and the Id of the selected category, separated by a '-'. For example, 'DEPARTMENT-100'." }, { "field": "TrackingCategoryRefs.Id", "details": "Custom tracking categories are only supported for account based line items." } ], "information": [] } } }, "required": false }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false, "validation": { "warnings": [ { "field": "LineItems.SubTotal", "details": "Must be provided for account based line items. Must not be provided for item based line items." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match to an existing Account Id." } ], "information": [] } } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.AccountRef", "details": "Must be provided for account based line items. Must not be provided for item based line items." } ], "information": [] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match to an existing Item Id." } ], "information": [] } } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.ItemRef", "details": "Must be provided for item based line items. Must not be provided for account based line items." } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match to an existing TaxRate Id." } ], "information": [] } } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxRateRef", "details": "Is not supported for item based line items." } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Quantity", "details": "For item based line items, must be provided and must not be negative. For account based line items, if provided must always be 0." } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": false, "validation": { "warnings": [ { "field": "LineItems.UnitAmount", "details": "For item based line items, must be provided and must not be negative. For account based line items, if provided must always be 0." } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "LineItems", "details": "Must either all be account based or all be item based." } ], "information": [] } } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Bill", "description": "A bill is an itemised record of goods purchased from or services provided by a supplier", "properties": { "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the bill", "required": true }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the bill has been received from", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true }, "supplierName": { "type": "String", "displayName": "Name", "description": "The name of the supplier referenced by the identifier", "required": true } }, "required": true }, "purchaseOrderRefs": { "type": "Array", "displayName": "Purchase Order References", "description": "List of References to the purchase order the bill was created from.", "properties": { "id": { "type": "String", "displayName": "Id", "description": "Unique identifier for the purchase order in the accounting software", "required": true }, "purchaseOrderNumber": { "type": "String", "displayName": "Purchase Order Number", "description": "Friendly reference for the purchase order, commonly generated by the accounting software", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date of the bill as recorded in the originating system.", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the bill is due to be paid by", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the bill", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the bill and the base currency of the company", "required": true }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the bill", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given bill currency, of any discounts applied", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": true }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": true } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the item referenced by the identifier", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": true } }, "required": true }, "tracking": { "type": "Object", "displayName": "Accounts Payable Tracking", "description": "A collection of items this line item is being tracked against", "properties": { "categoryRefs": { "type": "Array", "displayName": "Category References", "description": "A collection of categories this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": true } }, "required": true }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true }, "companyName": { "type": "String", "displayName": "Name", "description": "The name of the customer referenced by the identifier", "required": true } }, "required": true }, "projectRef": { "type": "Object", "displayName": "Project Reference", "description": "Reference to the project this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the Project", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the Project referenced by the identifier", "required": true } }, "required": true }, "isBilledTo": { "type": "String", "displayName": "Is Billed To", "description": "The type of item this line item is billed to.", "required": true }, "isRebilledTo": { "type": "String", "displayName": "Is Rebilled To", "description": "The type of item this line item is billed to", "required": true } }, "required": true }, "isDirectCost": { "type": "Boolean", "displayName": "Is Direct Cost", "description": "True if this bill is also mapped as a direct cost", "required": true } }, "required": true }, "withholdingTax": { "type": "Array", "displayName": "Withholding Tax", "description": "A collection of tax deductions", "properties": { "name": { "type": "String", "displayName": "Name", "description": "Name of the deduction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "Deduction amount", "required": true } }, "required": true }, "status": { "type": "String", "displayName": "Bill Status", "description": "The current state of the bill", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the bill excluding any taxes", "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the bill", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the bill, inclusive of tax", "required": true }, "amountDue": { "type": "Number", "displayName": "Amount Due", "description": "The amount outstanding on the bill", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the bill", "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the bill", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the allocated payment", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the allocated payment", "required": true }, "reference": { "type": "String", "displayName": "Reference", "description": "Reference associated with the allocated payment", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the base company", "required": true }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": true } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the transaction", "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": true } }, "required": true } }, "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Bill", "description": "A bill is an itemised record of goods purchased from or services provided by a supplier", "properties": { "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date of the bill as recorded in the originating system.", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must be provided." } ] } }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the bill is due to be paid by", "required": true, "validation": { "warnings": [], "information": [ { "field": "DueDate", "details": "Must be provided." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the bill", "required": false }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the bill", "required": false, "validation": { "warnings": [], "information": [ { "field": "Reference", "details": "Must not exceed 255 charaters long." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the bill and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "If no rate is specified, the Xero day rate will be applied.", "ref": "https://central.xero.com/s/#CurrencySettings$Rates" } ] } }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the bill has been received from", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must be a valid GUID." }, { "field": "SupplierRef.Id", "details": "Must match the ID of an existing customer." } ], "information": [ { "field": "SupplierRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "SupplierRef", "details": "Must be provided." } ] } }, "status": { "type": "String", "displayName": "Bill Status", "description": "The current state of the bill", "options": [ { "value": "Open", "type": "String", "displayName": "Open", "required": false }, { "value": "Draft", "type": "String", "displayName": "Draft", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "Must be provided." } ] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the bill", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Description", "details": "Must not be longer than 4000 characters long." } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true, "validation": { "warnings": [ { "field": "LineItems.TaxAmount", "details": "Cannot be mapped directly into Xero and will only be used for validation purposes." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a valid GUID." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided, if ItemRef is not provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.AccountRef", "details": "Must be provided, if ItemRef is not provided." } ] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [], "information": [ { "field": "TrackingCategoryRefs.Id", "details": "Must not be a parent tracking category." }, { "field": "TrackingCategoryRefs.Id", "details": "Must be provided." } ] } } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TrackingCategoryRefs", "details": "Tracking categories must not have the same parent tracking category." }, { "field": "LineItems.TrackingCategoryRefs", "details": "Maximum of 2 Tracking Categories." } ] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must be a valid GUID." }, { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax rate." } ], "information": [ { "field": "TaxRateRef.Id", "details": "Must be provided if TaxAmount is provided." } ] } } }, "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must be a valid GUID." }, { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.ItemRef", "details": "Must be provided, if AccountRef is not provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must be provided." } ] } } }, "required": true } }, "Zoho Books": { "value": { "type": "Object", "displayName": "Bill", "description": "A bill is an itemised record of goods purchased from or services provided by a supplier", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Reference to the supplier the bill has been received from", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the bill", "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date of the bill as recorded in the originating system.", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the bill is due to be paid by", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the bill", "required": true, "validation": { "warnings": [ { "field": "Currency", "details": "Must match the supplier's currency" } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the bill and the base currency of the company", "required": false, "validation": { "warnings": [ { "field": "CurrencyRate", "details": "Must be greater than or equal to 0" } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the bill", "required": false }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the bill", "properties": { "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.ItemRef", "details": "Must be provided if AccountRef is not set" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.AccountRef", "details": "Must be provided if ItemRef is not set" } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true } }, "required": false }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given bill currency, of any discounts applied", "required": false } }, "required": true, "validation": { "warnings": [ { "field": "LineItems", "details": "The sum of subtotals over all the line items must be greater than or equal to 0" }, { "field": "LineItems", "details": "Must not be empty" } ], "information": [] } }, "status": { "type": "String", "displayName": "Bill Status", "description": "The current state of the bill", "options": [ { "value": "Open", "type": "String", "displayName": "Open", "required": false }, { "value": "Void", "type": "String", "displayName": "Void", "required": false } ], "required": true } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-update-bills-model", "description": "The *Get create/update bill model* endpoint returns the expected data for the request payload when creating and updating a [bill](https://docs.codat.io/accounting-api#/schemas/Bill) for a given company and integration.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support creating and updating a bill.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/bills": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Bills" ], "summary": "Create bill", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bill" }, "examples": { "QuickBooks Desktop": { "value": { "reference": "20230308 15.16", "supplierRef": { "id": "80000001-1671793885", "supplierName": "string" }, "purchaseOrderRefs": [ { "id": "string", "purchaseOrderNumber": "string" } ], "issueDate": "2023-03-08T09:21:18.558Z", "dueDate": "2023-03-14T09:21:18.558Z", "currency": "USD", "currencyRate": 1, "lineItems": [ { "description": "line 1 description", "unitAmount": 1.625, "quantity": 2, "discountAmount": 0, "subTotal": 3.25, "taxAmount": 0, "totalAmount": 3.25, "discountPercentage": 0, "itemRef": { "id": "80000001-1674566705", "name": "string" }, "trackingCategoryRefs": [ { "id": "80000003-1674553958", "name": "Class 2" } ], "tracking": { "categoryRefs": [ { "id": "80000001-1674553252", "name": "Class 1" } ], "customerRef": { "id": "80000002-1674552702", "companyName": "string" }, "projectRef": { "id": "string", "name": "string" }, "isBilledTo": "Unknown", "isRebilledTo": "Customer" }, "isDirectCost": true } ], "withholdingTax": [ { "name": "string", "amount": 0 } ], "status": "Open", "subTotal": 3.25, "taxAmount": 0, "totalAmount": 3.25, "amountDue": 115.899999984, "note": "note", "paymentAllocations": [] } }, "Sage 50 (UK)": { "value": { "reference": "20230314 11.38", "supplierRef": { "id": "SUPP1", "supplierName": "string" }, "purchaseOrderRefs": [ { "id": "string", "purchaseOrderNumber": "string" } ], "issueDate": "2023-03-14T10:44:56.884Z", "dueDate": "2023-05-05T10:44:56.884Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "SWRAILWAYSELFSERVE; 17068; General ; V. Shone; Transport fo", "unitAmount": 15, "quantity": 2, "discountAmount": 0, "subTotal": 30, "taxAmount": 6, "totalAmount": 36, "discountPercentage": 0, "accountRef": { "id": "7401", "name": "string" }, "taxRateRef": { "id": "1", "name": "string", "effectiveTaxRate": 0 }, "itemRef": { "id": "string", "name": "string" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "string" } ], "tracking": { "categoryRefs": [ { "id": "string", "name": "string" } ], "customerRef": { "id": "string", "companyName": "string" }, "projectRef": { "id": "string", "name": "string" }, "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectCost": true } ], "withholdingTax": [ { "name": "string", "amount": 0 } ], "status": "Open", "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "amountDue": 0, "note": "SWRAILWAYSELFSERVE; 17068; General ; V. Shone; Transport fo", "paymentAllocations": [ { "payment": { "id": "12", "accountRef": { "id": "A545" }, "paidOnDate": "2023-01-05T10:44:56.884Z", "totalAmount": 0 }, "allocation": { "allocatedOnDate": "2023-01-05T10:44:56.884Z", "totalAmount": 0 } } ] } }, "Xero": { "value": { "reference": "", "supplierRef": { "id": "1262c350-fe0f-40ec-aeff-41c95b4a45af", "supplierName": "DIISR - Small Business Services" }, "purchaseOrderRefs": [], "issueDate": "2023-04-23T00:00:00", "dueDate": "2023-04-23T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Half day training - Microsoft Office", "unitAmount": 1800, "quantity": 1, "subTotal": 1800, "taxAmount": 360, "totalAmount": 2160, "accountRef": { "id": "46f9461e-788b-4906-8b74-d1ea17f6dc10" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "itemRef": { "id": "489558f5-27b7-4f37-ad9f-d84611c2e2ab" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month.", "unitAmount": 4000, "quantity": 1, "subTotal": 4000, "taxAmount": 800, "totalAmount": 4800, "accountRef": { "id": "f96c9458-d724-47bf-8f74-a9d5726465ce" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "itemRef": { "id": "f8fb7e00-5e5d-466c-aef0-15861f73d04f" }, "trackingCategoryRefs": [], "isDirectCost": false }, { "description": "Stationery charges", "unitAmount": 32, "quantity": 8, "subTotal": 256, "taxAmount": 51.2, "totalAmount": 307.2, "accountRef": { "id": "cba6527d-f102-4538-b421-e483233e9d5a" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [], "isDirectCost": false } ], "withholdingTax": [], "status": "Open", "subTotal": 6056, "taxAmount": 1211.2, "totalAmount": 7267.2, "amountDue": 7267.2 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBillResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create bill* endpoint creates a new [bill](https://docs.codat.io/accounting-api#/schemas/Bill) for a given company's connection.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update bill model](https://docs.codat.io/accounting-api#/operations/get-create-update-bills-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support creating a bill.\n", "operationId": "create-bill" } }, "/companies/{companyId}/connections/{connectionId}/push/bills/{billId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/billId" } ], "put": { "tags": [ "Bills" ], "summary": "Update bill", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/forceUpdate" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bill" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBillResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Update bill* endpoint updates an existing [bill](https://docs.codat.io/accounting-api#/schemas/Bill) for a given company's connection.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update bill model](https://docs.codat.io/accounting-api#/operations/get-create-update-bills-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support creating an account.\n", "operationId": "update-bill" }, "delete": { "summary": "Delete bill", "operationId": "delete-bill", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOperationSummary" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Delete bill* endpoint allows you to delete a specified bill from an accounting software. \n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are itemized records of goods received or services provided to the SMB.\n\n### Process \n1. Pass the `{billId}` to the *Delete bill* endpoint and store the `pushOperationKey` returned.\n2. Check the status of the delete operation by checking the status of the push operation either via\n 1. [Push operation webhook](https://docs.codat.io/introduction/webhooks/core-rules-types#push-operation-status-has-changed) (advised),\n 2. [Push operation status endpoint](https://docs.codat.io/codat-api#/operations/get-push-operation).\n\n A `Success` status indicates that the bill object was deleted from the accounting software.\n3. (Optional) Check that the bill was deleted from the accounting software.\n\n### Effect on related objects\n\nBe aware that deleting a bill from an accounting software might cause related objects to be modified. For example, if you delete a paid bill in QuickBooks Online or QuickBooks Desktop, the bill is deleted but the bill payment against that bill is not. The bill payment is converted to a payment on account.\n\n## Integration specifics\nIntegrations that support soft delete do not permanently delete the object in the accounting software.\n\n| Integration | Soft Delete | Details | \n|-------------|-------------|--------------------------------------------------------------------------------------------------------------|\n| QuickBooks Online | No | - |\n| QuickBooks Desktop | No | - |\n| Oracle NetSuite | No | When deleting a bill that's already linked to a bill payment, you must delete the linked bill payment first. | |\n| Sage Intacct | No | When deleting a bill that's already linked to a bill payment, you must delete the linked bill payment first. |\n| Xero | No | Draft bills will be deleted. Open bills will be voided instead of deleted since Xero only allows voiding a bill once it's been posted. When deleting a bill that's already linked to a bill payment, you must delete the linked bill payment first. |\n\n> **Supported Integrations**\n> \n> This functionality is currently supported for our QuickBooks Online, QuickBooks Desktop, Xero, Oracle NetSuite and Sage Intacct integrations.", "tags": [ "Bills" ] } }, "/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/billId" } ], "get": { "tags": [ "Bills" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentsDataset" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "list-bill-attachments", "summary": "List bill attachments", "description": "The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support listing bill attachments.\n" } }, "/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/billId" } ], "get": { "tags": [ "Bills" ], "parameters": [ { "$ref": "#/components/parameters/attachmentId" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get bill attachment", "description": "The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a bill attachment.\n", "operationId": "get-bill-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}/download": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/billId" } ], "get": { "tags": [ "Bills" ], "parameters": [ { "$ref": "#/components/parameters/attachmentId" } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "title": "Data", "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Download bill attachment", "description": "The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support downloading a bill attachment.\n", "operationId": "download-bill-attachment" } }, "/companies/{companyId}/connections/{connectionId}/push/bills/{billId}/attachments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/billId" } ], "post": { "tags": [ "Bills" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AttachmentUpload" } } } }, "responses": { "200": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Upload bill attachment", "description": "The *Upload bill attachment* endpoint uploads an attachment and assigns it against a specific `billId`.\n\n[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\n**Integration-specific behaviour**\n\nFor more details on supported file types by integration see [Attachments](https://docs.codat.io/accounting-api#/schemas/Attachment).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support uploading a bill attachment.\n", "operationId": "upload-bill-attachment" } }, "/companies/{companyId}/data/creditNotes": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Credit notes" ], "summary": "List credit notes", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNotes" }, "examples": { "Dynamics 365 Business Central": { "value": { "results": [ { "id": "e6e5ec0f-1c60-eb11-89fa-00224800a9c7", "creditNoteNumber": "104001", "customerRef": { "id": "8ddfa6bf-0c60-eb11-89fa-00224800af18", "companyName": "Abdi Company" }, "withholdingTax": [], "totalAmount": 105, "totalDiscount": 0, "subTotal": 100, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 5, "discountPercentage": 0, "remainingCredit": 80, "status": "PartiallyPaid", "issueDate": "2021-01-25T00:00:00", "currency": "GBP", "lineItems": [ { "description": "Invoice No. 103221:", "unitAmount": 0, "quantity": 1, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "accountRef": { "id": "NullId" }, "discountPercentage": 0, "taxRateRef": { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Linda Martin", "unitAmount": 100, "quantity": 1, "discountAmount": 0, "subTotal": 100, "taxAmount": 5, "totalAmount": 105, "accountRef": { "id": "161217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Income, Services" }, "discountPercentage": 0, "taxRateRef": { "id": "61bc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for DOMESTIC / REDUCED", "effectiveTaxRate": 5 }, "itemRef": { "id": "RESC-331317b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC", "name": "Linda Martin / General Business Posting Group: 'DOMESTIC' / VAT Business Posting Group: 'DOMESTIC'" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Credit memo for partially paid inv", "unitAmount": 0, "quantity": 1, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "accountRef": { "id": "NullId" }, "discountPercentage": 0, "taxRateRef": { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "62e5046d-1c60-eb11-89fa-00224800a9c7", "note": "Credit Memo 1001", "reference": "Document No: 104001", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-01-25T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2021-01-25T00:00:00", "totalAmount": 25 } } ], "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2021-01-26T21:21:18Z", "metadata": { "isDeleted": false } }, { "id": "d0d9b378-1d60-eb11-89fa-00224800a9c7", "creditNoteNumber": "104002", "customerRef": { "id": "8ddfa6bf-0c60-eb11-89fa-00224800af18", "companyName": "Abdi Company" }, "withholdingTax": [], "totalAmount": 779.28, "totalDiscount": 0, "subTotal": 649.4, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 129.88, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2021-01-26T00:00:00", "currency": "GBP", "lineItems": [ { "description": "Invoice No. 103222:", "unitAmount": 0, "quantity": 1, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "accountRef": { "id": "NullId" }, "discountPercentage": 0, "taxRateRef": { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Inv. No. 103222 - Shpt. No. 102222:", "unitAmount": 0, "quantity": 1, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "accountRef": { "id": "NullId" }, "discountPercentage": 0, "taxRateRef": { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "ATHENS Desk -pay with CR", "unitAmount": 649.4, "quantity": 1, "discountAmount": 0, "subTotal": 649.4, "taxAmount": 129.88, "totalAmount": 779.28, "accountRef": { "id": "181217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Income, Product Sales" }, "discountPercentage": 0, "taxRateRef": { "id": "63bc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for DOMESTIC / STANDARD", "effectiveTaxRate": 10 }, "itemRef": { "id": "ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC", "name": "ATHENS Desk / General Business Posting Group: 'DOMESTIC' / VAT Business Posting Group: 'DOMESTIC'" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "", "unitAmount": 0, "quantity": 1, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "accountRef": { "id": "NullId" }, "discountPercentage": 0, "taxRateRef": { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "c2942210-1e60-eb11-89fa-00224800a9c7", "note": "Credit Memo 1002", "reference": "Document No: 104002", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-01-26T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2021-01-26T00:00:00", "totalAmount": 779.28 } } ], "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2021-01-26T21:33:01Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 13, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "21952211", "creditNoteNumber": "004", "customerRef": { "id": "6162023", "companyName": "Alderley plc" }, "withholdingTax": [], "totalAmount": 165, "totalDiscount": 0, "subTotal": 165, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2017-10-18T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Reverse 6546", "unitAmount": 110, "quantity": 1.5, "subTotal": 165, "taxAmount": 0, "totalAmount": 165, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "270764400", "note": "�165.00 - Credit Note refund against 004", "currency": "GBP", "paidOnDate": "2020-12-23T00:00:00", "totalAmount": -165 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 165 } } ], "modifiedDate": "2023-04-25T14:19:09Z", "sourceModifiedDate": "2020-12-23T16:39:23Z", "metadata": { "isDeleted": false } }, { "id": "53604300", "creditNoteNumber": "2367", "customerRef": { "id": "6162023", "companyName": "Alderley plc" }, "withholdingTax": [], "totalAmount": 165, "totalDiscount": 0, "subTotal": 165, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 165, "status": "Draft", "issueDate": "2017-10-18T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Reverse 6546", "unitAmount": 110, "quantity": 1.5, "subTotal": 165, "taxAmount": 0, "totalAmount": 165, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "modifiedDate": "2023-04-25T14:19:09Z", "sourceModifiedDate": "2022-09-29T13:00:09Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 281, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "33407", "creditNoteNumber": "0000065", "customerRef": { "id": "511657", "companyName": "Bob's Stationary" }, "withholdingTax": [], "totalAmount": 150, "totalDiscount": 0, "subTotal": 150, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Submitted", "issueDate": "2020-07-31T00:00:00", "currency": "GBP", "lineItems": [ { "description": "Test Di", "unitAmount": 150, "quantity": 1, "subTotal": 150, "taxAmount": 0, "totalAmount": 150, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "2054019", "note": "Free $150 voucher", "currency": "GBP", "paidOnDate": "2020-07-31T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 150 } } ], "modifiedDate": "2023-03-24T16:07:23Z", "note": "Free $150 voucher", "metadata": { "isDeleted": false } }, { "id": "33409", "creditNoteNumber": "0000066", "customerRef": { "id": "511657", "companyName": "Bob's Stationary" }, "withholdingTax": [], "totalAmount": 300, "totalDiscount": 0, "subTotal": 300, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Draft", "issueDate": "2020-07-31T00:00:00", "currency": "GBP", "lineItems": [ { "description": "Test Di", "unitAmount": 150, "quantity": 2, "subTotal": 300, "taxAmount": 0, "totalAmount": 300, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "2054021", "note": "Free $150 voucher", "currency": "GBP", "paidOnDate": "2020-07-31T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 300 } } ], "modifiedDate": "2023-03-24T16:07:23Z", "note": "Free $150 voucher", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 53, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes?page=2&pageSize=2" } } } }, "KashFlow": { "value": { "results": [ { "id": "85322315", "creditNoteNumber": "4", "customerRef": { "id": "69946501", "companyName": "Peter Lord" }, "withholdingTax": [], "totalAmount": 100, "totalDiscount": 0, "subTotal": 0, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2017-05-09T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "youm", "unitAmount": 100, "quantity": -1, "subTotal": -100, "taxAmount": 0, "totalAmount": 100, "accountRef": { "id": "21481817", "name": "Sale of goods" }, "itemRef": { "id": "158667064" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "86870120", "note": "Applying Credit Note", "currency": "GBP", "paidOnDate": "2017-05-09T00:00:00", "totalAmount": -100 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 100 } } ], "modifiedDate": "2022-09-30T10:29:16Z" }, { "id": "85326016", "creditNoteNumber": "5", "customerRef": { "id": "69952389", "companyName": "Things Limited" }, "withholdingTax": [], "totalAmount": 1000, "totalDiscount": 0, "subTotal": 0, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2017-05-09T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "158675173", "unitAmount": 1, "quantity": -1000, "subTotal": -1000, "taxAmount": 0, "totalAmount": 1000, "accountRef": { "id": "21481817", "name": "Sale of goods" }, "itemRef": { "id": "158675173" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "86873915", "note": "Applying Credit Note", "currency": "GBP", "paidOnDate": "2017-05-09T00:00:00", "totalAmount": -400 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 400 } }, { "payment": { "id": "86874181", "note": "", "currency": "GBP", "paidOnDate": "2017-05-09T00:00:00", "totalAmount": -100 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 100 } }, { "payment": { "id": "86874199", "note": "", "currency": "GBP", "paidOnDate": "2017-05-09T00:00:00", "totalAmount": -50 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 50 } }, { "payment": { "id": "86875655", "note": "Credit Note", "currency": "GBP", "paidOnDate": "2017-05-09T00:00:00", "totalAmount": -750 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 750 } } ], "modifiedDate": "2022-09-30T10:29:16Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 17, "_links": { "current": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes" }, "next": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "8827", "creditNoteNumber": "CM27", "customerRef": { "id": "417", "companyName": "10 Breww Ltd" }, "withholdingTax": [], "totalAmount": 26, "totalDiscount": 0, "subTotal": 26, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 26, "status": "Submitted", "issueDate": "2021-04-09T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Andy Test Item", "unitAmount": 2, "quantity": 3, "subTotal": 6, "totalAmount": 6, "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "143", "name": "Andy Test Item" }, "trackingCategoryRefs": [ { "id": "classification-2" }, { "id": "department-1" }, { "id": "location-1" } ], "isDirectIncome": false }, { "description": "Non-Recurring Services - EC", "unitAmount": 4, "quantity": 5, "subTotal": 20, "totalAmount": 20, "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "28", "name": "Non-Recurring Services - EC" }, "trackingCategoryRefs": [ { "id": "classification-2" }, { "id": "department-1" }, { "id": "location-1" } ], "isDirectIncome": false } ], "paymentAllocations": [], "modifiedDate": "2022-09-20T08:15:31Z", "sourceModifiedDate": "2022-02-25T10:58:10" }, { "id": "8828", "creditNoteNumber": "CM28", "customerRef": { "id": "417", "companyName": "10 Breww Ltd" }, "withholdingTax": [], "totalAmount": 26, "totalDiscount": 0, "subTotal": 26, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 10, "status": "PartiallyPaid", "issueDate": "2021-04-09T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Andy Test Item", "unitAmount": 2, "quantity": 3, "subTotal": 6, "totalAmount": 6, "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "143", "name": "Andy Test Item" }, "trackingCategoryRefs": [ { "id": "classification-2" }, { "id": "department-1" }, { "id": "location-1" } ], "isDirectIncome": false }, { "description": "Non-Recurring Services - EC", "unitAmount": 4, "quantity": 5, "subTotal": 20, "totalAmount": 20, "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "28", "name": "Non-Recurring Services - EC" }, "trackingCategoryRefs": [ { "id": "classification-2" }, { "id": "department-1" }, { "id": "location-1" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "8828", "reference": "Credit Memo #CM28", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-04-09T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 16 } } ], "modifiedDate": "2022-09-20T08:15:31Z", "sourceModifiedDate": "2022-02-25T10:58:37" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 36, "_links": { "current": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes" }, "next": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "96C-933372931", "creditNoteNumber": "4002", "customerRef": { "id": "150000-933272658", "companyName": "Abercrombie, Kristy" }, "withholdingTax": [], "totalAmount": 711.15, "totalDiscount": 0, "subTotal": 660, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 51.15, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2024-12-01T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Whirlpool tub\nBilled and paid for 2 tubs, should have been for only 1 tub", "unitAmount": 660, "quantity": 1, "subTotal": 660, "taxAmount": 0, "totalAmount": 660, "accountRef": { "id": "40000-933270541", "name": "Accounts Receivable" }, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "1E0000-933272656", "name": "Plumb Fixtrs" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "969-933372844", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2024-12-01T00:00:00", "totalAmount": -711.15 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 711.15 } } ], "modifiedDate": "2023-04-26T09:07:38Z", "sourceModifiedDate": "2023-12-16T05:04:05", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/creditNotes" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "85", "creditNoteNumber": "3122019_6", "customerRef": { "id": "3", "companyName": "Information Sharing Technology" }, "withholdingTax": [], "totalAmount": 13.53, "totalDiscount": 0, "subTotal": 13.53, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2019-12-03T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Refunds with payment type of Cash", "unitAmount": 13.53, "quantity": 1, "subTotal": 13.53, "taxAmount": 0, "totalAmount": 13.53, "accountRef": { "id": "1", "name": "Sales" }, "taxRateRef": { "id": "8_Invoices", "name": "Exempt Invoices", "effectiveTaxRate": 0 }, "itemRef": { "id": "1", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": true } ], "paymentAllocations": [ { "payment": { "id": "85", "note": "", "accountRef": { "id": "63", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2019-12-03T00:00:00", "totalAmount": -13.53 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2019-12-03T00:00:00", "totalAmount": 13.53 } } ], "modifiedDate": "2023-01-18T11:02:55Z", "sourceModifiedDate": "2019-12-10T19:00:36Z" }, { "id": "86", "creditNoteNumber": "3122019_66", "customerRef": { "id": "3", "companyName": "Information Sharing Technology" }, "withholdingTax": [], "totalAmount": 1, "totalDiscount": 0, "subTotal": 1, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2019-12-03T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Refunds with payment type of Card", "unitAmount": 1, "quantity": 1, "subTotal": 1, "taxAmount": 0, "totalAmount": 1, "accountRef": { "id": "1", "name": "Sales" }, "taxRateRef": { "id": "8_Invoices", "name": "Exempt Invoices", "effectiveTaxRate": 0 }, "itemRef": { "id": "1", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": true } ], "paymentAllocations": [ { "payment": { "id": "86", "note": "", "accountRef": { "id": "63", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2019-12-03T00:00:00", "totalAmount": -1 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2019-12-03T00:00:00", "totalAmount": 1 } } ], "modifiedDate": "2023-01-18T11:02:55Z", "sourceModifiedDate": "2019-12-10T19:00:37Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1253, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "185", "creditNoteNumber": "1015", "customerRef": { "id": "16", "companyName": "Jordan Burgess" }, "withholdingTax": [], "totalAmount": 1800, "totalDiscount": 0, "subTotal": 1500, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 300, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2017-02-15T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Employee training off site", "unitAmount": 1500, "quantity": 1, "subTotal": 1500, "taxAmount": 300, "totalAmount": 1800, "accountRef": { "id": "44", "name": "Sales" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 }, "itemRef": { "id": "5", "name": "Employee Training" }, "trackingCategoryRefs": [ { "id": "DEPARTMENT_1", "name": "London" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "192", "note": "Created by QB Online to link credits to charges.", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2017-09-08T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 1800 } } ], "modifiedDate": "2023-04-26T09:36:03Z", "sourceModifiedDate": "2017-09-08T12:52:27Z", "metadata": { "isDeleted": false } }, { "id": "213", "creditNoteNumber": "1030", "customerRef": { "id": "5", "companyName": "Whitehead and Sons" }, "withholdingTax": [], "totalAmount": 600, "totalDiscount": 0, "subTotal": 500, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 100, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2018-12-18T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Employee celebration -- Anniversary / Retirement", "unitAmount": 500, "quantity": 1, "subTotal": 500, "taxAmount": 100, "totalAmount": 600, "accountRef": { "id": "44", "name": "Sales" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 }, "itemRef": { "id": "4", "name": "Employee Celebration" }, "trackingCategoryRefs": [ { "id": "DEPARTMENT_3", "name": "Birmingham" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "215", "note": "Created by QB Online to link credits to charges.", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-12-18T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 600 } } ], "modifiedDate": "2023-04-26T09:36:03Z", "sourceModifiedDate": "2018-12-18T10:08:45Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 141, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "45891", "creditNoteNumber": "return 1a", "customerRef": { "id": "A1D001", "companyName": "A1 Design Services" }, "withholdingTax": [], "totalAmount": 378, "totalDiscount": 9.46, "subTotal": 315, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 63, "discountPercentage": 2.5, "remainingCredit": 378, "status": "Submitted", "issueDate": "2020-07-22T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Tax Summary - Standard rate", "unitAmount": 0, "quantity": 0, "discountAmount": 1.58, "subTotal": 0, "taxAmount": 63, "totalAmount": 63, "taxRateRef": { "id": "1" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Goods Summary", "unitAmount": 0, "quantity": 0, "discountAmount": 9.46, "subTotal": 315, "taxAmount": 0, "totalAmount": 315, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "modifiedDate": "2022-10-14T09:35:55Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "note": "black" }, { "id": "45901", "creditNoteNumber": "return 003", "customerRef": { "id": "ABS001", "companyName": "ABS Garages Ltd" }, "withholdingTax": [], "totalAmount": 177.14, "totalDiscount": 4.42, "subTotal": 147.62, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 29.52, "discountPercentage": 2.5, "remainingCredit": 177.14, "status": "Submitted", "issueDate": "2020-07-22T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Tax Summary - Standard rate", "unitAmount": 0, "quantity": 0, "discountAmount": 0.73, "subTotal": 0, "taxAmount": 29.52, "totalAmount": 29.52, "taxRateRef": { "id": "1" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Goods Summary", "unitAmount": 0, "quantity": 0, "discountAmount": 4.42, "subTotal": 147.62, "taxAmount": 0, "totalAmount": 147.62, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "modifiedDate": "2022-10-14T09:35:55Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "note": "cred 003" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 26, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "INV-17", "creditNoteNumber": "17", "customerRef": { "id": "KIN001", "companyName": "Kinghorn & French" }, "withholdingTax": [], "totalAmount": 832.84, "totalDiscount": 0, "subTotal": 711.45, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 121.39, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2021-02-02T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "PC Combo Pack 4", "unitAmount": 832.84, "quantity": 1, "subTotal": 711.45, "taxAmount": 121.39, "totalAmount": 832.84, "accountRef": { "id": "4000", "name": "Sales North" }, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "336", "note": "Sales credit inv-17 linked to sales invoice inv-45.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 63.69 } }, { "payment": { "id": "336", "note": "Sales credit inv-17 linked to sales invoice inv-45.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 73.49 } }, { "payment": { "id": "336", "note": "Sales credit inv-17 linked to sales invoice inv-45.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 157.25 } }, { "payment": { "id": "336", "note": "Sales credit inv-17 linked to sales invoice inv-45.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 158.25 } }, { "payment": { "id": "336", "note": "Sales credit inv-17 linked to sales invoice inv-45.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 344.89 } }, { "payment": { "id": "336", "note": "Sales credit inv-17 linked to sales invoice inv-45.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 35.27 } } ], "modifiedDate": "2023-03-30T14:42:43Z", "sourceModifiedDate": "2022-11-25T09:43:54", "note": "PC Combo Pack 4", "metadata": { "isDeleted": false } }, { "id": "INV-34", "creditNoteNumber": "34", "customerRef": { "id": "MIL001", "companyName": "Mile Road Health Centre" }, "withholdingTax": [], "totalAmount": 1668.14, "totalDiscount": 0, "subTotal": 1425, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 243.14, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2021-02-28T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "PC Combo Pack 6", "unitAmount": 1668.14, "quantity": 1, "subTotal": 1425, "taxAmount": 243.14, "totalAmount": 1668.14, "accountRef": { "id": "4000", "name": "Sales North" }, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "530", "note": "Sales credit inv-34 linked to sales invoice inv-26.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-28T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 1668.14 } } ], "modifiedDate": "2023-03-30T14:42:43Z", "sourceModifiedDate": "2022-11-25T09:43:54", "note": "PC Combo Pack 6", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 7, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "c1a0176c33de11e797950a57719b2edb", "creditNoteNumber": "SCN-1", "customerRef": { "id": "f4ff85ba33dd11e797950a57719b2edb", "companyName": "Widgets Limited" }, "withholdingTax": [], "totalAmount": 1080, "totalDiscount": 0, "subTotal": 900, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 180, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2017-05-08T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Consulting services", "unitAmount": 900, "quantity": 1, "discountAmount": 0, "subTotal": 900, "taxAmount": 180, "totalAmount": 1080, "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" }, "discountPercentage": 0, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 }, "itemRef": { "id": "a87b922b33de11e797950a57719b2edb", "name": "Consulting services" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "d39f7a5733de11e797950a57719b2edb", "note": "Customer refund using credit/debit card", "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2017-05-08T00:00:00", "totalAmount": -1080 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 1080 } } ], "modifiedDate": "2022-10-24T14:55:35Z", "sourceModifiedDate": "2017-05-08T11:09:38Z", "note": "" }, { "id": "28a459069a6211e8bad90617b3da4b8a", "creditNoteNumber": "SCN-3", "customerRef": { "id": "f4ff85ba33dd11e797950a57719b2edb", "companyName": "Widgets Limited" }, "withholdingTax": [], "totalAmount": 5400, "totalDiscount": 0, "subTotal": 4500, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 900, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2018-08-07T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Consulting services", "unitAmount": 900, "quantity": 5, "discountAmount": 0, "subTotal": 4500, "taxAmount": 900, "totalAmount": 5400, "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" }, "discountPercentage": 0, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 }, "itemRef": { "id": "a87b922b33de11e797950a57719b2edb", "name": "Consulting services" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "28a459069a6211e8bad90617b3da4b8a", "note": "Sales credit note", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-08-07T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 5400 } } ], "modifiedDate": "2022-10-24T14:55:35Z", "sourceModifiedDate": "2018-08-07T16:51:41Z", "note": "" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2972, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "5018", "creditNoteNumber": "IN0545", "customerRef": { "id": "53", "companyName": "Pacificorp" }, "withholdingTax": [], "totalAmount": 575, "totalDiscount": 0, "subTotal": 500, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 75, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2022-03-16T00:00:00", "allocatedOnDate": "2022-03-16T00:00:00", "currency": "ZAR", "lineItems": [ { "description": "No Description Provided", "unitAmount": 500, "quantity": 1, "subTotal": 500, "taxAmount": 75, "totalAmount": 575, "accountRef": { "id": "2", "name": "Accounts Receivable" }, "taxRateRef": { "id": "27", "name": "Standard Rate Output", "effectiveTaxRate": 15 }, "trackingCategoryRefs": [ { "id": "LOCATION-10", "name": "South Africa" }, { "id": "DEPARTMENT-2", "name": "Services" }, { "id": "CUSTOMER-53", "name": "Pacificorp" } ], "isDirectIncome": false } ], "paymentAllocations": [], "modifiedDate": "2023-02-23T14:21:40Z", "sourceModifiedDate": "2022-03-16T12:27:43Z", "note": "", "metadata": { "isDeleted": false } }, { "id": "5020", "creditNoteNumber": "ARADJ0034", "customerRef": { "id": "53", "companyName": "Pacificorp" }, "withholdingTax": [], "totalAmount": 115, "totalDiscount": 0, "subTotal": 100, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 15, "discountPercentage": 0, "remainingCredit": 115, "status": "Submitted", "issueDate": "2022-03-16T00:00:00", "currency": "ZAR", "currencyRate": 1, "lineItems": [ { "description": "No Description Provided", "unitAmount": 100, "quantity": 1, "subTotal": 100, "taxAmount": 15, "totalAmount": 115, "accountRef": { "id": "2", "name": "Accounts Receivable" }, "taxRateRef": { "id": "28", "name": "Standard Rate (Capital Goods) Output", "effectiveTaxRate": 15 }, "trackingCategoryRefs": [ { "id": "LOCATION-10", "name": "South Africa" }, { "id": "CUSTOMER-53", "name": "Pacificorp" } ], "isDirectIncome": false } ], "paymentAllocations": [], "modifiedDate": "2023-02-23T14:21:40Z", "sourceModifiedDate": "2022-03-16T12:30:19", "note": "", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2, "_links": { "current": { "href": "/companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/data/creditNotes" } } } }, "Xero": { "value": { "results": [ { "id": "47fb825b-3c43-4284-905f-c6d97acc6b37", "creditNoteNumber": "CN-0025", "customerRef": { "id": "af0091a9-82ef-4cac-9fd6-22c095ac6a58", "companyName": "Hamilton Smith Ltd" }, "withholdingTax": [], "totalAmount": 541.25, "totalDiscount": 0, "subTotal": 451.04, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 90.21, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2022-11-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "FULL CREDIT of INV-0016 due to duplication of invoice INV-0012. Please accept our apologies.", "unitAmount": 0, "quantity": 0, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "discountPercentage": 0, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month.", "unitAmount": 451.04, "quantity": 1, "discountAmount": 0, "subTotal": 451.04, "taxAmount": 90.21, "totalAmount": 541.25, "accountRef": { "id": "c563b607-fb0e-4d06-9ddb-76fdeef20ae3", "name": "Sales" }, "discountPercentage": 0, "taxRateRef": { "id": "OUTPUT2", "name": "20% (VAT on Income)", "effectiveTaxRate": 20 }, "itemRef": { "id": "f8fb7e00-5e5d-466c-aef0-15861f73d04f", "name": "Desktop/network support via email & phone" }, "trackingCategoryRefs": [ { "id": "34b9b859-07a9-451a-b4d3-effc9946634a", "name": "North" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "47fb825b-3c43-4284-905f-c6d97acc6b37", "reference": "Monthly Support", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-11-20T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-11-20T00:00:00", "totalAmount": 541.25 } } ], "modifiedDate": "2023-03-15T20:35:09Z", "sourceModifiedDate": "2011-04-07T00:34:38", "metadata": { "isDeleted": false } }, { "id": "caba470e-962f-4168-9c57-35caa289204d", "creditNoteNumber": "CN-0026", "customerRef": { "id": "9ce626d2-14ea-463c-9fff-6785ab5f9bfb", "companyName": "Boom FM" }, "withholdingTax": [], "totalAmount": 500, "totalDiscount": 0, "subTotal": 416.67, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 83.33, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2023-01-13T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "CREDIT Half day training - Microsoft Office and include in suite of training\r\nINV-0024", "unitAmount": 416.67, "quantity": 1, "discountAmount": 0, "subTotal": 416.67, "taxAmount": 83.33, "totalAmount": 500, "accountRef": { "id": "c563b607-fb0e-4d06-9ddb-76fdeef20ae3", "name": "Sales" }, "discountPercentage": 0, "taxRateRef": { "id": "OUTPUT2", "name": "20% (VAT on Income)", "effectiveTaxRate": 20 }, "itemRef": { "id": "489558f5-27b7-4f37-ad9f-d84611c2e2ab", "name": "Half day training - Microsoft Office" }, "trackingCategoryRefs": [ { "id": "b3900cc6-3745-40ea-955f-9ef7b1c8cf7e", "name": "South" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "caba470e-962f-4168-9c57-35caa289204d", "reference": "Training", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-01-13T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2023-01-13T00:00:00", "totalAmount": 500 } } ], "modifiedDate": "2023-03-15T20:35:09Z", "sourceModifiedDate": "2011-04-07T02:47:04", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 3, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000129002", "creditNoteNumber": "CN-00001", "customerRef": { "id": "104957000000037097", "companyName": "Test Company" }, "withholdingTax": [], "totalAmount": 9001, "totalDiscount": 0, "subTotal": 0, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 9001, "status": "Draft", "issueDate": "2020-04-28T18:16:22", "currency": "GBP", "lineItems": [], "paymentAllocations": [], "modifiedDate": "2022-10-03T08:40:43Z", "sourceModifiedDate": "2020-04-28T18:16:22" }, { "id": "104957000000134023", "creditNoteNumber": "CN-00002", "customerRef": { "id": "104957000000054050", "companyName": "Doe, John" }, "withholdingTax": [], "totalAmount": 125, "totalDiscount": 0, "subTotal": 0, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2020-05-06T13:04:20", "currency": "GBP", "lineItems": [], "paymentAllocations": [ { "payment": { "id": "104957000000134039", "currency": "GBP", "paidOnDate": "2020-05-06T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 125 } } ], "modifiedDate": "2022-10-03T08:40:43Z", "sourceModifiedDate": "2020-05-06T13:05:27" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 12, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) for a given company's connection.\n\n[Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-credit-notes" } }, "/companies/{companyId}/data/creditNotes/{creditNoteId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/creditNoteId" } ], "get": { "tags": [ "Credit notes" ], "summary": "Get credit note", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" }, "examples": { "Dynamics 365 Business Central": { "value": { "id": "e6e5ec0f-1c60-eb11-89fa-00224800a9c7", "creditNoteNumber": "104001", "customerRef": { "id": "8ddfa6bf-0c60-eb11-89fa-00224800af18", "companyName": "Abdi Company" }, "withholdingTax": [], "totalAmount": 105, "totalDiscount": 0, "subTotal": 100, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 5, "discountPercentage": 0, "remainingCredit": 80, "status": "PartiallyPaid", "issueDate": "2021-01-25T00:00:00", "currency": "GBP", "lineItems": [ { "description": "Invoice No. 103221:", "unitAmount": 0, "quantity": 1, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "accountRef": { "id": "NullId" }, "discountPercentage": 0, "taxRateRef": { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Linda Martin", "unitAmount": 100, "quantity": 1, "discountAmount": 0, "subTotal": 100, "taxAmount": 5, "totalAmount": 105, "accountRef": { "id": "161217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Income, Services" }, "discountPercentage": 0, "taxRateRef": { "id": "61bc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for DOMESTIC / REDUCED", "effectiveTaxRate": 5 }, "itemRef": { "id": "RESC-331317b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC", "name": "Linda Martin / General Business Posting Group: 'DOMESTIC' / VAT Business Posting Group: 'DOMESTIC'" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Credit memo for partially paid inv", "unitAmount": 0, "quantity": 1, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "accountRef": { "id": "NullId" }, "discountPercentage": 0, "taxRateRef": { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "62e5046d-1c60-eb11-89fa-00224800a9c7", "note": "Credit Memo 1001", "reference": "Document No: 104001", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-01-25T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2021-01-25T00:00:00", "totalAmount": 25 } } ], "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2021-01-26T21:21:18Z", "metadata": { "isDeleted": false } } }, "FreeAgent": { "value": { "id": "21952211", "creditNoteNumber": "004", "customerRef": { "id": "6162023", "companyName": "Alderley plc" }, "withholdingTax": [], "totalAmount": 165, "totalDiscount": 0, "subTotal": 165, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2017-10-18T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Reverse 6546", "unitAmount": 110, "quantity": 1.5, "subTotal": 165, "taxAmount": 0, "totalAmount": 165, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "270764400", "note": "�165.00 - Credit Note refund against 004", "currency": "GBP", "paidOnDate": "2020-12-23T00:00:00", "totalAmount": -165 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 165 } } ], "modifiedDate": "2023-04-25T14:19:09Z", "sourceModifiedDate": "2020-12-23T16:39:23Z", "metadata": { "isDeleted": false } } }, "FreshBooks": { "value": { "id": "33407", "creditNoteNumber": "0000065", "customerRef": { "id": "511657", "companyName": "Bob's Stationary" }, "withholdingTax": [], "totalAmount": 150, "totalDiscount": 0, "subTotal": 150, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Submitted", "issueDate": "2020-07-31T00:00:00", "currency": "GBP", "lineItems": [ { "description": "Test Di", "unitAmount": 150, "quantity": 1, "subTotal": 150, "taxAmount": 0, "totalAmount": 150, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "2054019", "note": "Free $150 voucher", "currency": "GBP", "paidOnDate": "2020-07-31T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 150 } } ], "modifiedDate": "2023-03-24T16:07:23Z", "note": "Free $150 voucher", "metadata": { "isDeleted": false } } }, "KashFlow": { "value": { "id": "85322315", "creditNoteNumber": "4", "customerRef": { "id": "69946501", "companyName": "Peter Lord" }, "withholdingTax": [], "totalAmount": 100, "totalDiscount": 0, "subTotal": 0, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2017-05-09T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "youm", "unitAmount": 100, "quantity": -1, "subTotal": -100, "taxAmount": 0, "totalAmount": 100, "accountRef": { "id": "21481817", "name": "Sale of goods" }, "itemRef": { "id": "158667064" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "86870120", "note": "Applying Credit Note", "currency": "GBP", "paidOnDate": "2017-05-09T00:00:00", "totalAmount": -100 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 100 } } ], "modifiedDate": "2022-09-30T10:29:16Z" } }, "Oracle NetSuite": { "value": { "id": "8827", "creditNoteNumber": "CM27", "customerRef": { "id": "417", "companyName": "10 Breww Ltd" }, "withholdingTax": [], "totalAmount": 26, "totalDiscount": 0, "subTotal": 26, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 26, "status": "Submitted", "issueDate": "2021-04-09T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Andy Test Item", "unitAmount": 2, "quantity": 3, "subTotal": 6, "totalAmount": 6, "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "143", "name": "Andy Test Item" }, "trackingCategoryRefs": [ { "id": "classification-2" }, { "id": "department-1" }, { "id": "location-1" } ], "isDirectIncome": false }, { "description": "Non-Recurring Services - EC", "unitAmount": 4, "quantity": 5, "subTotal": 20, "totalAmount": 20, "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "28", "name": "Non-Recurring Services - EC" }, "trackingCategoryRefs": [ { "id": "classification-2" }, { "id": "department-1" }, { "id": "location-1" } ], "isDirectIncome": false } ], "paymentAllocations": [], "modifiedDate": "2022-09-20T08:15:31Z", "sourceModifiedDate": "2022-02-25T10:58:10" } }, "QuickBooks Desktop": { "value": { "id": "96C-933372931", "creditNoteNumber": "4002", "customerRef": { "id": "150000-933272658", "companyName": "Abercrombie, Kristy" }, "withholdingTax": [], "totalAmount": 711.15, "totalDiscount": 0, "subTotal": 660, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 51.15, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2024-12-01T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Whirlpool tub\nBilled and paid for 2 tubs, should have been for only 1 tub", "unitAmount": 660, "quantity": 1, "subTotal": 660, "taxAmount": 0, "totalAmount": 660, "accountRef": { "id": "40000-933270541", "name": "Accounts Receivable" }, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "1E0000-933272656", "name": "Plumb Fixtrs" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "969-933372844", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2024-12-01T00:00:00", "totalAmount": -711.15 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 711.15 } } ], "modifiedDate": "2023-04-26T09:07:38Z", "sourceModifiedDate": "2023-12-16T05:04:05", "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "85", "creditNoteNumber": "3122019_6", "customerRef": { "id": "3", "companyName": "Information Sharing Technology" }, "withholdingTax": [], "totalAmount": 13.53, "totalDiscount": 0, "subTotal": 13.53, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2019-12-03T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Refunds with payment type of Cash", "unitAmount": 13.53, "quantity": 1, "subTotal": 13.53, "taxAmount": 0, "totalAmount": 13.53, "accountRef": { "id": "1", "name": "Sales" }, "taxRateRef": { "id": "8_Invoices", "name": "Exempt Invoices", "effectiveTaxRate": 0 }, "itemRef": { "id": "1", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": true } ], "paymentAllocations": [ { "payment": { "id": "85", "note": "", "accountRef": { "id": "63", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2019-12-03T00:00:00", "totalAmount": -13.53 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2019-12-03T00:00:00", "totalAmount": 13.53 } } ], "modifiedDate": "2023-01-18T11:02:55Z", "sourceModifiedDate": "2019-12-10T19:00:36Z" } }, "QuickBooks Online Sandbox": { "value": { "id": "185", "creditNoteNumber": "1015", "customerRef": { "id": "16", "companyName": "Jordan Burgess" }, "withholdingTax": [], "totalAmount": 1800, "totalDiscount": 0, "subTotal": 1500, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 300, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2017-02-15T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Employee training off site", "unitAmount": 1500, "quantity": 1, "subTotal": 1500, "taxAmount": 300, "totalAmount": 1800, "accountRef": { "id": "44", "name": "Sales" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 }, "itemRef": { "id": "5", "name": "Employee Training" }, "trackingCategoryRefs": [ { "id": "DEPARTMENT_1", "name": "London" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "192", "note": "Created by QB Online to link credits to charges.", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2017-09-08T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 1800 } } ], "modifiedDate": "2023-04-26T09:36:03Z", "sourceModifiedDate": "2017-09-08T12:52:27Z", "metadata": { "isDeleted": false } } }, "Sage 200cloud": { "value": { "id": "45891", "creditNoteNumber": "return 1a", "customerRef": { "id": "A1D001", "companyName": "A1 Design Services" }, "withholdingTax": [], "totalAmount": 378, "totalDiscount": 9.46, "subTotal": 315, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 63, "discountPercentage": 2.5, "remainingCredit": 378, "status": "Submitted", "issueDate": "2020-07-22T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Tax Summary - Standard rate", "unitAmount": 0, "quantity": 0, "discountAmount": 1.58, "subTotal": 0, "taxAmount": 63, "totalAmount": 63, "taxRateRef": { "id": "1" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Goods Summary", "unitAmount": 0, "quantity": 0, "discountAmount": 9.46, "subTotal": 315, "taxAmount": 0, "totalAmount": 315, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "modifiedDate": "2022-10-14T09:35:55Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "note": "black" } }, "Sage 50 (UK)": { "value": { "id": "INV-17", "creditNoteNumber": "17", "customerRef": { "id": "KIN001", "companyName": "Kinghorn & French" }, "withholdingTax": [], "totalAmount": 832.84, "totalDiscount": 0, "subTotal": 711.45, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 121.39, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2021-02-02T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "PC Combo Pack 4", "unitAmount": 832.84, "quantity": 1, "subTotal": 711.45, "taxAmount": 121.39, "totalAmount": 832.84, "accountRef": { "id": "4000", "name": "Sales North" }, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "336", "note": "Sales credit inv-17 linked to sales invoice inv-45.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 35.27 } }, { "payment": { "id": "336", "note": "Sales credit inv-17 linked to sales invoice inv-45.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 344.89 } }, { "payment": { "id": "336", "note": "Sales credit inv-17 linked to sales invoice inv-45.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 158.25 } }, { "payment": { "id": "336", "note": "Sales credit inv-17 linked to sales invoice inv-45.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 157.25 } }, { "payment": { "id": "336", "note": "Sales credit inv-17 linked to sales invoice inv-45.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 73.49 } }, { "payment": { "id": "336", "note": "Sales credit inv-17 linked to sales invoice inv-45.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-02T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 63.69 } } ], "modifiedDate": "2023-03-30T14:42:43Z", "sourceModifiedDate": "2022-11-25T09:43:54", "note": "PC Combo Pack 4", "metadata": { "isDeleted": false } } }, "Sage Business Cloud Accounting": { "value": { "id": "c1a0176c33de11e797950a57719b2edb", "creditNoteNumber": "SCN-1", "customerRef": { "id": "f4ff85ba33dd11e797950a57719b2edb", "companyName": "Widgets Limited" }, "withholdingTax": [], "totalAmount": 1080, "totalDiscount": 0, "subTotal": 900, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 180, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2017-05-08T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Consulting services", "unitAmount": 900, "quantity": 1, "discountAmount": 0, "subTotal": 900, "taxAmount": 180, "totalAmount": 1080, "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" }, "discountPercentage": 0, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 }, "itemRef": { "id": "a87b922b33de11e797950a57719b2edb", "name": "Consulting services" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "d39f7a5733de11e797950a57719b2edb", "note": "Customer refund using credit/debit card", "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2017-05-08T00:00:00", "totalAmount": -1080 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": 1080 } } ], "modifiedDate": "2022-10-24T14:55:35Z", "sourceModifiedDate": "2017-05-08T11:09:38Z", "note": "" } }, "Sage Intacct": { "value": { "id": "5018", "creditNoteNumber": "IN0545", "customerRef": { "id": "53", "companyName": "Pacificorp" }, "withholdingTax": [], "totalAmount": 575, "totalDiscount": 0, "subTotal": 500, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 75, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2022-03-16T00:00:00", "allocatedOnDate": "2022-03-16T00:00:00", "currency": "ZAR", "lineItems": [ { "description": "No Description Provided", "unitAmount": 500, "quantity": 1, "subTotal": 500, "taxAmount": 75, "totalAmount": 575, "accountRef": { "id": "2", "name": "Accounts Receivable" }, "taxRateRef": { "id": "27", "name": "Standard Rate Output", "effectiveTaxRate": 15 }, "trackingCategoryRefs": [ { "id": "DEPARTMENT-2", "name": "Services" }, { "id": "CUSTOMER-53", "name": "Pacificorp" }, { "id": "LOCATION-10", "name": "South Africa" } ], "isDirectIncome": false } ], "paymentAllocations": [], "modifiedDate": "2023-02-23T14:21:40Z", "sourceModifiedDate": "2022-03-16T12:27:43Z", "note": "", "metadata": { "isDeleted": false } } }, "Xero": { "value": { "id": "47fb825b-3c43-4284-905f-c6d97acc6b37", "creditNoteNumber": "CN-0025", "customerRef": { "id": "af0091a9-82ef-4cac-9fd6-22c095ac6a58", "companyName": "Hamilton Smith Ltd" }, "withholdingTax": [], "totalAmount": 541.25, "totalDiscount": 0, "subTotal": 451.04, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 90.21, "discountPercentage": 0, "remainingCredit": 0, "status": "Paid", "issueDate": "2022-11-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "FULL CREDIT of INV-0016 due to duplication of invoice INV-0012. Please accept our apologies.", "unitAmount": 0, "quantity": 0, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "discountPercentage": 0, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month.", "unitAmount": 451.04, "quantity": 1, "discountAmount": 0, "subTotal": 451.04, "taxAmount": 90.21, "totalAmount": 541.25, "accountRef": { "id": "c563b607-fb0e-4d06-9ddb-76fdeef20ae3", "name": "Sales" }, "discountPercentage": 0, "taxRateRef": { "id": "OUTPUT2", "name": "20% (VAT on Income)", "effectiveTaxRate": 20 }, "itemRef": { "id": "f8fb7e00-5e5d-466c-aef0-15861f73d04f", "name": "Desktop/network support via email & phone" }, "trackingCategoryRefs": [ { "id": "34b9b859-07a9-451a-b4d3-effc9946634a", "name": "North" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "47fb825b-3c43-4284-905f-c6d97acc6b37", "reference": "Monthly Support", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-11-20T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-11-20T00:00:00", "totalAmount": 541.25 } } ], "modifiedDate": "2023-03-15T20:35:09Z", "sourceModifiedDate": "2011-04-07T00:34:38", "metadata": { "isDeleted": false } } }, "Zoho Books": { "value": { "id": "104957000000129002", "creditNoteNumber": "CN-00001", "customerRef": { "id": "104957000000037097", "companyName": "Test Company" }, "withholdingTax": [], "totalAmount": 9001, "totalDiscount": 0, "subTotal": 0, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 9001, "status": "Draft", "issueDate": "2020-04-28T18:16:22", "currency": "GBP", "lineItems": [], "paymentAllocations": [], "modifiedDate": "2022-10-03T08:40:43Z", "sourceModifiedDate": "2020-04-28T18:16:22" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get credit note* endpoint returns a single credit note for a given creditNoteId.\n\n[Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes) for integrations that support getting a specific credit note.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-credit-note" } }, "/companies/{companyId}/connections/{connectionId}/options/creditNotes": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create/update credit note model", "tags": [ "Credit notes" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "FreeAgent": { "value": { "type": "Object", "displayName": "Accounts Receivable Credit Note", "description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the credit note has been issued to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "options": [ { "value": "AED", "type": "String", "displayName": "AED", "required": false }, { "value": "AMD", "type": "String", "displayName": "AMD", "required": false }, { "value": "AOA", "type": "String", "displayName": "AOA", "required": false }, { "value": "ARS", "type": "String", "displayName": "ARS", "required": false }, { "value": "AUD", "type": "String", "displayName": "AUD", "required": false }, { "value": "AWG", "type": "String", "displayName": "AWG", "required": false }, { "value": "AZN", "type": "String", "displayName": "AZN", "required": false }, { "value": "BBD", "type": "String", "displayName": "BBD", "required": false }, { "value": "BDT", "type": "String", "displayName": "BDT", "required": false }, { "value": "BGN", "type": "String", "displayName": "BGN", "required": false }, { "value": "BRL", "type": "String", "displayName": "BRL", "required": false }, { "value": "BWP", "type": "String", "displayName": "BWP", "required": false }, { "value": "CAD", "type": "String", "displayName": "CAD", "required": false }, { "value": "CHF", "type": "String", "displayName": "CHF", "required": false }, { "value": "CLP", "type": "String", "displayName": "CLP", "required": false }, { "value": "CNY", "type": "String", "displayName": "CNY", "required": false }, { "value": "COP", "type": "String", "displayName": "COP", "required": false }, { "value": "CRC", "type": "String", "displayName": "CRC", "required": false }, { "value": "CUC", "type": "String", "displayName": "CUC", "required": false }, { "value": "CUP", "type": "String", "displayName": "CUP", "required": false }, { "value": "CZK", "type": "String", "displayName": "CZK", "required": false }, { "value": "DKK", "type": "String", "displayName": "DKK", "required": false }, { "value": "DOP", "type": "String", "displayName": "DOP", "required": false }, { "value": "EGP", "type": "String", "displayName": "EGP", "required": false }, { "value": "EUR", "type": "String", "displayName": "EUR", "required": false }, { "value": "FJD", "type": "String", "displayName": "FJD", "required": false }, { "value": "GBP", "type": "String", "displayName": "GBP", "required": false }, { "value": "GEL", "type": "String", "displayName": "GEL", "required": false }, { "value": "GHS", "type": "String", "displayName": "GHS", "required": false }, { "value": "GTQ", "type": "String", "displayName": "GTQ", "required": false }, { "value": "GYD", "type": "String", "displayName": "GYD", "required": false }, { "value": "HKD", "type": "String", "displayName": "HKD", "required": false }, { "value": "HNL", "type": "String", "displayName": "HNL", "required": false }, { "value": "HRK", "type": "String", "displayName": "HRK", "required": false }, { "value": "HUF", "type": "String", "displayName": "HUF", "required": false }, { "value": "IDR", "type": "String", "displayName": "IDR", "required": false }, { "value": "ILS", "type": "String", "displayName": "ILS", "required": false }, { "value": "INR", "type": "String", "displayName": "INR", "required": false }, { "value": "ISK", "type": "String", "displayName": "ISK", "required": false }, { "value": "JMD", "type": "String", "displayName": "JMD", "required": false }, { "value": "JPY", "type": "String", "displayName": "JPY", "required": false }, { "value": "KES", "type": "String", "displayName": "KES", "required": false }, { "value": "KRW", "type": "String", "displayName": "KRW", "required": false }, { "value": "KWD", "type": "String", "displayName": "KWD", "required": false }, { "value": "KYD", "type": "String", "displayName": "KYD", "required": false }, { "value": "KZT", "type": "String", "displayName": "KZT", "required": false }, { "value": "LAK", "type": "String", "displayName": "LAK", "required": false }, { "value": "LBP", "type": "String", "displayName": "LBP", "required": false }, { "value": "LKR", "type": "String", "displayName": "LKR", "required": false }, { "value": "LTL", "type": "String", "displayName": "LTL", "required": false }, { "value": "LVL", "type": "String", "displayName": "LVL", "required": false }, { "value": "MAD", "type": "String", "displayName": "MAD", "required": false }, { "value": "MDL", "type": "String", "displayName": "MDL", "required": false }, { "value": "MGA", "type": "String", "displayName": "MGA", "required": false }, { "value": "MUR", "type": "String", "displayName": "MUR", "required": false }, { "value": "MVR", "type": "String", "displayName": "MVR", "required": false }, { "value": "MWK", "type": "String", "displayName": "MWK", "required": false }, { "value": "MXN", "type": "String", "displayName": "MXN", "required": false }, { "value": "MYR", "type": "String", "displayName": "MYR", "required": false }, { "value": "MZN", "type": "String", "displayName": "MZN", "required": false }, { "value": "NAD", "type": "String", "displayName": "NAD", "required": false }, { "value": "NGN", "type": "String", "displayName": "NGN", "required": false }, { "value": "NOK", "type": "String", "displayName": "NOK", "required": false }, { "value": "NPR", "type": "String", "displayName": "NPR", "required": false }, { "value": "NZD", "type": "String", "displayName": "NZD", "required": false }, { "value": "OMR", "type": "String", "displayName": "OMR", "required": false }, { "value": "PEN", "type": "String", "displayName": "PEN", "required": false }, { "value": "PHP", "type": "String", "displayName": "PHP", "required": false }, { "value": "PKR", "type": "String", "displayName": "PKR", "required": false }, { "value": "PLN", "type": "String", "displayName": "PLN", "required": false }, { "value": "QAR", "type": "String", "displayName": "QAR", "required": false }, { "value": "RON", "type": "String", "displayName": "RON", "required": false }, { "value": "RSD", "type": "String", "displayName": "RSD", "required": false }, { "value": "RUB", "type": "String", "displayName": "RUB", "required": false }, { "value": "RWF", "type": "String", "displayName": "RWF", "required": false }, { "value": "SAR", "type": "String", "displayName": "SAR", "required": false }, { "value": "SCR", "type": "String", "displayName": "SCR", "required": false }, { "value": "SEK", "type": "String", "displayName": "SEK", "required": false }, { "value": "SGD", "type": "String", "displayName": "SGD", "required": false }, { "value": "THB", "type": "String", "displayName": "THB", "required": false }, { "value": "TND", "type": "String", "displayName": "TND", "required": false }, { "value": "TRY", "type": "String", "displayName": "TRY", "required": false }, { "value": "TTD", "type": "String", "displayName": "TTD", "required": false }, { "value": "TWD", "type": "String", "displayName": "TWD", "required": false }, { "value": "TZS", "type": "String", "displayName": "TZS", "required": false }, { "value": "UAH", "type": "String", "displayName": "UAH", "required": false }, { "value": "UGX", "type": "String", "displayName": "UGX", "required": false }, { "value": "USD", "type": "String", "displayName": "USD", "required": false }, { "value": "UYU", "type": "String", "displayName": "UYU", "required": false }, { "value": "VEF", "type": "String", "displayName": "VEF", "required": false }, { "value": "VND", "type": "String", "displayName": "VND", "required": false }, { "value": "VUV", "type": "String", "displayName": "VUV", "required": false }, { "value": "XAF", "type": "String", "displayName": "XAF", "required": false }, { "value": "XCD", "type": "String", "displayName": "XCD", "required": false }, { "value": "XOF", "type": "String", "displayName": "XOF", "required": false }, { "value": "ZAR", "type": "String", "displayName": "ZAR", "required": false }, { "value": "ZMK", "type": "String", "displayName": "ZMK", "required": false } ], "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "If not specified, defaults to the company's native currency" } ] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the credit note, inclusive of discounts but exclusive of tax", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the credit note, inclusive of discounts and tax", "required": false, "validation": { "warnings": [], "information": [ { "field": "TotalAmount", "details": "If supplied, must match the sum of all line items" } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false }, "lineItems": { "type": "Array", "displayName": "Line item", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "If supplied, must be a positive number" } ] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false } }, "required": true } }, "required": true } }, "FreshBooks": { "value": { "type": "Object", "displayName": "Accounts Receivable Credit Note", "description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the credit note has been issued to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must be valid Customer Id" } ], "information": [] } } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true }, "creditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": false }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": false }, "lineItems": { "type": "Array", "displayName": "Line item", "description": "A collection of lines that detail items related to the credit note", "properties": { "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "required": false } }, "required": false } }, "required": true } }, "MYOB AccountRight and Essentials": { "value": { "type": "Object", "displayName": "Accounts Receivable Credit Note", "description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.", "properties": { "creditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": false, "validation": { "warnings": [ { "field": "CreditNoteNumber", "details": "Must have a length between 1 and 13 characters" } ], "information": [] } }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the credit note has been issued to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the credit note, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must match the sum of TotalAmounts for the line items" }, { "field": "TotalAmount", "details": "Must be greater than zero." } ], "information": [] } }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "options": [ { "value": "AUD", "type": "String", "displayName": "Australian Dollar", "required": false } ], "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false, "validation": { "warnings": [ { "field": "CurrencyRate", "details": "Must be greater than zero." }, { "field": "CurrencyRate", "details": "Only valid if Currency is set" } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Line item", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [ { "field": "LineItems.UnitAmount", "details": "Must be greater or equal to 0" } ], "information": [] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true, "validation": { "warnings": [ { "field": "LineItems.AccountRef", "details": "Must not be supplied with an inventory item" }, { "field": "LineItems.AccountRef", "details": "Must be supplied except when an ItemRef is supplied" } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true } }, "required": false }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories ths item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.TrackingCategoryRefs", "details": "Must have the same value for all line items" }, { "field": "LineItems.TrackingCategoryRefs", "details": "May contain a maximum of 1 item" } ], "information": [] } } }, "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Must have a length between 1 and 2000 characters" } ], "information": [] } } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "Accounts Receivable Credit Note", "description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the credit note has been issued to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": false }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true }, "lineItems": { "type": "Array", "displayName": "Line item", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": false, "validation": { "warnings": [ { "field": "LineItems.UnitAmount", "details": "Must not be provided for 'Discount' type items" } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": false, "validation": { "warnings": [ { "field": "LineItems.Quantity", "details": "Must not be provided for 'Discount' type items" } ], "information": [] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false, "validation": { "warnings": [ { "field": "LineItems.SubTotal", "details": "Must be provided if and only if item does not have type 'Discount'" } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": false } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxRateRef", "details": "Must be provided if item does not have type 'Discount'" } ], "information": [] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories ths item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [], "information": [ { "field": "TrackingCategoryRefs.Id", "details": "A single location tracking category must be present on all LineItems. Optionally, a single class tracking category and a single department tracking category may be present on all LineItems too." } ] } } }, "required": true } }, "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": false } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Accounts Receivable Credit Note", "description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the credit note has been issued to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must match the ID of an existing customer." } ], "information": [] } } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true }, "creditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": false, "validation": { "warnings": [ { "field": "CreditNoteNumber", "details": "Max length of 11 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "Must be a three letter ISO code that matches the currency of the customer" }, { "field": "Currency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "Currency", "details": "If not set, will default to the default currency of the customer" } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Max length of 4000 characters." } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1." }, { "field": "CurrencyRate", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ] } }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true }, "lineItems": { "type": "Array", "displayName": "Line item", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Max length of 4000 characters." } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "required": true, "validation": { "warnings": [ { "field": "LineItems.ItemRef", "details": "Must match the ID of an existing item." } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "For US versions of QuickBooks Desktop this must be a Tax Code" }, { "field": "TaxRateRef.Id", "details": "For US versions of QuickBooks Desktop either 'Id' or 'Name' must be specified" } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Name", "details": "For US versions of QuickBooks Desktop with Sales Tax enabled this must be either 'Tax' or 'Non'" }, { "field": "TaxRateRef.Name", "details": "For US versions of QuickBooks Desktop either 'Id' or 'Name' must be specified" } ], "information": [] } } }, "required": false }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories ths item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.Id", "details": "Must match the ID of an existing tracking category." } ], "information": [] } } }, "required": false } }, "required": true } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Accounts Receivable Credit Note", "description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": true, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Must be provided." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "Required if Currency is not the base currency." } ] } }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the credit note has been issued to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must match the ID of an existing customer." } ], "information": [ { "field": "CustomerRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "creditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": false }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the credit note, inclusive of discounts and tax", "required": false }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": false }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true }, "lineItems": { "type": "Array", "displayName": "Line item", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": true, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Maximum character length should not be longer than 4000." } ], "information": [ { "field": "LineItems.Description", "details": "Must be provided." } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TotalAmount", "details": "Must be provided." } ] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories ths item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.Id", "details": "A tracking category of type CLASS can only be provided if ClassTrackingPerTxnLine is enabled for the QBO company." }, { "field": "TrackingCategoryRefs.Id", "details": "Only one tracking category of type CLASS can be provided per item." }, { "field": "TrackingCategoryRefs.Id", "details": "A tracking category of type DEPARTMENT should be declared at the top level item (first line item)." }, { "field": "TrackingCategoryRefs.Id", "details": "A tracking category of type DEPARTMENT can only be provided if TrackDepartments is enabled for the QBO company." }, { "field": "TrackingCategoryRefs.Id", "details": "Only one tracking category of type DEPARTMENT can be provided per credit note." }, { "field": "TrackingCategoryRefs.Id", "details": "Must match the ID of an existing tracking category and be of type DEPARTMENT or CLASS." } ], "information": [] } } }, "required": false }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax code." } ], "information": [ { "field": "TaxRateRef.Id", "details": "If an organisation has Automated Sales Tax enabled for US locales, then 'TAX' (Automated Sales Tax), 'NON' (no tax) or a custom tax rate can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used." }, { "field": "TaxRateRef.Id", "details": "Must be provided." } ] } } }, "required": true } }, "required": true }, "totalTaxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the credit note", "required": false, "validation": { "warnings": [], "information": [ { "field": "TotalTaxAmount", "details": "Tax will not be overridden if TotalTaxAmount is 0." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Automated Sales Tax is disabled for this company." } ] } } }, "Sage 50 (UK)": { "value": { "type": "Object", "displayName": "Accounts Receivable Credit Note", "description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.", "properties": { "creditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "The reference number for this credit note", "required": true }, "status": { "type": "String", "displayName": "Status", "description": "The status of the credit note", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": false, "validation": { "warnings": [], "information": [ { "field": "status", "details": "If this is not set, it will default to 'Submitted'." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "To be used for any additional information associated with the credit note.", "required": false, "validation": { "warnings": [ { "field": "note", "details": "Maximum 60 characters" } ], "information": [] } }, "customerRef": { "type": "Object", "displayName": "Customer", "description": "Customer to be pay.", "properties": { "id": { "type": "String", "displayName": "Customer Id", "description": "Identifier of the customer.", "required": true, "validation": { "warnings": [ { "field": "customerRef.id", "details": "Must match the ID of an existing customer and have a max length of 8 characters." } ], "information": [] } } }, "required": true }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "Line items of the credit note.", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Identifier for the account.", "properties": { "id": { "type": "String", "displayName": "Account Id", "description": "Identifier of the account.", "required": true, "validation": { "warnings": [ { "field": "accountRef.id", "details": "Must match the ID of an existing account." } ], "information": [] } } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Tax rate reference of a credit note line item.", "properties": { "id": { "type": "String", "displayName": "Tax Rate Id", "description": "ID of the tax rate.", "required": true, "validation": { "warnings": [ { "field": "taxRateRef.id", "details": "Must match the ID of an existing tax rate." } ], "information": [] } } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Categories", "description": "Tracking categories for the line item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "Prefixed identifier for tracking category e.g. project_{x}, department_{x}", "required": true, "validation": { "warnings": [ { "field": "trackingCategoryRefs.id", "details": "Projects assigned with project_{x} must exist in Sage50" }, { "field": "trackingCategoryRefs.id", "details": "Departments assigned with department_{x} must exist in Sage50" } ], "information": [] } } }, "required": false } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company." } ] } } }, "Sage Business Cloud Accounting": { "value": { "type": "Object", "displayName": "Accounts Receivable Credit Note", "description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.", "properties": { "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must be provided." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "If supplied, must match the currency of the customer." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": false, "validation": { "warnings": [], "information": [ { "field": "Note", "details": "Should not be longer than 2000 characters." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the credit note has been issued to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must match the ID of an existing customer." } ], "information": [ { "field": "CustomerRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the credit note, inclusive of discounts and tax", "required": false, "validation": { "warnings": [], "information": [ { "field": "TotalAmount", "details": "If supplied, must match the sum of all line item total amounts." } ] } }, "lineItems": { "type": "Array", "displayName": "Line item", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": true, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Should not be longer than 2000 characters." } ], "information": [ { "field": "LineItems.Description", "details": "Must be provided." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxAmount", "details": "Must be provided." } ] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax rate." } ], "information": [ { "field": "TaxRateRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TotalAmount", "details": "If supplied, must match the total of the line including tax." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must be provided." } ] } } }, "required": true } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "Accounts Receivable Credit Note", "description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the credit note has been issued to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [], "information": [ { "field": "CustomerRef.Id", "details": "Must be used to provide Customer Id." } ] } } }, "required": true }, "creditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": false, "validation": { "warnings": [], "information": [ { "field": "CreditNoteNumber", "details": "Must be provided if Sage Intacct is not configured to auto-generate an Adjustment Number, otherwise cannot be used." } ] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must be used to provide the date the Credit Note was created." } ] } }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the credit note was allocated", "required": false }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "Must be either Draft or Submitted." } ] } }, "lineItems": { "type": "Array", "displayName": "Line item", "description": "A collection of lines that detail items related to the credit note", "properties": { "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided and must be zero or greater." } ] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false, "validation": { "warnings": [], "information": [ { "field": "TaxRateRef.Id", "details": "Must be an existing tax rate in Sage Intacct." } ] } } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxRateRef", "details": "It is only required for VAT enabled transactions." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Must be an existing GL Account in Sage Intacct and not linked to any bank account." } ] } } }, "required": true }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories ths item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": false }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": false } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must contain at least one line item." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "When supplying a currency ensure that it exists in your Sage Intacct entity otherwise the request will fail." } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": false } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Accounts Receivable Credit Note", "description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.", "properties": { "creditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": true }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the credit note has been issued to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true }, "companyName": { "type": "String", "displayName": "Name", "description": "The name of the customer referenced by the identifier", "required": true } }, "required": true }, "withholdingTax": { "type": "Array", "displayName": "Withholding Tax", "description": "A collection of tax deductions", "properties": { "name": { "type": "String", "displayName": "Name", "description": "Name of the deduction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "Deduction amount", "required": true } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the credit note, inclusive of discounts and tax", "required": true }, "totalDiscount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given credit note currency, of any discounts applied", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the credit note, inclusive of discounts but exclusive of tax", "required": true }, "additionalTaxAmount": { "type": "Number", "displayName": "Additional Tax Amount", "description": "Tax added to the total tax of the lines", "required": true }, "additionalTaxPercentage": { "type": "Number", "displayName": "Additional Tax Percentage", "description": "The percentage of the additional tax to the TotalAmount", "required": true }, "totalTaxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the credit note", "required": true }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": true }, "remainingCredit": { "type": "Number", "displayName": "Remaining Credit", "description": "Unused balance of total amount originally raised", "required": true }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the credit note was allocated", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": true }, "lineItems": { "type": "Array", "displayName": "Line item", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given credit note currency, of any discounts applied", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": true }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": true } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the item referenced by the identifier", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories ths item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": true } }, "required": true }, "tracking": { "type": "Object", "displayName": "Accounts Receivable Tracking", "description": "A collection of items this line item is being tracked against", "properties": { "categoryRefs": { "type": "Array", "displayName": "Category References", "description": "A collection of categories this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": true } }, "required": true }, "projectRef": { "type": "Object", "displayName": "Project Reference", "description": "Reference to the project this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the Project", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the Project referenced by the identifier", "required": true } }, "required": true }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true }, "companyName": { "type": "String", "displayName": "Name", "description": "The name of the customer referenced by the identifier", "required": true } }, "required": true }, "isBilledTo": { "type": "String", "displayName": "Is Billed To", "description": "The type of item this line item is billed to.", "required": true }, "isRebilledTo": { "type": "String", "displayName": "Is Rebilled To", "description": "The type of item this line item is billed to", "required": true } }, "required": true }, "isDirectIncome": { "type": "Boolean", "displayName": "Is Direct Income", "description": "True if this invoice is also mapped as a direct income", "required": true } }, "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments that are allocated to (i.e. spend) the credit note", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the allocated payment", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the allocated payment", "required": true }, "reference": { "type": "String", "displayName": "Reference", "description": "Reference associated with the allocated payment", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the base company", "required": true }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": true } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the transaction", "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": true } }, "required": true } }, "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the credit note", "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Accounts Receivable Credit Note", "description": "A credit note can be thought of as a voucher issued to a customer. It can be applied against one or multiple invoices to reduce their balance.", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the credit note has been issued to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must be a valid GUID." }, { "field": "CustomerRef.Id", "details": "Must match the ID of an existing customer." } ], "information": [ { "field": "CustomerRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "CustomerRef", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the credit note, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must be greater than zero." } ], "information": [ { "field": "TotalAmount", "details": "Must be provided and must equal the sum of the link items amount." } ] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the credit note was issued", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must be provided." } ] } }, "creditNoteNumber": { "type": "String", "displayName": "Credit Note Number", "description": "User friendly reference for the credit note", "required": false, "validation": { "warnings": [], "information": [ { "field": "CreditNoteNumber", "details": "Must not be longer than 225 characters long." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the credit note", "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the credit note and the base currency of the company", "required": false }, "status": { "type": "String", "displayName": "Credit Note Status", "description": "The current state of a credit note", "options": [ { "value": "Draft", "type": "String", "displayName": "Draft", "required": false }, { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "Must be provided." } ] } }, "lineItems": { "type": "Array", "displayName": "Line item", "description": "A collection of lines that detail items related to the credit note", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services credited", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.Description", "details": "Must be provided when itemRef is not provided, or when the item has no sales description in Xero." } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services credited", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxAmount", "details": "It will not be mapped directly into Xero as Xero computes it automatically on its end." } ], "information": [] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false, "validation": { "warnings": [ { "field": "LineItems.TotalAmount", "details": "It will not be mapped directly into Xero as Xero computes it automatically on its end." } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax rate." } ], "information": [] } } }, "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a valid GUID." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided" } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.AccountRef", "details": "Must be provided." } ] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories ths item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [], "information": [ { "field": "TrackingCategoryRefs.Id", "details": "Must be provided." } ] } } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TrackingCategoryRefs", "details": "Tracking categories must not have the same parent tracking category." }, { "field": "LineItems.TrackingCategoryRefs", "details": "Maximum of 2 Tracking Categories." } ] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must be a valid GUID." }, { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must be provided." } ] } } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-update-creditNotes-model", "description": "The *Get create/update credit note model* endpoint returns the expected data for the request payload when creating and updating a [credit note](https://docs.codat.io/accounting-api#/schemas/CreditNote) for a given company and integration.\n\n[Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes) for integrations that support creating and updating a credit note.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/creditNotes": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Credit notes" ], "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" }, "examples": { "QuickBooks Desktop": { "value": { "creditNoteNumber": "09/03 17.15", "note": "credit note 20230309 17.15", "status": "Submitted", "customerRef": { "id": "80000002-1674552702" }, "currency": "USD", "currencyRate": 1, "subTotal": 10.2, "issueDate": "2023-03-09T02:21:26.726327+00:00", "lineItems": [ { "itemRef": { "id": "80000004-1675280003", "name": "test income item 1" }, "quantity": 1, "subTotal": 1.25, "taxAmount": 0, "unitAmount": 1.25, "description": "banana", "totalAmount": 1.25 } ], "totalAmount": 1.25, "totalDiscount": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 0 } }, "Sage 50 (UK)": { "value": { "creditNoteNumber": "07/03 14.24", "customerRef": { "id": "CUST1", "companyName": "string" }, "withholdingTax": [ { "name": "string", "amount": 0 } ], "totalAmount": 60, "totalDiscount": 0, "subTotal": 60, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 60, "status": "Submitted", "issueDate": "2023-03-07T18:23:43.781Z", "allocatedOnDate": "2023-03-06T18:23:43.781Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "credit note line 1", "unitAmount": 60, "quantity": 1, "discountAmount": 0, "subTotal": 60, "taxAmount": 0, "totalAmount": 60, "accountRef": { "id": "4000", "name": "string" }, "discountPercentage": 0, "taxRateRef": { "id": "9", "name": "string", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [ { "id": "department_1" } ], "tracking": { "categoryRefs": [ { "id": "5049" } ], "projectRef": { "id": "D4039" }, "customerRef": { "id": "LND1203-139" }, "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectIncome": true } ], "paymentAllocations": [] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCreditNoteResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Create credit note", "description": "The *Create credit note* endpoint creates a new [credit note](https://docs.codat.io/accounting-api#/schemas/CreditNote) for a given company's connection.\n\n[Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update credit note model](https://docs.codat.io/accounting-api#/operations/get-create-update-creditNotes-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes) for integrations that support creating an account.\n", "operationId": "create-credit-note" } }, "/companies/{companyId}/connections/{connectionId}/push/creditNotes/{creditNoteId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/creditNoteId" } ], "put": { "tags": [ "Credit notes" ], "summary": "Update credit note", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/forceUpdate" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNote" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCreditNoteResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Update credit note* endpoint updates an existing [credit note](https://docs.codat.io/accounting-api#/schemas/CreditNote) for a given company's connection.\n\n[Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update credit note model](https://docs.codat.io/accounting-api#/operations/get-create-update-creditNotes-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes) for integrations that support creating an account.\n", "operationId": "update-credit-note" } }, "/companies/{companyId}/data/customers": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Customers" ], "summary": "List customers", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customers" }, "examples": { "Clear Books": { "value": { "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" } } } }, "Dynamics 365 Business Central": { "value": { "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" } } } }, "Exact (Netherlands)": { "value": { "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" } } } }, "Exact (UK)": { "value": { "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" } } } }, "FreeAgent": { "value": { "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" } } } }, "FreshBooks": { "value": { "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" } } } }, "KashFlow": { "value": { "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" } } } }, "Oracle NetSuite": { "value": { "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" } } } }, "QuickBooks Desktop": { "value": { "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" } } } }, "QuickBooks Online": { "value": { "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" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "66", "customerName": "Abercrombie International Group", "contactName": "Kristy Abercrombie", "defaultCurrency": "GBP", "addresses": [ { "type": "Billing", "line1": "123 Main St", "city": "New York, NY" } ], "contacts": [ { "name": "Abercrombie International Group (deleted)", "phone": [], "address": { "type": "Billing", "line1": "123 Main St", "city": "New York, NY" }, "status": "Archived" } ], "status": "Archived", "modifiedDate": "2023-04-26T09:35:56Z", "sourceModifiedDate": "2016-09-12T18:53:19Z", "metadata": { "isDeleted": false } }, { "id": "67", "customerName": "Abercrombie International Group", "contactName": "Natalie Watts", "emailAddress": "n.watts@google.com", "defaultCurrency": "USD", "addresses": [ { "type": "Billing" }, { "type": "Delivery" } ], "contacts": [ { "name": "Abercrombie International Group", "email": "n.watts@google.com", "phone": [], "address": { "type": "Billing" }, "status": "Active" } ], "registrationNumber": "XXXXVat123456", "taxNumber": "XXXXVat123456", "status": "Active", "modifiedDate": "2023-04-26T09:35:56Z", "sourceModifiedDate": "2023-03-29T01:12:55Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 243, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "A1D001", "customerName": "A1 Design Services", "contactName": "Lee Dalkin", "emailAddress": "newbusinessadvice@sage.com", "defaultCurrency": "GBP", "phone": "01742 876 234", "addresses": [ { "type": "Delivery", "line1": "67a Station Road", "line2": "", "city": "Blackpool", "region": "Lancashire", "country": "", "postalCode": "BP12 7HT" }, { "type": "Delivery", "line1": "23a Union Street", "line2": "", "city": "Manchester", "region": "", "country": "", "postalCode": "M2 6JK" }, { "type": "Billing", "line1": "67a Station Road", "line2": "", "city": "Blackpool", "region": "Lancashire", "country": "Great Britain", "postalCode": "BP12 7HT" } ], "contacts": [ { "name": "Lee Dalkin", "email": "newbusinessadvice@sage.com", "phone": [ { "number": "01742 876 234", "type": "Landline" }, { "number": "01742 876 235", "type": "Landline" }, { "number": "01742 876 236", "type": "Fax" } ], "status": "Active" }, { "name": "Malcolm Leverret", "email": "", "phone": [], "status": "Active" }, { "name": "Jim Thomas", "email": "Jim@a1designservices.co.uk", "phone": [ { "number": "01742 876 234", "type": "Landline" }, { "number": "01742 876 235", "type": "Fax" } ], "status": "Active" }, { "name": "Jullian Plawsworth", "email": "Jullian@a1designservices.co.uk", "phone": [ { "number": "0151 349 3939", "type": "Landline" }, { "number": "0151 349 3940", "type": "Fax" } ], "status": "Active" } ], "registrationNumber": "", "taxNumber": "GB238 3839 38", "status": "Active", "modifiedDate": "2022-10-14T09:35:53Z", "sourceModifiedDate": "2022-04-27T15:17:36Z" }, { "id": "A1D002", "customerName": "A2 Design Services", "contactName": "Lee Dalkin", "emailAddress": "newbusinessadvice@sage.com", "defaultCurrency": "GBP", "phone": "01742 876 234", "addresses": [ { "type": "Billing", "line1": "77a Station Road", "line2": "", "city": "Blackpool", "region": "Lancashire", "country": "Great Britain", "postalCode": "BP12 7HT" } ], "contacts": [ { "name": "Lee Dalkin", "email": "newbusinessadvice@sage.com", "phone": [ { "number": "01742 876 234", "type": "Landline" }, { "number": "01742 876 235", "type": "Landline" }, { "number": "01742 876 236", "type": "Fax" } ], "status": "Active" }, { "name": "Malcolm Leverret", "email": "", "phone": [], "status": "Active" }, { "name": "Jim Thomas", "email": "Jim@a1designservices.co.uk", "phone": [ { "number": "01742 876 234", "type": "Landline" }, { "number": "01742 876 235", "type": "Fax" } ], "status": "Active" }, { "name": "Jullian Plawsworth", "email": "Jullian@a1designservices.co.uk", "phone": [ { "number": "0151 349 3939", "type": "Landline" }, { "number": "0151 349 3940", "type": "Fax" } ], "status": "Active" } ], "registrationNumber": "", "taxNumber": "GB238 3839 40", "status": "Active", "modifiedDate": "2022-10-14T09:35:53Z", "sourceModifiedDate": "2020-09-23T10:28:58Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 43, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "A1D001", "customerName": "A1 Design Services", "contactName": "Ian Cairns", "emailAddress": "newbusinessadvice@sage.com", "defaultCurrency": "GBP", "phone": "01742 876 234", "addresses": [ { "type": "Delivery", "line1": "67a Station Road", "line2": "", "city": "Blackpool", "region": "Lancashire", "country": "GB", "postalCode": "BP12 7HT" }, { "type": "Delivery", "line1": "23a Union Street", "line2": "", "city": "Manchester", "region": "", "country": "GB", "postalCode": "M2 6JK" }, { "type": "Unknown", "line1": "67a Station Road", "line2": "", "city": "Blackpool", "region": "Lancashire", "country": "GB", "postalCode": "BP12 7HT" } ], "contacts": [], "taxNumber": "GB238 3839 38", "status": "Active", "modifiedDate": "2023-03-30T14:42:41Z", "sourceModifiedDate": "2022-11-25T09:43:54Z", "metadata": { "isDeleted": false } }, { "id": "ABS001", "customerName": "ABS Garages Ltd", "contactName": "Mike Hall", "emailAddress": "newbusinessadvice@sage.com", "defaultCurrency": "GBP", "phone": "0191 254 5909", "addresses": [ { "type": "Delivery", "line1": "Swanson Industries", "line2": "Dukes Industrial Estate", "city": "Whitley Bay", "region": "North Tyneside", "country": "GB", "postalCode": "NE56 4ER" }, { "type": "Delivery", "line1": "Unit 34", "line2": "Holystone Ind Estate", "city": "Hebburn", "region": "Tyne & Wear", "country": "GB", "postalCode": "NE31 1VB" }, { "type": "Unknown", "line1": "Unit 34", "line2": "Holystone Ind Estate", "city": "Hebburn", "region": "Tyne & Wear", "country": "GB", "postalCode": "NE31 1VB" } ], "contacts": [], "taxNumber": "GB745 4584 68", "status": "Active", "modifiedDate": "2023-03-30T14:42:41Z", "sourceModifiedDate": "2022-11-25T09:43:54Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 30, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "260f6a3f94a243738f2d5e08496a41a8", "customerName": "100 test name", "contactName": "Main Contact", "emailAddress": "email@codat.io", "defaultCurrency": "GBP", "phone": "contact phone number", "addresses": [ { "type": "Billing", "line1": "Aruba Address line 1", "line2": "Aruba Address line 2", "city": "Aruba City", "region": "Aruba Province", "country": "Aruba (AW)", "postalCode": "Aruba Post" } ], "contacts": [ { "phone": [ { "number": "contact mobile number", "type": "Mobile" }, { "number": "contact fax number", "type": "Fax" } ], "status": "Unknown" } ], "status": "Active", "modifiedDate": "2022-10-24T14:52:54Z", "sourceModifiedDate": "2021-05-10T16:31:51Z" }, { "id": "44a5d9461d9e4f6d90a5ace251c5cf35", "customerName": "100 test name DS", "contactName": "Main Contact", "emailAddress": "DCemail@codat.io", "defaultCurrency": "GBP", "phone": "contact phone number", "addresses": [ { "type": "Billing", "line1": "POST - Aruba Address line 1", "line2": "POST - Aruba Address line 2", "city": "POST - Aruba City", "region": "Aruba Province", "country": "Aruba (AW)", "postalCode": "Aruba Post" } ], "contacts": [], "status": "Active", "modifiedDate": "2022-10-24T14:52:54Z", "sourceModifiedDate": "2021-06-10T14:22:46Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 168, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/customers" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "188", "customerName": "33Across", "contactName": "Yuna Conn", "defaultCurrency": "USD", "phone": "520-393-4468", "addresses": [ { "type": "Unknown", "line1": "155 Westend Point", "line2": "", "city": "Albuquerque", "region": "NM", "country": "United States", "postalCode": "87140" } ], "contacts": [ { "name": "Conn, Yuna", "phone": [ { "number": "520-393-4468", "type": "Primary" } ], "address": { "type": "Unknown", "line1": "155 Westend Point", "line2": "", "city": "Albuquerque", "region": "NM", "country": "United States", "postalCode": "87140" }, "status": "Unknown" } ], "taxNumber": "", "status": "Active", "modifiedDate": "2023-04-04T16:32:21Z", "sourceModifiedDate": "2022-09-06T12:58:27", "metadata": { "isDeleted": false } }, { "id": "324", "customerName": "3Way International Logistics", "contactName": "Lauri O'Heagertie", "defaultCurrency": "CAD", "phone": "410-309-3976", "addresses": [ { "type": "Unknown", "line1": "7 Lerdahl Junction", "line2": "", "city": "Sparwood", "region": "British Columbia", "country": "Canada", "postalCode": "L4R" } ], "contacts": [ { "name": "O'Heagertie, Lauri", "phone": [ { "number": "410-309-3976", "type": "Primary" } ], "address": { "type": "Unknown", "line1": "7 Lerdahl Junction", "line2": "", "city": "Sparwood", "region": "British Columbia", "country": "Canada", "postalCode": "L4R" }, "status": "Unknown" } ], "taxNumber": "", "status": "Active", "modifiedDate": "2023-04-04T16:32:21Z", "sourceModifiedDate": "2020-10-20T05:01:49", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 530, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers" }, "next": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=2&pageSize=2" } } } }, "Wave": { "value": { "results": [ { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4", "customerName": "ABC Textiles", "contactName": "", "emailAddress": "c.taylor@codat.io", "defaultCurrency": "USD", "addresses": [], "contacts": [], "status": "Active", "modifiedDate": "2022-11-16T18:15:30Z", "sourceModifiedDate": "2019-10-17T07:59:04Z" }, { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM3MTUzNDI2", "customerName": "Coffee Cart", "contactName": "Coffee Carl", "emailAddress": "coffee.cart@example.com", "defaultCurrency": "GBP", "phone": "0201111", "addresses": [ { "type": "Billing", "line1": "11 Coffee Lane", "line2": "Coffee Town", "city": "Coffee City", "region": "Hampshire", "country": "United Kingdom", "postalCode": "CC1 1CC" } ], "contacts": [ { "name": "Coffee Carl", "phone": [ { "number": "07733", "type": "Mobile" } ], "status": "Active" } ], "status": "Active", "modifiedDate": "2022-11-16T18:15:30Z", "sourceModifiedDate": "2020-03-17T19:12:39Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 10, "_links": { "current": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=1&pageSize=2" }, "self": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers" }, "next": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "customerName": "24 Locks", "emailAddress": "", "addresses": [], "contacts": [], "status": "Active", "modifiedDate": "2023-03-15T20:35:10Z", "sourceModifiedDate": "2023-02-17T18:03:42", "metadata": { "isDeleted": false } }, { "id": "bab779bc-c5fb-42cb-a888-953e8309711c", "customerName": "7-Eleven", "emailAddress": "", "addresses": [], "contacts": [], "status": "Active", "modifiedDate": "2023-03-15T20:35:10Z", "sourceModifiedDate": "2023-02-17T18:03:42", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 48, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/customers" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000032105", "customerName": "A B", "contactName": "Contact (First Name) Contact (Last Name)", "emailAddress": "contactperson@whateveryouwantidontcare12345.com", "defaultCurrency": "GBP", "phone": "Work Phone", "addresses": [], "contacts": [ { "name": "Contact (First Name) Contact (Last Name)", "email": "contactperson@whateveryouwantidontcare12345.com", "phone": [ { "number": "Work Phone", "type": "Landline" }, { "number": "Mobile", "type": "Mobile" } ], "status": "Active" } ], "status": "Active", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-06-09T14:36:47" }, { "id": "104957000000054050", "customerName": "Doe, John", "contactName": "John Doe", "emailAddress": "", "defaultCurrency": "GBP", "addresses": [], "contacts": [ { "name": "John Doe", "email": "", "phone": [], "status": "Active" } ], "status": "Active", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-09-28T15:09:22" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 14, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List customers* endpoint returns a list of [customers](https://docs.codat.io/accounting-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-customers" } }, "/companies/{companyId}/data/customers/{customerId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/customerId" } ], "get": { "tags": [ "Customers" ], "summary": "Get customer", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" }, "examples": { "Clear Books": { "value": { "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 } } }, "Dynamics 365 Business Central": { "value": { "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 } } }, "Exact (Netherlands)": { "value": { "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" } }, "Exact (UK)": { "value": { "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" } }, "FreeAgent": { "value": { "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 } } }, "FreshBooks": { "value": { "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": "123456789", "type": "Primary" }, { "number": "987654321", "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 } } }, "KashFlow": { "value": { "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" } }, "Oracle NetSuite": { "value": { "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" } }, "QuickBooks Desktop": { "value": { "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 } } }, "QuickBooks Online": { "value": { "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" } }, "QuickBooks Online Sandbox": { "value": { "id": "66", "customerName": "Abercrombie International Group", "contactName": "Kristy Abercrombie", "defaultCurrency": "GBP", "addresses": [ { "type": "Billing", "line1": "123 Main St", "city": "New York, NY" } ], "contacts": [ { "name": "Abercrombie International Group (deleted)", "phone": [], "address": { "type": "Billing", "line1": "123 Main St", "city": "New York, NY" }, "status": "Archived" } ], "status": "Archived", "modifiedDate": "2023-04-26T09:35:56Z", "sourceModifiedDate": "2016-09-12T18:53:19Z", "metadata": { "isDeleted": false } } }, "Sage 200cloud": { "value": { "id": "A1D001", "customerName": "A1 Design Services", "contactName": "Lee Dalkin", "emailAddress": "newbusinessadvice@sage.com", "defaultCurrency": "GBP", "phone": "01742 876 234", "addresses": [ { "type": "Delivery", "line1": "67a Station Road", "line2": "", "city": "Blackpool", "region": "Lancashire", "country": "", "postalCode": "BP12 7HT" }, { "type": "Delivery", "line1": "23a Union Street", "line2": "", "city": "Manchester", "region": "", "country": "", "postalCode": "M2 6JK" }, { "type": "Billing", "line1": "67a Station Road", "line2": "", "city": "Blackpool", "region": "Lancashire", "country": "Great Britain", "postalCode": "BP12 7HT" } ], "contacts": [ { "name": "Lee Dalkin", "email": "newbusinessadvice@sage.com", "phone": [ { "number": "01742 876 234", "type": "Landline" }, { "number": "01742 876 235", "type": "Landline" }, { "number": "01742 876 236", "type": "Fax" } ], "status": "Active" }, { "name": "Malcolm Leverret", "email": "", "phone": [], "status": "Active" }, { "name": "Jim Thomas", "email": "Jim@a1designservices.co.uk", "phone": [ { "number": "01742 876 234", "type": "Landline" }, { "number": "01742 876 235", "type": "Fax" } ], "status": "Active" }, { "name": "Jullian Plawsworth", "email": "Jullian@a1designservices.co.uk", "phone": [ { "number": "0151 349 3939", "type": "Landline" }, { "number": "0151 349 3940", "type": "Fax" } ], "status": "Active" } ], "registrationNumber": "", "taxNumber": "GB238 3839 38", "status": "Active", "modifiedDate": "2022-10-14T09:35:53Z", "sourceModifiedDate": "2022-04-27T15:17:36Z" } }, "Sage 50 (UK)": { "value": { "id": "A1D001", "customerName": "A1 Design Services", "contactName": "Ian Cairns", "emailAddress": "newbusinessadvice@sage.com", "defaultCurrency": "GBP", "phone": "01742 876 234", "addresses": [ { "type": "Delivery", "line1": "67a Station Road", "line2": "", "city": "Blackpool", "region": "Lancashire", "country": "GB", "postalCode": "BP12 7HT" }, { "type": "Delivery", "line1": "23a Union Street", "line2": "", "city": "Manchester", "region": "", "country": "GB", "postalCode": "M2 6JK" }, { "type": "Unknown", "line1": "67a Station Road", "line2": "", "city": "Blackpool", "region": "Lancashire", "country": "GB", "postalCode": "BP12 7HT" } ], "contacts": [], "taxNumber": "GB238 3839 38", "status": "Active", "modifiedDate": "2023-03-30T14:42:41Z", "sourceModifiedDate": "2022-11-25T09:43:54Z", "metadata": { "isDeleted": false } } }, "Sage Business Cloud Accounting": { "value": { "id": "260f6a3f94a243738f2d5e08496a41a8", "customerName": "100 test name", "contactName": "Main Contact", "emailAddress": "email@codat.io", "defaultCurrency": "GBP", "phone": "contact phone number", "addresses": [ { "type": "Billing", "line1": "Aruba Address line 1", "line2": "Aruba Address line 2", "city": "Aruba City", "region": "Aruba Province", "country": "Aruba (AW)", "postalCode": "Aruba Post" } ], "contacts": [ { "phone": [ { "number": "contact mobile number", "type": "Mobile" }, { "number": "contact fax number", "type": "Fax" } ], "status": "Unknown" } ], "status": "Active", "modifiedDate": "2022-10-24T14:52:54Z", "sourceModifiedDate": "2021-05-10T16:31:51Z" } }, "Sage Intacct": { "value": { "id": "188", "customerName": "33Across", "contactName": "Yuna Conn", "defaultCurrency": "USD", "phone": "520-393-4468", "addresses": [ { "type": "Unknown", "line1": "155 Westend Point", "line2": "", "city": "Albuquerque", "region": "NM", "country": "United States", "postalCode": "87140" } ], "contacts": [ { "name": "Conn, Yuna", "phone": [ { "number": "520-393-4468", "type": "Primary" } ], "address": { "type": "Unknown", "line1": "155 Westend Point", "line2": "", "city": "Albuquerque", "region": "NM", "country": "United States", "postalCode": "87140" }, "status": "Unknown" } ], "taxNumber": "", "status": "Active", "modifiedDate": "2023-04-04T16:32:21Z", "sourceModifiedDate": "2022-09-06T12:58:27", "metadata": { "isDeleted": false } } }, "Wave": { "value": { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4", "customerName": "ABC Textiles", "contactName": "", "emailAddress": "c.taylor@codat.io", "defaultCurrency": "USD", "addresses": [], "contacts": [], "status": "Active", "modifiedDate": "2022-11-16T18:15:30Z", "sourceModifiedDate": "2019-10-17T07:59:04Z" } }, "Xero": { "value": { "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "customerName": "24 Locks", "emailAddress": "", "addresses": [], "contacts": [], "status": "Active", "modifiedDate": "2023-03-15T20:35:10Z", "sourceModifiedDate": "2023-02-17T18:03:42", "metadata": { "isDeleted": false } } }, "Zoho Books": { "value": { "id": "104957000000032105", "customerName": "A B", "contactName": "Contact (First Name) Contact (Last Name)", "emailAddress": "contactperson@whateveryouwantidontcare12345.com", "defaultCurrency": "GBP", "phone": "Work Phone", "addresses": [], "contacts": [ { "name": "Contact (First Name) Contact (Last Name)", "email": "contactperson@whateveryouwantidontcare12345.com", "phone": [ { "number": "Work Phone", "type": "Landline" }, { "number": "Mobile", "type": "Mobile" } ], "status": "Active" } ], "status": "Active", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-06-09T14:36:47" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get customer* endpoint returns a single customer for a given customerId.\n\n[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a specific customer.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-customer" } }, "/companies/{companyId}/connections/{connectionId}/options/customers": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create/update customer model", "tags": [ "Customers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Exact (Netherlands)": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": true }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": false }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the customer should be contacted on", "required": false }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The customer's registration number", "required": false, "validation": { "warnings": [ { "field": "RegistrationNumber", "details": "Only for Exact Netherlands, if provided, must be exactly 20 characters in length" } ], "information": [] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": false }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the customer", "required": false }, "contacts": { "type": "Array", "displayName": "Contacts", "description": "A collection of alternative contacts for the customer", "properties": { "name": { "type": "String", "displayName": "Name", "description": "The name of the contact", "required": true }, "email": { "type": "String", "displayName": "Email", "description": "The email address for the contact", "required": false }, "phone": { "type": "Array", "displayName": "Phone", "description": "A collection of phone numbers for the contact", "properties": { "number": { "type": "String", "displayName": "Number", "description": "The full number including country, and area code where applicable", "required": false } }, "required": false } }, "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Must be a 2-letter country code" } ], "information": [] } }, "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses", "details": "Only the first address provided will be considered, all other entries will be not be recorded" } ] } } }, "required": true } }, "Exact (UK)": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": true }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": false }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the customer should be contacted on", "required": false }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The customer's registration number", "required": false, "validation": { "warnings": [ { "field": "RegistrationNumber", "details": "Only for Exact Netherlands, if provided, must be exactly 20 characters in length" } ], "information": [] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": false }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the customer", "required": false }, "contacts": { "type": "Array", "displayName": "Contacts", "description": "A collection of alternative contacts for the customer", "properties": { "name": { "type": "String", "displayName": "Name", "description": "The name of the contact", "required": true }, "email": { "type": "String", "displayName": "Email", "description": "The email address for the contact", "required": false }, "phone": { "type": "Array", "displayName": "Phone", "description": "A collection of phone numbers for the contact", "properties": { "number": { "type": "String", "displayName": "Number", "description": "The full number including country, and area code where applicable", "required": false } }, "required": false } }, "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Must be a 2-letter country code" } ], "information": [] } }, "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses", "details": "Only the first address provided will be considered, all other entries will be not be recorded" } ] } } }, "required": true } }, "FreeAgent": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": true }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the customer", "required": true }, "status": { "type": "String", "displayName": "Customer Status", "description": "The current state of the customer", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": false }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": false }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": true }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses", "details": "Only one address may be specified" } ] } }, "contacts": { "type": "Array", "displayName": "Contacts", "description": "A collection of alternative contacts for the customer", "properties": { "name": { "type": "String", "displayName": "Name", "description": "The name of the contact", "options": [ { "value": "Billing Email", "type": "String", "displayName": "Billing Email", "required": false } ], "required": true }, "email": { "type": "String", "displayName": "Email", "description": "The email address for the contact", "required": true }, "phone": { "type": "Array", "displayName": "Phone", "description": "A collection of phone numbers for the contact", "properties": { "number": { "type": "String", "displayName": "Number", "description": "The full number including country, and area code where applicable", "required": true } }, "required": true } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "Contacts", "details": "Billing Email should be specified in a different contact entry with the specific corresponding name." } ] } } }, "required": true } }, "FreshBooks": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": true, "validation": { "warnings": [ { "field": "EmailAddress", "details": "Must be a valid email." } ], "information": [] } }, "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": false }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the customer should be contacted on", "required": false }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the customer", "required": false, "validation": { "warnings": [], "information": [ { "field": "ContactName", "details": "The part of the name preceding the first space will be assigned to first name, the remainder to last name" } ] } }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the customer", "options": [ { "value": "AED", "type": "Array", "displayName": "AED", "required": false }, { "value": "AFN", "type": "Array", "displayName": "AFN", "required": false }, { "value": "ALL", "type": "Array", "displayName": "ALL", "required": false }, { "value": "AMD", "type": "Array", "displayName": "AMD", "required": false }, { "value": "ANG", "type": "Array", "displayName": "ANG", "required": false }, { "value": "AOA", "type": "Array", "displayName": "AOA", "required": false }, { "value": "ARS", "type": "Array", "displayName": "ARS", "required": false }, { "value": "AUD", "type": "Array", "displayName": "AUD", "required": false }, { "value": "AWG", "type": "Array", "displayName": "AWG", "required": false }, { "value": "AZN", "type": "Array", "displayName": "AZN", "required": false }, { "value": "BAM", "type": "Array", "displayName": "BAM", "required": false }, { "value": "BBD", "type": "Array", "displayName": "BBD", "required": false }, { "value": "BDT", "type": "Array", "displayName": "BDT", "required": false }, { "value": "BGN", "type": "Array", "displayName": "BGN", "required": false }, { "value": "BHD", "type": "Array", "displayName": "BHD", "required": false }, { "value": "BIF", "type": "Array", "displayName": "BIF", "required": false }, { "value": "BMD", "type": "Array", "displayName": "BMD", "required": false }, { "value": "BND", "type": "Array", "displayName": "BND", "required": false }, { "value": "BOB", "type": "Array", "displayName": "BOB", "required": false }, { "value": "BRL", "type": "Array", "displayName": "BRL", "required": false }, { "value": "BSD", "type": "Array", "displayName": "BSD", "required": false }, { "value": "BTN", "type": "Array", "displayName": "BTN", "required": false }, { "value": "BWP", "type": "Array", "displayName": "BWP", "required": false }, { "value": "BYR", "type": "Array", "displayName": "BYR", "required": false }, { "value": "BZD", "type": "Array", "displayName": "BZD", "required": false }, { "value": "CAD", "type": "Array", "displayName": "CAD", "required": false }, { "value": "CDF", "type": "Array", "displayName": "CDF", "required": false }, { "value": "CHF", "type": "Array", "displayName": "CHF", "required": false }, { "value": "CLP", "type": "Array", "displayName": "CLP", "required": false }, { "value": "CNY", "type": "Array", "displayName": "CNY", "required": false }, { "value": "COP", "type": "Array", "displayName": "COP", "required": false }, { "value": "CRC", "type": "Array", "displayName": "CRC", "required": false }, { "value": "CUC", "type": "Array", "displayName": "CUC", "required": false }, { "value": "CUP", "type": "Array", "displayName": "CUP", "required": false }, { "value": "CVE", "type": "Array", "displayName": "CVE", "required": false }, { "value": "CZK", "type": "Array", "displayName": "CZK", "required": false }, { "value": "DJF", "type": "Array", "displayName": "DJF", "required": false }, { "value": "DKK", "type": "Array", "displayName": "DKK", "required": false }, { "value": "DOP", "type": "Array", "displayName": "DOP", "required": false }, { "value": "DZD", "type": "Array", "displayName": "DZD", "required": false }, { "value": "EGP", "type": "Array", "displayName": "EGP", "required": false }, { "value": "ERN", "type": "Array", "displayName": "ERN", "required": false }, { "value": "ETB", "type": "Array", "displayName": "ETB", "required": false }, { "value": "EUR", "type": "Array", "displayName": "EUR", "required": false }, { "value": "FJD", "type": "Array", "displayName": "FJD", "required": false }, { "value": "FKP", "type": "Array", "displayName": "FKP", "required": false }, { "value": "GBP", "type": "Array", "displayName": "GBP", "required": false }, { "value": "GEL", "type": "Array", "displayName": "GEL", "required": false }, { "value": "GGP", "type": "Array", "displayName": "GGP", "required": false }, { "value": "GHS", "type": "Array", "displayName": "GHS", "required": false }, { "value": "GIP", "type": "Array", "displayName": "GIP", "required": false }, { "value": "GMD", "type": "Array", "displayName": "GMD", "required": false }, { "value": "GNF", "type": "Array", "displayName": "GNF", "required": false }, { "value": "GTQ", "type": "Array", "displayName": "GTQ", "required": false }, { "value": "GYD", "type": "Array", "displayName": "GYD", "required": false }, { "value": "HKD", "type": "Array", "displayName": "HKD", "required": false }, { "value": "HNL", "type": "Array", "displayName": "HNL", "required": false }, { "value": "HRK", "type": "Array", "displayName": "HRK", "required": false }, { "value": "HTG", "type": "Array", "displayName": "HTG", "required": false }, { "value": "HUF", "type": "Array", "displayName": "HUF", "required": false }, { "value": "IDR", "type": "Array", "displayName": "IDR", "required": false }, { "value": "ILS", "type": "Array", "displayName": "ILS", "required": false }, { "value": "IMP", "type": "Array", "displayName": "IMP", "required": false }, { "value": "INR", "type": "Array", "displayName": "INR", "required": false }, { "value": "IQD", "type": "Array", "displayName": "IQD", "required": false }, { "value": "IRR", "type": "Array", "displayName": "IRR", "required": false }, { "value": "ISK", "type": "Array", "displayName": "ISK", "required": false }, { "value": "JEP", "type": "Array", "displayName": "JEP", "required": false }, { "value": "JMD", "type": "Array", "displayName": "JMD", "required": false }, { "value": "JOD", "type": "Array", "displayName": "JOD", "required": false }, { "value": "JPY", "type": "Array", "displayName": "JPY", "required": false }, { "value": "KES", "type": "Array", "displayName": "KES", "required": false }, { "value": "KGS", "type": "Array", "displayName": "KGS", "required": false }, { "value": "KHR", "type": "Array", "displayName": "KHR", "required": false }, { "value": "KMF", "type": "Array", "displayName": "KMF", "required": false }, { "value": "KPW", "type": "Array", "displayName": "KPW", "required": false }, { "value": "KRW", "type": "Array", "displayName": "KRW", "required": false }, { "value": "KWD", "type": "Array", "displayName": "KWD", "required": false }, { "value": "KYD", "type": "Array", "displayName": "KYD", "required": false }, { "value": "KZT", "type": "Array", "displayName": "KZT", "required": false }, { "value": "LAK", "type": "Array", "displayName": "LAK", "required": false }, { "value": "LBP", "type": "Array", "displayName": "LBP", "required": false }, { "value": "LKR", "type": "Array", "displayName": "LKR", "required": false }, { "value": "LRD", "type": "Array", "displayName": "LRD", "required": false }, { "value": "LSL", "type": "Array", "displayName": "LSL", "required": false }, { "value": "LYD", "type": "Array", "displayName": "LYD", "required": false }, { "value": "MAD", "type": "Array", "displayName": "MAD", "required": false }, { "value": "MDL", "type": "Array", "displayName": "MDL", "required": false }, { "value": "MGA", "type": "Array", "displayName": "MGA", "required": false }, { "value": "MKD", "type": "Array", "displayName": "MKD", "required": false }, { "value": "MMK", "type": "Array", "displayName": "MMK", "required": false }, { "value": "MNT", "type": "Array", "displayName": "MNT", "required": false }, { "value": "MOP", "type": "Array", "displayName": "MOP", "required": false }, { "value": "MRO", "type": "Array", "displayName": "MRO", "required": false }, { "value": "MUR", "type": "Array", "displayName": "MUR", "required": false }, { "value": "MVR", "type": "Array", "displayName": "MVR", "required": false }, { "value": "MWK", "type": "Array", "displayName": "MWK", "required": false }, { "value": "MXN", "type": "Array", "displayName": "MXN", "required": false }, { "value": "MYR", "type": "Array", "displayName": "MYR", "required": false }, { "value": "MZN", "type": "Array", "displayName": "MZN", "required": false }, { "value": "NAD", "type": "Array", "displayName": "NAD", "required": false }, { "value": "NGN", "type": "Array", "displayName": "NGN", "required": false }, { "value": "NIO", "type": "Array", "displayName": "NIO", "required": false }, { "value": "NOK", "type": "Array", "displayName": "NOK", "required": false }, { "value": "NPR", "type": "Array", "displayName": "NPR", "required": false }, { "value": "NZD", "type": "Array", "displayName": "NZD", "required": false }, { "value": "OMR", "type": "Array", "displayName": "OMR", "required": false }, { "value": "PAB", "type": "Array", "displayName": "PAB", "required": false }, { "value": "PEN", "type": "Array", "displayName": "PEN", "required": false }, { "value": "PGK", "type": "Array", "displayName": "PGK", "required": false }, { "value": "PHP", "type": "Array", "displayName": "PHP", "required": false }, { "value": "PKR", "type": "Array", "displayName": "PKR", "required": false }, { "value": "PLN", "type": "Array", "displayName": "PLN", "required": false }, { "value": "PYG", "type": "Array", "displayName": "PYG", "required": false }, { "value": "QAR", "type": "Array", "displayName": "QAR", "required": false }, { "value": "RON", "type": "Array", "displayName": "RON", "required": false }, { "value": "RSD", "type": "Array", "displayName": "RSD", "required": false }, { "value": "RUB", "type": "Array", "displayName": "RUB", "required": false }, { "value": "RWF", "type": "Array", "displayName": "RWF", "required": false }, { "value": "SAR", "type": "Array", "displayName": "SAR", "required": false }, { "value": "SBD", "type": "Array", "displayName": "SBD", "required": false }, { "value": "SCR", "type": "Array", "displayName": "SCR", "required": false }, { "value": "SDG", "type": "Array", "displayName": "SDG", "required": false }, { "value": "SEK", "type": "Array", "displayName": "SEK", "required": false }, { "value": "SGD", "type": "Array", "displayName": "SGD", "required": false }, { "value": "SHP", "type": "Array", "displayName": "SHP", "required": false }, { "value": "SLL", "type": "Array", "displayName": "SLL", "required": false }, { "value": "SOS", "type": "Array", "displayName": "SOS", "required": false }, { "value": "SPL", "type": "Array", "displayName": "SPL", "required": false }, { "value": "SRD", "type": "Array", "displayName": "SRD", "required": false }, { "value": "STD", "type": "Array", "displayName": "STD", "required": false }, { "value": "SVC", "type": "Array", "displayName": "SVC", "required": false }, { "value": "SYP", "type": "Array", "displayName": "SYP", "required": false }, { "value": "SZL", "type": "Array", "displayName": "SZL", "required": false }, { "value": "THB", "type": "Array", "displayName": "THB", "required": false }, { "value": "TJS", "type": "Array", "displayName": "TJS", "required": false }, { "value": "TMT", "type": "Array", "displayName": "TMT", "required": false }, { "value": "TND", "type": "Array", "displayName": "TND", "required": false }, { "value": "TOP", "type": "Array", "displayName": "TOP", "required": false }, { "value": "TRY", "type": "Array", "displayName": "TRY", "required": false }, { "value": "TTD", "type": "Array", "displayName": "TTD", "required": false }, { "value": "TVD", "type": "Array", "displayName": "TVD", "required": false }, { "value": "TWD", "type": "Array", "displayName": "TWD", "required": false }, { "value": "TZS", "type": "Array", "displayName": "TZS", "required": false }, { "value": "UAH", "type": "Array", "displayName": "UAH", "required": false }, { "value": "UGX", "type": "Array", "displayName": "UGX", "required": false }, { "value": "USD", "type": "Array", "displayName": "USD", "required": false }, { "value": "UYU", "type": "Array", "displayName": "UYU", "required": false }, { "value": "UZS", "type": "Array", "displayName": "UZS", "required": false }, { "value": "VEF", "type": "Array", "displayName": "VEF", "required": false }, { "value": "VND", "type": "Array", "displayName": "VND", "required": false }, { "value": "VUV", "type": "Array", "displayName": "VUV", "required": false }, { "value": "WST", "type": "Array", "displayName": "WST", "required": false }, { "value": "XAF", "type": "Array", "displayName": "XAF", "required": false }, { "value": "XCD", "type": "Array", "displayName": "XCD", "required": false }, { "value": "XDR", "type": "Array", "displayName": "XDR", "required": false }, { "value": "XOF", "type": "Array", "displayName": "XOF", "required": false }, { "value": "XPF", "type": "Array", "displayName": "XPF", "required": false }, { "value": "YER", "type": "Array", "displayName": "YER", "required": false }, { "value": "ZAR", "type": "Array", "displayName": "ZAR", "required": false }, { "value": "ZMW", "type": "Array", "displayName": "ZMW", "required": false }, { "value": "ZWD", "type": "Array", "displayName": "ZWD", "required": false } ], "required": false }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": false }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false } }, "required": false, "validation": { "warnings": [ { "field": "Addresses", "details": "No more than two addresses can be added" } ], "information": [] } }, "contacts": { "type": "Array", "displayName": "Contacts", "description": "A collection of alternative contacts for the customer", "properties": { "email": { "type": "String", "displayName": "Email", "description": "The email address for the contact", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the contact", "required": true, "validation": { "warnings": [], "information": [ { "field": "Contacts.Name", "details": "The part of the name preceding the first space will be assigned to first name, the remainder to last name" } ] } }, "phone": { "type": "Array", "displayName": "Phone", "description": "A collection of phone numbers for the contact", "properties": { "number": { "type": "String", "displayName": "Number", "description": "The full number including country, and area code where applicable", "required": true } }, "required": true, "validation": { "warnings": [ { "field": "Contacts.Phone", "details": "No more than two phone numbers per contact can be added" } ], "information": [] } } }, "required": false } }, "required": true } }, "MYOB AccountRight and Essentials": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": true, "validation": { "warnings": [ { "field": "CustomerName", "details": "Must have a length between 1 and 50 characters" } ], "information": [] } }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the customer", "required": false, "validation": { "warnings": [ { "field": "ContactName", "details": "Must have a length between 1 and 25 characters" } ], "information": [] } }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": false, "validation": { "warnings": [ { "field": "EmailAddress", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the customer should be contacted on", "required": false, "validation": { "warnings": [ { "field": "Phone", "details": "Must have a length between 1 and 21 characters" } ], "information": [] } }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "options": [ { "value": "Billing", "type": "String", "displayName": "Billing", "required": false }, { "value": "Delivery", "type": "String", "displayName": "Delivery", "required": false } ], "required": true }, "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line1", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [ { "field": "Addresses.City", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [ { "field": "Addresses.Region", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.PostalCode", "details": "Must have a length between 1 and 11 characters" } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } } }, "required": false }, "contacts": { "type": "Array", "displayName": "Contacts", "description": "A collection of alternative contacts for the customer", "properties": { "name": { "type": "String", "displayName": "Name", "description": "The name of the contact", "required": false, "validation": { "warnings": [ { "field": "Contacts.Name", "details": "Must have a length between 1 and 25 characters" } ], "information": [] } }, "email": { "type": "String", "displayName": "Email", "description": "The email address for the contact", "required": false, "validation": { "warnings": [ { "field": "Contacts.Email", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } }, "phone": { "type": "Array", "displayName": "Phone", "description": "A collection of phone numbers for the contact", "properties": { "number": { "type": "String", "displayName": "Number", "description": "The full number including country, and area code where applicable", "required": true, "validation": { "warnings": [ { "field": "Phone.Number", "details": "Must have a length between 1 and 21 characters" } ], "information": [] } }, "type": { "type": "String", "displayName": "Phone Type", "description": "The type of phone number", "options": [ { "value": "Unknown", "type": "String", "displayName": "Unknown", "required": false }, { "value": "Fax", "type": "String", "displayName": "Fax", "required": false } ], "required": false, "validation": { "warnings": [], "information": [ { "field": "Phone.Type", "details": "Do not set or set to Unknown for phone numbers; set to Fax for fax number" } ] } } }, "required": false, "validation": { "warnings": [ { "field": "Contacts.Phone", "details": "Must contain a maximum of 3 phone numbers" }, { "field": "Contacts.Phone", "details": "Must contain a maximum of 1 fax number" } ], "information": [] } }, "address": { "type": "Object", "displayName": "Address", "description": "The address for the contact", "properties": { "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "options": [ { "value": "Billing", "type": "String", "displayName": "Billing", "required": false }, { "value": "Delivery", "type": "String", "displayName": "Delivery", "required": false }, { "value": "Unknown", "type": "String", "displayName": "Unknown", "required": false } ], "required": true }, "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [ { "field": "Address.Line1", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [ { "field": "Address.City", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [ { "field": "Address.Region", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [ { "field": "Address.PostalCode", "details": "Must have a length between 1 and 11 characters" } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Address.Country", "details": "Must have a length between 1 and 255 characters" } ], "information": [] } } }, "required": true } }, "required": false, "validation": { "warnings": [ { "field": "Contacts", "details": "Must have at most five contacts" }, { "field": "Contacts", "details": "Must have at least one piece of contact information" } ], "information": [] } }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The customer's registration number", "required": false, "validation": { "warnings": [ { "field": "RegistrationNumber", "details": "Must be a valid ABN (Australian Business Number) in the format XX XXX XXX XXX" }, { "field": "RegistrationNumber", "details": "Must have a length of 14 characters" } ], "information": [] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": false, "validation": { "warnings": [ { "field": "TaxNumber", "details": "Must have a length between 1 and 19 characters" } ], "information": [] } }, "status": { "type": "String", "displayName": "Customer Status", "description": "The current state of the customer", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": true }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": false }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the customer", "required": false }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the customer should be contacted on", "required": false }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": false }, "status": { "type": "String", "displayName": "Customer Status", "description": "The current state of the customer", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "options": [ { "value": "Billing", "type": "String", "displayName": "Billing", "required": false }, { "value": "Delivery", "type": "String", "displayName": "Delivery", "required": false }, { "value": "Unknown", "type": "String", "displayName": "Unknown", "required": false } ], "required": true }, "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": true, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Must be a two letter Country ISO code" } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false } }, "required": false, "validation": { "warnings": [ { "field": "Addresses", "details": "Only one each of Billing and Delivery addresses can be provided" } ], "information": [ { "field": "Addresses", "details": "Multiple addresses of Unknown type may be provided" } ] } }, "contacts": { "type": "Array", "displayName": "Contacts", "description": "A collection of alternative contacts for the customer", "properties": { "name": { "type": "String", "displayName": "Name", "description": "The name of the contact", "required": true }, "email": { "type": "String", "displayName": "Email", "description": "The email address for the contact", "required": false }, "phone": { "type": "Array", "displayName": "Phone", "description": "A collection of phone numbers for the contact", "properties": { "type": { "type": "String", "displayName": "Phone Type", "description": "The type of phone number", "required": true }, "number": { "type": "String", "displayName": "Number", "description": "The full number including country, and area code where applicable", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "Contacts.Phone", "details": "Must be a maximum of four distinct number types" } ], "information": [] } }, "status": { "type": "String", "displayName": "Contact Status", "description": "The current state of the contact", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true } }, "required": false } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": true, "validation": { "warnings": [ { "field": "CustomerName", "details": "Max length of 41 characters." } ], "information": [] } }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the customer", "required": false, "validation": { "warnings": [ { "field": "ContactName", "details": "Max length of 25 characters for first and last names" } ], "information": [] } }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the customer should be contacted on", "required": false, "validation": { "warnings": [ { "field": "Phone", "details": "Max length of 21 characters" } ], "information": [] } }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": false }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The customer's registration number", "required": false, "validation": { "warnings": [ { "field": "RegistrationNumber", "details": "Max length of 15 characters." } ], "information": [] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": false, "validation": { "warnings": [ { "field": "TaxNumber", "details": "Max length of 30 characters." } ], "information": [] } }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the customer", "required": false, "validation": { "warnings": [ { "field": "DefaultCurrency", "details": "Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company" }, { "field": "DefaultCurrency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "DefaultCurrency", "details": "If not set, will default to the base currency of the QuickBooks Desktop company" } ] } }, "status": { "type": "String", "displayName": "Customer Status", "description": "The current state of the customer", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line1", "details": "Max length of 41 characters." } ], "information": [] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line2", "details": "Max length of 41 characters." } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [ { "field": "Addresses.City", "details": "Max length of 31 characters." } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [ { "field": "Addresses.Region", "details": "Max length of 21 characters." } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Max length of 31 characters." } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.PostalCode", "details": "Max length of 13 characters." } ], "information": [] } }, "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "options": [ { "value": "Billing", "type": "String", "displayName": "Billing Address", "required": false }, { "value": "Delivery", "type": "String", "displayName": "Delivery Address", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Addresses.Type", "details": "Only 1 address each of type(s) Billing/Delivery may be specified." } ] } } }, "required": false } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": true, "validation": { "warnings": [ { "field": "CustomerName", "details": "Names must be unique across customers, suppliers and employees" } ], "information": [] } }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the customer should be contacted on", "required": false, "validation": { "warnings": [ { "field": "Phone", "details": "Country, area, and number are space separated" } ], "information": [] } }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": false }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The customer's registration number", "required": false }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": false }, "status": { "type": "String", "displayName": "Customer Status", "description": "The current state of the customer", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line1", "details": "Max length of 500 characters." } ], "information": [] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line2", "details": "Max length of 500 characters." } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [ { "field": "Addresses.City", "details": "Max length of 255 characters." } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [ { "field": "Addresses.Region", "details": "Max length of 225 characters." } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Max length of 50 characters." } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.PostalCode", "details": "Only English alphabet characters are permitted." }, { "field": "Addresses.PostalCode", "details": "Max length of 50 characters." } ], "information": [] } }, "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "options": [ { "value": "Billing", "type": "String", "displayName": "Billing Address", "required": false }, { "value": "Delivery", "type": "String", "displayName": "Delivery Address", "required": false } ], "required": false, "validation": { "warnings": [ { "field": "Addresses.Type", "details": "Billing = POBOX, Delivery/Unknown = DELIVERY" } ], "information": [] } } }, "required": false }, "contacts": { "type": "Array", "displayName": "Contacts", "description": "A collection of alternative contacts for the customer", "properties": { "phone": { "type": "Array", "displayName": "Phone", "description": "A collection of phone numbers for the contact", "properties": { "type": { "type": "String", "displayName": "Phone Type", "description": "The type of phone number", "required": true }, "number": { "type": "String", "displayName": "Number", "description": "The full number including country, and area code where applicable", "required": true } }, "required": false } }, "required": false }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the customer", "required": false, "validation": { "warnings": [ { "field": "DefaultCurrency", "details": "Default currency can only differ from the base company currency if multi-currency is enabled for the company." } ], "information": [] } } }, "required": true } }, "QuickBooks Online": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": true, "validation": { "warnings": [ { "field": "CustomerName", "details": "Names must be unique across customers, suppliers and employees" } ], "information": [] } }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the customer should be contacted on", "required": false, "validation": { "warnings": [ { "field": "Phone", "details": "Country, area, and number are space separated" } ], "information": [] } }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": false }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The customer's registration number", "required": false }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": false }, "status": { "type": "String", "displayName": "Customer Status", "description": "The current state of the customer", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line1", "details": "Max length of 500 characters." } ], "information": [] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line2", "details": "Max length of 500 characters." } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [ { "field": "Addresses.City", "details": "Max length of 255 characters." } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [ { "field": "Addresses.Region", "details": "Max length of 225 characters." } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Max length of 50 characters." } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.PostalCode", "details": "Only English alphabet characters are permitted." }, { "field": "Addresses.PostalCode", "details": "Max length of 50 characters." } ], "information": [] } }, "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "options": [ { "value": "Billing", "type": "String", "displayName": "Billing Address", "required": false }, { "value": "Delivery", "type": "String", "displayName": "Delivery Address", "required": false } ], "required": false, "validation": { "warnings": [ { "field": "Addresses.Type", "details": "Billing = POBOX, Delivery/Unknown = DELIVERY" } ], "information": [] } } }, "required": false }, "contacts": { "type": "Array", "displayName": "Contacts", "description": "A collection of alternative contacts for the customer", "properties": { "phone": { "type": "Array", "displayName": "Phone", "description": "A collection of phone numbers for the contact", "properties": { "type": { "type": "String", "displayName": "Phone Type", "description": "The type of phone number", "required": true }, "number": { "type": "String", "displayName": "Number", "description": "The full number including country, and area code where applicable", "required": true } }, "required": false } }, "required": false }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the customer", "required": false, "validation": { "warnings": [ { "field": "DefaultCurrency", "details": "Default currency can only differ from the base company currency if multi-currency is enabled for the company." } ], "information": [] } } }, "required": true } }, "Sage 50 (UK)": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "id": { "type": "String", "displayName": "Id", "description": "ID of the customer.", "required": true, "validation": { "warnings": [ { "field": "id", "details": "The customer ID must be unique, contain no spaces and have a maximum of 8 characters." } ], "information": [ { "field": "id", "details": "The customer ID must be all Uppercase, if it is not, it will be converted to Uppercase before pushing." } ] } }, "customerName": { "type": "String", "displayName": "Name", "description": "Name of the customer.", "required": true, "validation": { "warnings": [ { "field": "customerName", "details": "The customer name can have a maximum of 60 characters" } ], "information": [] } }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the customer.", "required": false, "validation": { "warnings": [ { "field": "contactName", "details": "The contact name can have a maximum of 30 characters" } ], "information": [] } }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The email address that the customer may be contacted on.", "required": false, "validation": { "warnings": [ { "field": "emailAddress", "details": "The email address can have a maximum of 255 characters" } ], "information": [] } }, "phone": { "type": "String", "displayName": "Telephone", "description": "The telephone number that the customer may be contacted on.", "required": false, "validation": { "warnings": [ { "field": "phone", "details": "The phone can have a maximum of 30 characters" } ], "information": [] } }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The currency in which the customer will operate.", "required": false, "validation": { "warnings": [], "information": [ { "field": "defaultCurrency", "details": "If not provided, the currency will default to the company's base currency." } ] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "Legal company registration identifier.", "required": false, "validation": { "warnings": [ { "field": "taxNumber", "details": "The tax number can have a maximum of 20 characters" } ], "information": [] } }, "status": { "type": "String", "displayName": "Status", "description": "The status of the customer.", "options": [ { "value": "Active", "type": "String", "displayName": "Active Status", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived Status", "required": false } ], "required": false }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "Contact addresses for the customer.", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "Line 1 of the customer address.", "required": true }, "line2": { "type": "String", "displayName": "Line 2", "description": "Line 2 of the customer address.", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The city of the customer address.", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The region of the customer address.", "required": false }, "countryCode": { "type": "String", "displayName": "Country Code", "description": "The country code of the customer address", "required": true, "validation": { "warnings": [ { "details": "The country code must be a valid ISO 3166 value" } ], "information": [ { "details": "XX is a valid country code for 'Unknown Country'" } ] } }, "postalCode": { "type": "String", "displayName": "Postal code", "description": "Post or Zip code for the address.", "required": false }, "type": { "type": "String", "displayName": "Type", "description": "The type of address as it related to the customer.", "options": [ { "value": "Delivery", "type": "String", "displayName": "Delivery Address", "required": false }, { "value": "Unknown", "type": "String", "displayName": "Unknown Address", "required": false } ], "required": false, "validation": { "warnings": [], "information": [ { "field": "addresses.type", "details": "If the address is available in 'SALES_DEL_ADDR' table then the address type will be Delivery. All others will default to type 'Unknown'" } ] } } }, "required": false, "validation": { "warnings": [ { "field": "addresses", "details": "Only one address can be included in the Addresses array." } ], "information": [] } } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company." } ] } } }, "Sage Business Cloud Accounting": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": true }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the customer", "required": false, "validation": { "warnings": [], "information": [ { "field": "DefaultCurrency", "details": "If Customer.DefaultCurrency is not provided; will be mapped from company base currency" } ] } }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the customer", "required": false }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": false }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the customer should be contacted on", "required": false }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": false }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": true, "validation": { "warnings": [ { "field": "Addresses.Line1", "details": "If you're adding an address for this customer, you must also include the first line" } ], "information": [] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "options": [ { "value": "Afghanistan (AF)", "type": "String", "displayName": "Afghanistan (AF)", "required": false }, { "value": "Albania (AL)", "type": "String", "displayName": "Albania (AL)", "required": false }, { "value": "Algeria (DZ)", "type": "String", "displayName": "Algeria (DZ)", "required": false }, { "value": "Andorra (AD)", "type": "String", "displayName": "Andorra (AD)", "required": false }, { "value": "Angola (AO)", "type": "String", "displayName": "Angola (AO)", "required": false }, { "value": "Argentina (AR)", "type": "String", "displayName": "Argentina (AR)", "required": false }, { "value": "Armenia (AM)", "type": "String", "displayName": "Armenia (AM)", "required": false }, { "value": "Aruba (AW)", "type": "String", "displayName": "Aruba (AW)", "required": false }, { "value": "Australia (AU)", "type": "String", "displayName": "Australia (AU)", "required": false }, { "value": "Austria (AT)", "type": "String", "displayName": "Austria (AT)", "required": false }, { "value": "Azerbaijan (AZ)", "type": "String", "displayName": "Azerbaijan (AZ)", "required": false }, { "value": "Bahamas (BS)", "type": "String", "displayName": "Bahamas (BS)", "required": false }, { "value": "Bahrain (BH)", "type": "String", "displayName": "Bahrain (BH)", "required": false }, { "value": "Bangladesh (BD)", "type": "String", "displayName": "Bangladesh (BD)", "required": false }, { "value": "Barbados (BB)", "type": "String", "displayName": "Barbados (BB)", "required": false }, { "value": "Belarus (BY)", "type": "String", "displayName": "Belarus (BY)", "required": false }, { "value": "Belgium (BE)", "type": "String", "displayName": "Belgium (BE)", "required": false }, { "value": "Belize (BZ)", "type": "String", "displayName": "Belize (BZ)", "required": false }, { "value": "Benin (BJ)", "type": "String", "displayName": "Benin (BJ)", "required": false }, { "value": "Bermuda (BM)", "type": "String", "displayName": "Bermuda (BM)", "required": false }, { "value": "Bhutan (BT)", "type": "String", "displayName": "Bhutan (BT)", "required": false }, { "value": "Bolivia (BO)", "type": "String", "displayName": "Bolivia (BO)", "required": false }, { "value": "Bosnia and Herzegovina (BA)", "type": "String", "displayName": "Bosnia and Herzegovina (BA)", "required": false }, { "value": "Botswana (BW)", "type": "String", "displayName": "Botswana (BW)", "required": false }, { "value": "Brazil (BR)", "type": "String", "displayName": "Brazil (BR)", "required": false }, { "value": "British Virgin Islands (VG)", "type": "String", "displayName": "British Virgin Islands (VG)", "required": false }, { "value": "Brunei Darussalam (BN)", "type": "String", "displayName": "Brunei Darussalam (BN)", "required": false }, { "value": "Bulgaria (BG)", "type": "String", "displayName": "Bulgaria (BG)", "required": false }, { "value": "Burkina Faso (BF)", "type": "String", "displayName": "Burkina Faso (BF)", "required": false }, { "value": "Burundi (BI)", "type": "String", "displayName": "Burundi (BI)", "required": false }, { "value": "Cambodia (KH)", "type": "String", "displayName": "Cambodia (KH)", "required": false }, { "value": "Cameroon (CM)", "type": "String", "displayName": "Cameroon (CM)", "required": false }, { "value": "Canada (CA)", "type": "String", "displayName": "Canada (CA)", "required": false }, { "value": "Cape Verde (CV)", "type": "String", "displayName": "Cape Verde (CV)", "required": false }, { "value": "Cayman Islands (KY)", "type": "String", "displayName": "Cayman Islands (KY)", "required": false }, { "value": "Central African Republic (CF)", "type": "String", "displayName": "Central African Republic (CF)", "required": false }, { "value": "Chad (TD)", "type": "String", "displayName": "Chad (TD)", "required": false }, { "value": "Chile (CL)", "type": "String", "displayName": "Chile (CL)", "required": false }, { "value": "China (CN)", "type": "String", "displayName": "China (CN)", "required": false }, { "value": "Colombia (CO)", "type": "String", "displayName": "Colombia (CO)", "required": false }, { "value": "Comoros (KM)", "type": "String", "displayName": "Comoros (KM)", "required": false }, { "value": "Congo (CG)", "type": "String", "displayName": "Congo (CG)", "required": false }, { "value": "Costa Rica (CR)", "type": "String", "displayName": "Costa Rica (CR)", "required": false }, { "value": "Croatia (HR)", "type": "String", "displayName": "Croatia (HR)", "required": false }, { "value": "Cuba (CU)", "type": "String", "displayName": "Cuba (CU)", "required": false }, { "value": "Cura�ao (CW)", "type": "String", "displayName": "Cura�ao (CW)", "required": false }, { "value": "Cyprus (CY)", "type": "String", "displayName": "Cyprus (CY)", "required": false }, { "value": "Czech Republic (CZ)", "type": "String", "displayName": "Czech Republic (CZ)", "required": false }, { "value": "Democratic Republic of the Congo (CD)", "type": "String", "displayName": "Democratic Republic of the Congo (CD)", "required": false }, { "value": "Denmark (DK)", "type": "String", "displayName": "Denmark (DK)", "required": false }, { "value": "Djibouti (DJ)", "type": "String", "displayName": "Djibouti (DJ)", "required": false }, { "value": "Dominica (DM)", "type": "String", "displayName": "Dominica (DM)", "required": false }, { "value": "Dominican Republic (DO)", "type": "String", "displayName": "Dominican Republic (DO)", "required": false }, { "value": "East Timor (TP)", "type": "String", "displayName": "East Timor (TP)", "required": false }, { "value": "Ecuador (EC)", "type": "String", "displayName": "Ecuador (EC)", "required": false }, { "value": "Egypt (EG)", "type": "String", "displayName": "Egypt (EG)", "required": false }, { "value": "El Salvador (SV)", "type": "String", "displayName": "El Salvador (SV)", "required": false }, { "value": "Equatorial Guinea (GQ)", "type": "String", "displayName": "Equatorial Guinea (GQ)", "required": false }, { "value": "Eritrea (ER)", "type": "String", "displayName": "Eritrea (ER)", "required": false }, { "value": "Estonia (EE)", "type": "String", "displayName": "Estonia (EE)", "required": false }, { "value": "Ethiopia (ET)", "type": "String", "displayName": "Ethiopia (ET)", "required": false }, { "value": "Falkland Islands (Malvinas) (FK)", "type": "String", "displayName": "Falkland Islands (Malvinas) (FK)", "required": false }, { "value": "Federated States of Micronesia (FM)", "type": "String", "displayName": "Federated States of Micronesia (FM)", "required": false }, { "value": "Fiji (FJ)", "type": "String", "displayName": "Fiji (FJ)", "required": false }, { "value": "Finland (FI)", "type": "String", "displayName": "Finland (FI)", "required": false }, { "value": "France (FR)", "type": "String", "displayName": "France (FR)", "required": false }, { "value": "French Polynesia (PF)", "type": "String", "displayName": "French Polynesia (PF)", "required": false }, { "value": "Gabon (GA)", "type": "String", "displayName": "Gabon (GA)", "required": false }, { "value": "Gambia (GM)", "type": "String", "displayName": "Gambia (GM)", "required": false }, { "value": "Georgia (GE)", "type": "String", "displayName": "Georgia (GE)", "required": false }, { "value": "Germany (DE)", "type": "String", "displayName": "Germany (DE)", "required": false }, { "value": "Ghana (GH)", "type": "String", "displayName": "Ghana (GH)", "required": false }, { "value": "Gibraltar (GI)", "type": "String", "displayName": "Gibraltar (GI)", "required": false }, { "value": "Greece (GR)", "type": "String", "displayName": "Greece (GR)", "required": false }, { "value": "Greenland (GL)", "type": "String", "displayName": "Greenland (GL)", "required": false }, { "value": "Grenada (GD)", "type": "String", "displayName": "Grenada (GD)", "required": false }, { "value": "Guadaloupe (GP)", "type": "String", "displayName": "Guadaloupe (GP)", "required": false }, { "value": "Guam (GU)", "type": "String", "displayName": "Guam (GU)", "required": false }, { "value": "Guatemala (GT)", "type": "String", "displayName": "Guatemala (GT)", "required": false }, { "value": "Guernsey (GG)", "type": "String", "displayName": "Guernsey (GG)", "required": false }, { "value": "Guinea (GN)", "type": "String", "displayName": "Guinea (GN)", "required": false }, { "value": "Guinea-Bissau (GW)", "type": "String", "displayName": "Guinea-Bissau (GW)", "required": false }, { "value": "Guyana (GY)", "type": "String", "displayName": "Guyana (GY)", "required": false }, { "value": "Haiti (HT)", "type": "String", "displayName": "Haiti (HT)", "required": false }, { "value": "Honduras (HN)", "type": "String", "displayName": "Honduras (HN)", "required": false }, { "value": "Hong Kong (HK)", "type": "String", "displayName": "Hong Kong (HK)", "required": false }, { "value": "Hungary (HU)", "type": "String", "displayName": "Hungary (HU)", "required": false }, { "value": "Iceland (IS)", "type": "String", "displayName": "Iceland (IS)", "required": false }, { "value": "India (IN)", "type": "String", "displayName": "India (IN)", "required": false }, { "value": "Indonesia (ID)", "type": "String", "displayName": "Indonesia (ID)", "required": false }, { "value": "Iran (IR)", "type": "String", "displayName": "Iran (IR)", "required": false }, { "value": "Iraq (IQ)", "type": "String", "displayName": "Iraq (IQ)", "required": false }, { "value": "Ireland (IE)", "type": "String", "displayName": "Ireland (IE)", "required": false }, { "value": "Israel (IL)", "type": "String", "displayName": "Israel (IL)", "required": false }, { "value": "Italy (IT)", "type": "String", "displayName": "Italy (IT)", "required": false }, { "value": "Ivory Coast (CI)", "type": "String", "displayName": "Ivory Coast (CI)", "required": false }, { "value": "Jamaica (JM)", "type": "String", "displayName": "Jamaica (JM)", "required": false }, { "value": "Japan (JP)", "type": "String", "displayName": "Japan (JP)", "required": false }, { "value": "Jersey (JE)", "type": "String", "displayName": "Jersey (JE)", "required": false }, { "value": "Jordan (JO)", "type": "String", "displayName": "Jordan (JO)", "required": false }, { "value": "Kazakhstan (KZ)", "type": "String", "displayName": "Kazakhstan (KZ)", "required": false }, { "value": "Kenya (KE)", "type": "String", "displayName": "Kenya (KE)", "required": false }, { "value": "Kuwait (KW)", "type": "String", "displayName": "Kuwait (KW)", "required": false }, { "value": "Kyrgyzstan (KG)", "type": "String", "displayName": "Kyrgyzstan (KG)", "required": false }, { "value": "Laos (LA)", "type": "String", "displayName": "Laos (LA)", "required": false }, { "value": "Latvia (LV)", "type": "String", "displayName": "Latvia (LV)", "required": false }, { "value": "Lebanon (LB)", "type": "String", "displayName": "Lebanon (LB)", "required": false }, { "value": "Lesotho (LS)", "type": "String", "displayName": "Lesotho (LS)", "required": false }, { "value": "Liberia (LR)", "type": "String", "displayName": "Liberia (LR)", "required": false }, { "value": "Libya (LY)", "type": "String", "displayName": "Libya (LY)", "required": false }, { "value": "Liechtenstein (LI)", "type": "String", "displayName": "Liechtenstein (LI)", "required": false }, { "value": "Lithuania (LT)", "type": "String", "displayName": "Lithuania (LT)", "required": false }, { "value": "Luxembourg (LU)", "type": "String", "displayName": "Luxembourg (LU)", "required": false }, { "value": "Macau (MO)", "type": "String", "displayName": "Macau (MO)", "required": false }, { "value": "Macedonia (MK)", "type": "String", "displayName": "Macedonia (MK)", "required": false }, { "value": "Madagascar (MG)", "type": "String", "displayName": "Madagascar (MG)", "required": false }, { "value": "Malawi (MW)", "type": "String", "displayName": "Malawi (MW)", "required": false }, { "value": "Malaysia (MY)", "type": "String", "displayName": "Malaysia (MY)", "required": false }, { "value": "Maldives (MV)", "type": "String", "displayName": "Maldives (MV)", "required": false }, { "value": "Mali (ML)", "type": "String", "displayName": "Mali (ML)", "required": false }, { "value": "Malta (MT)", "type": "String", "displayName": "Malta (MT)", "required": false }, { "value": "Mauritania (MR)", "type": "String", "displayName": "Mauritania (MR)", "required": false }, { "value": "Mauritius (MU)", "type": "String", "displayName": "Mauritius (MU)", "required": false }, { "value": "Mexico (MX)", "type": "String", "displayName": "Mexico (MX)", "required": false }, { "value": "Moldova (MD)", "type": "String", "displayName": "Moldova (MD)", "required": false }, { "value": "Monaco (MC)", "type": "String", "displayName": "Monaco (MC)", "required": false }, { "value": "Mongolia (MN)", "type": "String", "displayName": "Mongolia (MN)", "required": false }, { "value": "Montenegro (ME)", "type": "String", "displayName": "Montenegro (ME)", "required": false }, { "value": "Morocco (MA)", "type": "String", "displayName": "Morocco (MA)", "required": false }, { "value": "Mozambique (MZ)", "type": "String", "displayName": "Mozambique (MZ)", "required": false }, { "value": "Myanmar (MM)", "type": "String", "displayName": "Myanmar (MM)", "required": false }, { "value": "Namibia (NA)", "type": "String", "displayName": "Namibia (NA)", "required": false }, { "value": "Nepal (NP)", "type": "String", "displayName": "Nepal (NP)", "required": false }, { "value": "Netherlands (NL)", "type": "String", "displayName": "Netherlands (NL)", "required": false }, { "value": "Netherlands Antilles (AN)", "type": "String", "displayName": "Netherlands Antilles (AN)", "required": false }, { "value": "New Caledonia (NC)", "type": "String", "displayName": "New Caledonia (NC)", "required": false }, { "value": "New Zealand (NZ)", "type": "String", "displayName": "New Zealand (NZ)", "required": false }, { "value": "Nicaragua (NI)", "type": "String", "displayName": "Nicaragua (NI)", "required": false }, { "value": "Niger (NE)", "type": "String", "displayName": "Niger (NE)", "required": false }, { "value": "Nigeria (NG)", "type": "String", "displayName": "Nigeria (NG)", "required": false }, { "value": "North Korea (KP)", "type": "String", "displayName": "North Korea (KP)", "required": false }, { "value": "Norway (NO)", "type": "String", "displayName": "Norway (NO)", "required": false }, { "value": "Oman (OM)", "type": "String", "displayName": "Oman (OM)", "required": false }, { "value": "Pakistan (PK)", "type": "String", "displayName": "Pakistan (PK)", "required": false }, { "value": "Panama (PA)", "type": "String", "displayName": "Panama (PA)", "required": false }, { "value": "Papua New Guinea (PG)", "type": "String", "displayName": "Papua New Guinea (PG)", "required": false }, { "value": "Paraguay (PY)", "type": "String", "displayName": "Paraguay (PY)", "required": false }, { "value": "Peru (PE)", "type": "String", "displayName": "Peru (PE)", "required": false }, { "value": "Philippines (PH)", "type": "String", "displayName": "Philippines (PH)", "required": false }, { "value": "Poland (PL)", "type": "String", "displayName": "Poland (PL)", "required": false }, { "value": "Portugal (PT)", "type": "String", "displayName": "Portugal (PT)", "required": false }, { "value": "Puerto Rico (PR)", "type": "String", "displayName": "Puerto Rico (PR)", "required": false }, { "value": "Qatar (QA)", "type": "String", "displayName": "Qatar (QA)", "required": false }, { "value": "Romania (RO)", "type": "String", "displayName": "Romania (RO)", "required": false }, { "value": "Russia (RU)", "type": "String", "displayName": "Russia (RU)", "required": false }, { "value": "Rwanda (RW)", "type": "String", "displayName": "Rwanda (RW)", "required": false }, { "value": "Saint Kitts and Nevis (KN)", "type": "String", "displayName": "Saint Kitts and Nevis (KN)", "required": false }, { "value": "Saint Pierre and Miquelon (PM)", "type": "String", "displayName": "Saint Pierre and Miquelon (PM)", "required": false }, { "value": "Samoa (WS)", "type": "String", "displayName": "Samoa (WS)", "required": false }, { "value": "San Marino (SM)", "type": "String", "displayName": "San Marino (SM)", "required": false }, { "value": "Sao Tome and Principe (ST)", "type": "String", "displayName": "Sao Tome and Principe (ST)", "required": false }, { "value": "Saudi Arabia (SA)", "type": "String", "displayName": "Saudi Arabia (SA)", "required": false }, { "value": "Senegal (SN)", "type": "String", "displayName": "Senegal (SN)", "required": false }, { "value": "Serbia (RS)", "type": "String", "displayName": "Serbia (RS)", "required": false }, { "value": "Seychelles (SC)", "type": "String", "displayName": "Seychelles (SC)", "required": false }, { "value": "Sierra Leone (SL)", "type": "String", "displayName": "Sierra Leone (SL)", "required": false }, { "value": "Singapore (SG)", "type": "String", "displayName": "Singapore (SG)", "required": false }, { "value": "Slovakia (SK)", "type": "String", "displayName": "Slovakia (SK)", "required": false }, { "value": "Slovenia (SI)", "type": "String", "displayName": "Slovenia (SI)", "required": false }, { "value": "Solomon Islands (SB)", "type": "String", "displayName": "Solomon Islands (SB)", "required": false }, { "value": "Somalia (SO)", "type": "String", "displayName": "Somalia (SO)", "required": false }, { "value": "South Africa (ZA)", "type": "String", "displayName": "South Africa (ZA)", "required": false }, { "value": "South Korea (KR)", "type": "String", "displayName": "South Korea (KR)", "required": false }, { "value": "Spain (ES)", "type": "String", "displayName": "Spain (ES)", "required": false }, { "value": "Sri Lanka (LK)", "type": "String", "displayName": "Sri Lanka (LK)", "required": false }, { "value": "St. Lucia (LC)", "type": "String", "displayName": "St. Lucia (LC)", "required": false }, { "value": "Sudan (SD)", "type": "String", "displayName": "Sudan (SD)", "required": false }, { "value": "Surinam (SR)", "type": "String", "displayName": "Surinam (SR)", "required": false }, { "value": "Swaziland (SZ)", "type": "String", "displayName": "Swaziland (SZ)", "required": false }, { "value": "Sweden (SE)", "type": "String", "displayName": "Sweden (SE)", "required": false }, { "value": "Switzerland (CH)", "type": "String", "displayName": "Switzerland (CH)", "required": false }, { "value": "Syria (SY)", "type": "String", "displayName": "Syria (SY)", "required": false }, { "value": "Taiwan (TW)", "type": "String", "displayName": "Taiwan (TW)", "required": false }, { "value": "Tajikistan (TJ)", "type": "String", "displayName": "Tajikistan (TJ)", "required": false }, { "value": "Tanzania (TZ)", "type": "String", "displayName": "Tanzania (TZ)", "required": false }, { "value": "Thailand (TH)", "type": "String", "displayName": "Thailand (TH)", "required": false }, { "value": "Togo (TG)", "type": "String", "displayName": "Togo (TG)", "required": false }, { "value": "Tonga (TO)", "type": "String", "displayName": "Tonga (TO)", "required": false }, { "value": "Trinidad and Tobago (TT)", "type": "String", "displayName": "Trinidad and Tobago (TT)", "required": false }, { "value": "Tunisia (TN)", "type": "String", "displayName": "Tunisia (TN)", "required": false }, { "value": "Turkey (TR)", "type": "String", "displayName": "Turkey (TR)", "required": false }, { "value": "Turkmenistan (TM)", "type": "String", "displayName": "Turkmenistan (TM)", "required": false }, { "value": "Tuvalu (TV)", "type": "String", "displayName": "Tuvalu (TV)", "required": false }, { "value": "Uganda (UG)", "type": "String", "displayName": "Uganda (UG)", "required": false }, { "value": "Ukraine (UA)", "type": "String", "displayName": "Ukraine (UA)", "required": false }, { "value": "United Arab Emirates (AE)", "type": "String", "displayName": "United Arab Emirates (AE)", "required": false }, { "value": "United Kingdom (GB)", "type": "String", "displayName": "United Kingdom (GB)", "required": false }, { "value": "United States (US)", "type": "String", "displayName": "United States (US)", "required": false }, { "value": "Uruguay (UY)", "type": "String", "displayName": "Uruguay (UY)", "required": false }, { "value": "Uzbekistan (UZ)", "type": "String", "displayName": "Uzbekistan (UZ)", "required": false }, { "value": "Vanuatu (VU)", "type": "String", "displayName": "Vanuatu (VU)", "required": false }, { "value": "Venezuela (VE)", "type": "String", "displayName": "Venezuela (VE)", "required": false }, { "value": "Vietnam (VN)", "type": "String", "displayName": "Vietnam (VN)", "required": false }, { "value": "Virgin Islands U.S. (VI)", "type": "String", "displayName": "Virgin Islands U.S. (VI)", "required": false }, { "value": "Western Sahara (EH)", "type": "String", "displayName": "Western Sahara (EH)", "required": false }, { "value": "Yemen (YE)", "type": "String", "displayName": "Yemen (YE)", "required": false }, { "value": "Zaire (ZR)", "type": "String", "displayName": "Zaire (ZR)", "required": false }, { "value": "Zambia (ZM)", "type": "String", "displayName": "Zambia (ZM)", "required": false }, { "value": "Zimbabwe (ZW)", "type": "String", "displayName": "Zimbabwe (ZW)", "required": false } ], "required": false } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses", "details": "Can contain a maximum of two addresses; main address and delivery address" } ] } } }, "required": true } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the customer, unique for the company", "required": false, "validation": { "warnings": [ { "field": "Id", "details": "Required if auto-numbering is not enabled for the Sage Intacct company" } ], "information": [] } }, "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": true, "validation": { "warnings": [ { "field": "CustomerName", "details": "Must be between 1 and 100 characters" } ], "information": [] } }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the customer", "required": true, "validation": { "warnings": [ { "field": "ContactName", "details": "Must be between 1 and 200 characters" } ], "information": [] } }, "status": { "type": "String", "displayName": "Customer Status", "description": "The current state of the customer", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the customer should be contacted on", "required": false, "validation": { "warnings": [ { "field": "Phone", "details": "Must be no greater than 30 characters" } ], "information": [] } }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": false, "validation": { "warnings": [ { "field": "EmailAddress", "details": "Must be no greater than 200 characters" } ], "information": [] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": false, "validation": { "warnings": [ { "field": "TaxNumber", "details": "Must be no greater than 20 characters" } ], "information": [] } }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the customer", "options": [ { "value": "AUD", "type": "String", "displayName": "Australian Dollar", "required": false }, { "value": "CAD", "type": "String", "displayName": "Canadian Dollar", "required": false }, { "value": "GBP", "type": "String", "displayName": "Pound Sterling", "required": false }, { "value": "USD", "type": "String", "displayName": "US Dollar", "required": false }, { "value": "ZAR", "type": "String", "displayName": "Rand", "required": false } ], "required": false }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line1", "details": "Must be no greater than 200 characters" } ], "information": [] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line2", "details": "Must be no greater than 200 characters" } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [ { "field": "Addresses.City", "details": "Must be no greater than 80 characters" } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [ { "field": "Addresses.Region", "details": "Must be no greater than 40 characters" } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.PostalCode", "details": "Must be no greater than 30 characters" } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "options": [ { "value": "United States", "type": "String", "displayName": "United States", "required": false }, { "value": "Afghanistan", "type": "String", "displayName": "Afghanistan", "required": false }, { "value": "Aland Islands", "type": "String", "displayName": "Aland Islands", "required": false }, { "value": "Albania", "type": "String", "displayName": "Albania", "required": false }, { "value": "Algeria", "type": "String", "displayName": "Algeria", "required": false }, { "value": "American Samoa", "type": "String", "displayName": "American Samoa", "required": false }, { "value": "Andorra", "type": "String", "displayName": "Andorra", "required": false }, { "value": "Angola", "type": "String", "displayName": "Angola", "required": false }, { "value": "Anguilla", "type": "String", "displayName": "Anguilla", "required": false }, { "value": "Antarctica", "type": "String", "displayName": "Antarctica", "required": false }, { "value": "Antigua and Barbuda", "type": "String", "displayName": "Antigua and Barbuda", "required": false }, { "value": "Argentina", "type": "String", "displayName": "Argentina", "required": false }, { "value": "Armenia", "type": "String", "displayName": "Armenia", "required": false }, { "value": "Aruba", "type": "String", "displayName": "Aruba", "required": false }, { "value": "Australia", "type": "String", "displayName": "Australia", "required": false }, { "value": "Austria", "type": "String", "displayName": "Austria", "required": false }, { "value": "Azerbaijan", "type": "String", "displayName": "Azerbaijan", "required": false }, { "value": "Bahamas", "type": "String", "displayName": "Bahamas", "required": false }, { "value": "Bahrain", "type": "String", "displayName": "Bahrain", "required": false }, { "value": "Bangladesh", "type": "String", "displayName": "Bangladesh", "required": false }, { "value": "Barbados", "type": "String", "displayName": "Barbados", "required": false }, { "value": "Belarus", "type": "String", "displayName": "Belarus", "required": false }, { "value": "Belgium", "type": "String", "displayName": "Belgium", "required": false }, { "value": "Belize", "type": "String", "displayName": "Belize", "required": false }, { "value": "Benin", "type": "String", "displayName": "Benin", "required": false }, { "value": "Bermuda", "type": "String", "displayName": "Bermuda", "required": false }, { "value": "Bhutan", "type": "String", "displayName": "Bhutan", "required": false }, { "value": "Bolivia", "type": "String", "displayName": "Bolivia", "required": false }, { "value": "Bonaire, Sint Eustatius and Saba", "type": "String", "displayName": "Bonaire, Sint Eustatius and Saba", "required": false }, { "value": "Bosnia and Herzegovina", "type": "String", "displayName": "Bosnia and Herzegovina", "required": false }, { "value": "Botswana", "type": "String", "displayName": "Botswana", "required": false }, { "value": "Bouvet Island", "type": "String", "displayName": "Bouvet Island", "required": false }, { "value": "Brazil", "type": "String", "displayName": "Brazil", "required": false }, { "value": "British Indian Ocean Territory", "type": "String", "displayName": "British Indian Ocean Territory", "required": false }, { "value": "Brunei Darussalam", "type": "String", "displayName": "Brunei Darussalam", "required": false }, { "value": "Bulgaria", "type": "String", "displayName": "Bulgaria", "required": false }, { "value": "Burkina Faso", "type": "String", "displayName": "Burkina Faso", "required": false }, { "value": "Burundi", "type": "String", "displayName": "Burundi", "required": false }, { "value": "Cambodia", "type": "String", "displayName": "Cambodia", "required": false }, { "value": "Cameroon", "type": "String", "displayName": "Cameroon", "required": false }, { "value": "Canada", "type": "String", "displayName": "Canada", "required": false }, { "value": "Cape Verde", "type": "String", "displayName": "Cape Verde", "required": false }, { "value": "Cayman Islands", "type": "String", "displayName": "Cayman Islands", "required": false }, { "value": "Central African Republic", "type": "String", "displayName": "Central African Republic", "required": false }, { "value": "Chad", "type": "String", "displayName": "Chad", "required": false }, { "value": "Chile", "type": "String", "displayName": "Chile", "required": false }, { "value": "China", "type": "String", "displayName": "China", "required": false }, { "value": "Christmas Island", "type": "String", "displayName": "Christmas Island", "required": false }, { "value": "Cocos (Keeling) Islands", "type": "String", "displayName": "Cocos (Keeling) Islands", "required": false }, { "value": "Colombia", "type": "String", "displayName": "Colombia", "required": false }, { "value": "Comoros", "type": "String", "displayName": "Comoros", "required": false }, { "value": "Congo", "type": "String", "displayName": "Congo", "required": false }, { "value": "Congo, Democratic Republic", "type": "String", "displayName": "Congo, Democratic Republic", "required": false }, { "value": "Cook Islands", "type": "String", "displayName": "Cook Islands", "required": false }, { "value": "Costa Rica", "type": "String", "displayName": "Costa Rica", "required": false }, { "value": "C�te d'Ivoire", "type": "String", "displayName": "C�te d'Ivoire", "required": false }, { "value": "Croatia", "type": "String", "displayName": "Croatia", "required": false }, { "value": "Cuba", "type": "String", "displayName": "Cuba", "required": false }, { "value": "Cura�ao", "type": "String", "displayName": "Cura�ao", "required": false }, { "value": "Cyprus", "type": "String", "displayName": "Cyprus", "required": false }, { "value": "Czech Republic", "type": "String", "displayName": "Czech Republic", "required": false }, { "value": "Denmark", "type": "String", "displayName": "Denmark", "required": false }, { "value": "Djibouti", "type": "String", "displayName": "Djibouti", "required": false }, { "value": "Dominica", "type": "String", "displayName": "Dominica", "required": false }, { "value": "Dominican Republic", "type": "String", "displayName": "Dominican Republic", "required": false }, { "value": "Ecuador", "type": "String", "displayName": "Ecuador", "required": false }, { "value": "Egypt", "type": "String", "displayName": "Egypt", "required": false }, { "value": "El Salvador", "type": "String", "displayName": "El Salvador", "required": false }, { "value": "Equatorial Guinea", "type": "String", "displayName": "Equatorial Guinea", "required": false }, { "value": "Eritrea", "type": "String", "displayName": "Eritrea", "required": false }, { "value": "Estonia", "type": "String", "displayName": "Estonia", "required": false }, { "value": "Eswatini", "type": "String", "displayName": "Eswatini", "required": false }, { "value": "Ethiopia", "type": "String", "displayName": "Ethiopia", "required": false }, { "value": "Falkland Islands (Malvinas", "type": "String", "displayName": "Falkland Islands (Malvinas", "required": false }, { "value": "Faroe Islands", "type": "String", "displayName": "Faroe Islands", "required": false }, { "value": "Fiji", "type": "String", "displayName": "Fiji", "required": false }, { "value": "Finland", "type": "String", "displayName": "Finland", "required": false }, { "value": "France", "type": "String", "displayName": "France", "required": false }, { "value": "French Guiana", "type": "String", "displayName": "French Guiana", "required": false }, { "value": "French Polynesia", "type": "String", "displayName": "French Polynesia", "required": false }, { "value": "French Southern Territories", "type": "String", "displayName": "French Southern Territories", "required": false }, { "value": "Gabon", "type": "String", "displayName": "Gabon", "required": false }, { "value": "Gambia", "type": "String", "displayName": "Gambia", "required": false }, { "value": "Georgia", "type": "String", "displayName": "Georgia", "required": false }, { "value": "Germany", "type": "String", "displayName": "Germany", "required": false }, { "value": "Ghana", "type": "String", "displayName": "Ghana", "required": false }, { "value": "Gibraltar", "type": "String", "displayName": "Gibraltar", "required": false }, { "value": "Greece", "type": "String", "displayName": "Greece", "required": false }, { "value": "Greenland", "type": "String", "displayName": "Greenland", "required": false }, { "value": "Grenada", "type": "String", "displayName": "Grenada", "required": false }, { "value": "Guadeloupe", "type": "String", "displayName": "Guadeloupe", "required": false }, { "value": "Guam", "type": "String", "displayName": "Guam", "required": false }, { "value": "Guatemala", "type": "String", "displayName": "Guatemala", "required": false }, { "value": "Guernsey", "type": "String", "displayName": "Guernsey", "required": false }, { "value": "Guinea", "type": "String", "displayName": "Guinea", "required": false }, { "value": "Guinea-Bissau", "type": "String", "displayName": "Guinea-Bissau", "required": false }, { "value": "Guyana", "type": "String", "displayName": "Guyana", "required": false }, { "value": "Haiti", "type": "String", "displayName": "Haiti", "required": false }, { "value": "Heard Is. & Mcdonald Islands", "type": "String", "displayName": "Heard Is. & Mcdonald Islands", "required": false }, { "value": "Honduras", "type": "String", "displayName": "Honduras", "required": false }, { "value": "Hong Kong", "type": "String", "displayName": "Hong Kong", "required": false }, { "value": "Hungary", "type": "String", "displayName": "Hungary", "required": false }, { "value": "Iceland", "type": "String", "displayName": "Iceland", "required": false }, { "value": "India", "type": "String", "displayName": "India", "required": false }, { "value": "Indonesia", "type": "String", "displayName": "Indonesia", "required": false }, { "value": "Iran, Islamic Republic of", "type": "String", "displayName": "Iran, Islamic Republic of", "required": false }, { "value": "Iraq", "type": "String", "displayName": "Iraq", "required": false }, { "value": "Ireland", "type": "String", "displayName": "Ireland", "required": false }, { "value": "Isle of Man", "type": "String", "displayName": "Isle of Man", "required": false }, { "value": "Israel", "type": "String", "displayName": "Israel", "required": false }, { "value": "Italy", "type": "String", "displayName": "Italy", "required": false }, { "value": "Jamaica", "type": "String", "displayName": "Jamaica", "required": false }, { "value": "Japan", "type": "String", "displayName": "Japan", "required": false }, { "value": "Jersey", "type": "String", "displayName": "Jersey", "required": false }, { "value": "Jordan", "type": "String", "displayName": "Jordan", "required": false }, { "value": "Kazakhstan", "type": "String", "displayName": "Kazakhstan", "required": false }, { "value": "Kenya", "type": "String", "displayName": "Kenya", "required": false }, { "value": "Kiribati", "type": "String", "displayName": "Kiribati", "required": false }, { "value": "Korea, Republic of", "type": "String", "displayName": "Korea, Republic of", "required": false }, { "value": "Korea, Demo. People's Rep", "type": "String", "displayName": "Korea, Demo. People's Rep", "required": false }, { "value": "Kosovo", "type": "String", "displayName": "Kosovo", "required": false }, { "value": "Kuwait", "type": "String", "displayName": "Kuwait", "required": false }, { "value": "Kyrgyzstan", "type": "String", "displayName": "Kyrgyzstan", "required": false }, { "value": "Lao", "type": "String", "displayName": "Lao", "required": false }, { "value": "Latvia", "type": "String", "displayName": "Latvia", "required": false }, { "value": "Lebanon", "type": "String", "displayName": "Lebanon", "required": false }, { "value": "Lesotho", "type": "String", "displayName": "Lesotho", "required": false }, { "value": "Liberia", "type": "String", "displayName": "Liberia", "required": false }, { "value": "Libyan Arab Jamahiriya", "type": "String", "displayName": "Libyan Arab Jamahiriya", "required": false }, { "value": "Liechtenstein", "type": "String", "displayName": "Liechtenstein", "required": false }, { "value": "Lithuania", "type": "String", "displayName": "Lithuania", "required": false }, { "value": "Luxembourg", "type": "String", "displayName": "Luxembourg", "required": false }, { "value": "Macao", "type": "String", "displayName": "Macao", "required": false }, { "value": "Macedonia", "type": "String", "displayName": "Macedonia", "required": false }, { "value": "Madagascar", "type": "String", "displayName": "Madagascar", "required": false }, { "value": "Malawi", "type": "String", "displayName": "Malawi", "required": false }, { "value": "Malaysia", "type": "String", "displayName": "Malaysia", "required": false }, { "value": "Maldives", "type": "String", "displayName": "Maldives", "required": false }, { "value": "Mali", "type": "String", "displayName": "Mali", "required": false }, { "value": "Malta", "type": "String", "displayName": "Malta", "required": false }, { "value": "Marshall Islands", "type": "String", "displayName": "Marshall Islands", "required": false }, { "value": "Martinique", "type": "String", "displayName": "Martinique", "required": false }, { "value": "Mauritania", "type": "String", "displayName": "Mauritania", "required": false }, { "value": "Mauritius", "type": "String", "displayName": "Mauritius", "required": false }, { "value": "Mayotte", "type": "String", "displayName": "Mayotte", "required": false }, { "value": "Mexico", "type": "String", "displayName": "Mexico", "required": false }, { "value": "Micronesia", "type": "String", "displayName": "Micronesia", "required": false }, { "value": "Moldova, Republic of", "type": "String", "displayName": "Moldova, Republic of", "required": false }, { "value": "Monaco", "type": "String", "displayName": "Monaco", "required": false }, { "value": "Mongolia", "type": "String", "displayName": "Mongolia", "required": false }, { "value": "Montenegro", "type": "String", "displayName": "Montenegro", "required": false }, { "value": "Montserrat", "type": "String", "displayName": "Montserrat", "required": false }, { "value": "Morocco", "type": "String", "displayName": "Morocco", "required": false }, { "value": "Mozambique", "type": "String", "displayName": "Mozambique", "required": false }, { "value": "Myanmar", "type": "String", "displayName": "Myanmar", "required": false }, { "value": "Namibia", "type": "String", "displayName": "Namibia", "required": false }, { "value": "Nauru", "type": "String", "displayName": "Nauru", "required": false }, { "value": "Nepal", "type": "String", "displayName": "Nepal", "required": false }, { "value": "Netherlands", "type": "String", "displayName": "Netherlands", "required": false }, { "value": "Netherlands Antilles", "type": "String", "displayName": "Netherlands Antilles", "required": false }, { "value": "New Caledonia", "type": "String", "displayName": "New Caledonia", "required": false }, { "value": "New Zealand", "type": "String", "displayName": "New Zealand", "required": false }, { "value": "Nicaragua", "type": "String", "displayName": "Nicaragua", "required": false }, { "value": "Niger", "type": "String", "displayName": "Niger", "required": false }, { "value": "Nigeria", "type": "String", "displayName": "Nigeria", "required": false }, { "value": "Niue", "type": "String", "displayName": "Niue", "required": false }, { "value": "Norfolk Island", "type": "String", "displayName": "Norfolk Island", "required": false }, { "value": "Northern Mariana Islands", "type": "String", "displayName": "Northern Mariana Islands", "required": false }, { "value": "Norway", "type": "String", "displayName": "Norway", "required": false }, { "value": "Oman", "type": "String", "displayName": "Oman", "required": false }, { "value": "Pakistan", "type": "String", "displayName": "Pakistan", "required": false }, { "value": "Palau", "type": "String", "displayName": "Palau", "required": false }, { "value": "Palestinian Territory, Occupied", "type": "String", "displayName": "Palestinian Territory, Occupied", "required": false }, { "value": "Panama", "type": "String", "displayName": "Panama", "required": false }, { "value": "Papua New Guinea", "type": "String", "displayName": "Papua New Guinea", "required": false }, { "value": "Paraguay", "type": "String", "displayName": "Paraguay", "required": false }, { "value": "Peru", "type": "String", "displayName": "Peru", "required": false }, { "value": "Philippines", "type": "String", "displayName": "Philippines", "required": false }, { "value": "Pitcairn", "type": "String", "displayName": "Pitcairn", "required": false }, { "value": "Poland", "type": "String", "displayName": "Poland", "required": false }, { "value": "Portugal", "type": "String", "displayName": "Portugal", "required": false }, { "value": "Puerto Rico", "type": "String", "displayName": "Puerto Rico", "required": false }, { "value": "Qatar", "type": "String", "displayName": "Qatar", "required": false }, { "value": "Reunion", "type": "String", "displayName": "Reunion", "required": false }, { "value": "Romania", "type": "String", "displayName": "Romania", "required": false }, { "value": "Russian Federation", "type": "String", "displayName": "Russian Federation", "required": false }, { "value": "Rwanda", "type": "String", "displayName": "Rwanda", "required": false }, { "value": "Saint Barthelemy", "type": "String", "displayName": "Saint Barthelemy", "required": false }, { "value": "Saint Helena", "type": "String", "displayName": "Saint Helena", "required": false }, { "value": "Saint Kitts and Nevis", "type": "String", "displayName": "Saint Kitts and Nevis", "required": false }, { "value": "Saint Lucia", "type": "String", "displayName": "Saint Lucia", "required": false }, { "value": "Saint Martin", "type": "String", "displayName": "Saint Martin", "required": false }, { "value": "Saint Pierre and Miquelon", "type": "String", "displayName": "Saint Pierre and Miquelon", "required": false }, { "value": "Saint Vincent and the Grenadines", "type": "String", "displayName": "Saint Vincent and the Grenadines", "required": false }, { "value": "Samoa", "type": "String", "displayName": "Samoa", "required": false }, { "value": "San Marino", "type": "String", "displayName": "San Marino", "required": false }, { "value": "Sao Tome and Principe", "type": "String", "displayName": "Sao Tome and Principe", "required": false }, { "value": "Saudi Arabia", "type": "String", "displayName": "Saudi Arabia", "required": false }, { "value": "Senegal", "type": "String", "displayName": "Senegal", "required": false }, { "value": "Serbia", "type": "String", "displayName": "Serbia", "required": false }, { "value": "Seychelles", "type": "String", "displayName": "Seychelles", "required": false }, { "value": "Sierra Leone", "type": "String", "displayName": "Sierra Leone", "required": false }, { "value": "Singapore", "type": "String", "displayName": "Singapore", "required": false }, { "value": "Sint Maarten", "type": "String", "displayName": "Sint Maarten", "required": false }, { "value": "Slovakia", "type": "String", "displayName": "Slovakia", "required": false }, { "value": "Slovenia", "type": "String", "displayName": "Slovenia", "required": false }, { "value": "Solomon Islands", "type": "String", "displayName": "Solomon Islands", "required": false }, { "value": "Somalia", "type": "String", "displayName": "Somalia", "required": false }, { "value": "South Africa", "type": "String", "displayName": "South Africa", "required": false }, { "value": "S. Georgia & S. Sandwich Is", "type": "String", "displayName": "S. Georgia & S. Sandwich Is", "required": false }, { "value": "Spain", "type": "String", "displayName": "Spain", "required": false }, { "value": "Sri Lanka", "type": "String", "displayName": "Sri Lanka", "required": false }, { "value": "Sudan", "type": "String", "displayName": "Sudan", "required": false }, { "value": "South Sudan", "type": "String", "displayName": "South Sudan", "required": false }, { "value": "Suriname", "type": "String", "displayName": "Suriname", "required": false }, { "value": "Svalbard and Jan Mayen", "type": "String", "displayName": "Svalbard and Jan Mayen", "required": false }, { "value": "Sweden", "type": "String", "displayName": "Sweden", "required": false }, { "value": "Switzerland", "type": "String", "displayName": "Switzerland", "required": false }, { "value": "Syrian Arab Republic", "type": "String", "displayName": "Syrian Arab Republic", "required": false }, { "value": "Taiwan", "type": "String", "displayName": "Taiwan", "required": false }, { "value": "Tajikistan", "type": "String", "displayName": "Tajikistan", "required": false }, { "value": "Tanzania, United Republic of", "type": "String", "displayName": "Tanzania, United Republic of", "required": false }, { "value": "Thailand", "type": "String", "displayName": "Thailand", "required": false }, { "value": "Timor-Leste", "type": "String", "displayName": "Timor-Leste", "required": false }, { "value": "Togo", "type": "String", "displayName": "Togo", "required": false }, { "value": "Tokelau", "type": "String", "displayName": "Tokelau", "required": false }, { "value": "Tonga", "type": "String", "displayName": "Tonga", "required": false }, { "value": "Trinidad and Tobago", "type": "String", "displayName": "Trinidad and Tobago", "required": false }, { "value": "Tunisia", "type": "String", "displayName": "Tunisia", "required": false }, { "value": "Turkey", "type": "String", "displayName": "Turkey", "required": false }, { "value": "Turkmenistan", "type": "String", "displayName": "Turkmenistan", "required": false }, { "value": "Turks and Caicos Islands", "type": "String", "displayName": "Turks and Caicos Islands", "required": false }, { "value": "Tuvalu", "type": "String", "displayName": "Tuvalu", "required": false }, { "value": "Uganda", "type": "String", "displayName": "Uganda", "required": false }, { "value": "Ukraine", "type": "String", "displayName": "Ukraine", "required": false }, { "value": "United Arab Emirates", "type": "String", "displayName": "United Arab Emirates", "required": false }, { "value": "United Kingdom", "type": "String", "displayName": "United Kingdom", "required": false }, { "value": "US Minor Outlying Islands", "type": "String", "displayName": "US Minor Outlying Islands", "required": false }, { "value": "Uruguay", "type": "String", "displayName": "Uruguay", "required": false }, { "value": "Uzbekistan", "type": "String", "displayName": "Uzbekistan", "required": false }, { "value": "Vanuatu", "type": "String", "displayName": "Vanuatu", "required": false }, { "value": "Vatican City State", "type": "String", "displayName": "Vatican City State", "required": false }, { "value": "Venezuela", "type": "String", "displayName": "Venezuela", "required": false }, { "value": "Vietnam", "type": "String", "displayName": "Vietnam", "required": false }, { "value": "Virgin Islands, British", "type": "String", "displayName": "Virgin Islands, British", "required": false }, { "value": "Virgin Islands, U.S", "type": "String", "displayName": "Virgin Islands, U.S", "required": false }, { "value": "Wallis and Futuna", "type": "String", "displayName": "Wallis and Futuna", "required": false }, { "value": "Western Sahara", "type": "String", "displayName": "Western Sahara", "required": false }, { "value": "Yemen", "type": "String", "displayName": "Yemen", "required": false }, { "value": "Zambia", "type": "String", "displayName": "Zambia", "required": false }, { "value": "Zimbabwe", "type": "String", "displayName": "Zimbabwe", "required": false } ], "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Required if TaxNumber is supplied" } ], "information": [] } } }, "required": false, "validation": { "warnings": [ { "field": "Addresses", "details": "If supplied, must contain only 1 address" }, { "field": "Addresses", "details": "If TaxNumber is supplied, an Address with a Country is required" } ], "information": [] } } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": true }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the customer", "required": true }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": true }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the customer", "required": true }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the customer should be contacted on", "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "required": true }, "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": true }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": true }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": true }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": true }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": true }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": true } }, "required": true }, "contacts": { "type": "Array", "displayName": "Contacts", "description": "A collection of alternative contacts for the customer", "properties": { "name": { "type": "String", "displayName": "Name", "description": "The name of the contact", "required": true }, "email": { "type": "String", "displayName": "Email", "description": "The email address for the contact", "required": true }, "phone": { "type": "Array", "displayName": "Phone", "description": "A collection of phone numbers for the contact", "properties": { "number": { "type": "String", "displayName": "Number", "description": "The full number including country, and area code where applicable", "required": true }, "type": { "type": "String", "displayName": "Phone Type", "description": "The type of phone number", "required": true } }, "required": true }, "address": { "type": "Object", "displayName": "Address", "description": "The address for the contact", "properties": { "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "required": true }, "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": true }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": true }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": true }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": true }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": true }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": true } }, "required": true }, "status": { "type": "String", "displayName": "Contact Status", "description": "The current state of the contact", "required": true }, "modifiedDate": { "type": "DateTime", "displayName": "Modified Date", "description": "The date the record was last updated in the system cache", "required": true } }, "required": true }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The customer's registration number", "required": true }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": true }, "status": { "type": "String", "displayName": "Customer Status", "description": "The current state of the customer", "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Customer", "description": "A customer is a person or organisation who buys goods or services", "properties": { "customerName": { "type": "String", "displayName": "Customer Name", "description": "The name for the customer, typically a company name", "required": true }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the customer should be contacted on", "required": false, "validation": { "warnings": [ { "field": "Phone", "details": "Country, area, and number are space separated" } ], "information": [] } }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred Email address the customer should be contacted on", "required": false }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The customer's registration number", "required": false, "validation": { "warnings": [ { "field": "RegistrationNumber", "details": "Max length of 50 characters." } ], "information": [] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The customer's tax number", "required": false }, "status": { "type": "String", "displayName": "Customer Status", "description": "The current state of the customer", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "InActive", "type": "String", "displayName": "Inactive", "required": false } ], "required": false }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the customer", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line1", "details": "Max length of 500 characters." } ], "information": [] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line2", "details": "Max length of 500 characters." } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [ { "field": "Addresses.City", "details": "Max length of 255 characters." } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [ { "field": "Addresses.Region", "details": "Max length of 255 characters." } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Max length of 50 characters." } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.PostalCode", "details": "Only English alphabet characters are permitted." }, { "field": "Addresses.PostalCode", "details": "Max length of 50 characters." } ], "information": [] } }, "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "options": [ { "value": "Billing", "type": "String", "displayName": "Billing Address", "required": false }, { "value": "Delivery", "type": "String", "displayName": "Delivery Address", "required": false } ], "required": true, "validation": { "warnings": [ { "field": "Addresses.Type", "details": "Billing = POBOX, Delivery/Unknown = STREET" } ], "information": [] } } }, "required": false } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-update-customers-model", "description": "The *Get create/update customer model* endpoint returns the expected data for the request payload when creating and updating a [customer](https://docs.codat.io/accounting-api#/schemas/Customer) for a given company and integration.\n\n[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support creating and updating a customer.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/customers": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Customers" ], "summary": "Create customer", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "create-customer", "description": "The *Create customer* endpoint creates a new [customer](https://docs.codat.io/accounting-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/accounting-api#/operations/get-create-update-customers-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support creating an account.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/customers/{customerId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/customerId" } ], "put": { "tags": [ "Customers" ], "summary": "Update customer", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/forceUpdate" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Update customer* endpoint updates an existing [customer](https://docs.codat.io/accounting-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/accounting-api#/operations/get-create-update-customers-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support creating an account.\n", "operationId": "update-customer" } }, "/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/customerId" } ], "get": { "tags": [ "Customers" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentsDataset" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "List customer attachments", "description": "The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`.\n\n[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support listing customer attachments.\n", "operationId": "list-customer-attachments" } }, "/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/customerId" }, { "$ref": "#/components/parameters/attachmentId" } ], "get": { "tags": [ "Customers" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get customer attachment", "description": "The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`.\n\n[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support getting a customer attachment.\n", "operationId": "get-customer-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}/download": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/customerId" }, { "$ref": "#/components/parameters/attachmentId" } ], "get": { "tags": [ "Customers" ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "title": "Data", "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Download customer attachment", "description": "The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`.\n\n[Customers](https://docs.codat.io/accounting-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=customers) for integrations that support downloading a customer attachment.\n", "operationId": "download-customer-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/directCosts": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "tags": [ "Direct costs" ], "summary": "List direct costs", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectCosts" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "994ad234-ca05-466e-8e6a-117783b38cf6", "reference": "005b7b62-dc9f-42d2-85a2-4a2cefc6bab2", "note": "Direct Cost with 1 line items, totaling 242.20", "contactRef": { "id": "D4Q4iYwHou", "dataType": "suppliers" }, "issueDate": "2022-04-27T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Underground - Drain Saddle Branches 160mm x 110mm x 87 �", "accountRef": { "id": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Purchases" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "unitAmount": 220.18, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 220.18, "taxAmount": 22.02, "totalAmount": 242.2, "itemRef": { "id": "2", "name": "Solvent Weld Branch 160mm x 110mm x 87 �" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "994ad234-ca05-466e-8e6a-117783b38cf6", "note": "Payment for direct cost 994ad234-ca05-466e-8e6a-117783b38cf6", "reference": "Direct Cost 994ad234-ca05-466e-8e6a-117783b38cf6", "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-04-27T00:00:00", "totalAmount": 242.2 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-04-27T00:00:00", "totalAmount": -242.2 } } ], "subTotal": 220.18, "taxAmount": 22.02, "totalAmount": 242.2, "modifiedDate": "2023-04-26T12:38:18Z", "sourceModifiedDate": "2022-09-18T20:59:02", "metadata": { "isDeleted": false } }, { "id": "735b5f9b-9e58-4f8f-8a9d-083de599986c", "reference": "7d011ce8-89ae-43e7-a2ed-cf028534ccdc", "note": "Direct Cost with 4 line items, totaling 13684.57", "contactRef": { "id": "d3tf43eghS", "dataType": "suppliers" }, "issueDate": "2022-05-02T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Underground - Drain Yard Gully", "accountRef": { "id": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Purchases" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "unitAmount": 148.88, "quantity": 5, "discountAmount": 73.62, "discountPercentage": 9.89, "subTotal": 670.78, "taxAmount": 67.08, "totalAmount": 737.86, "itemRef": { "id": "00491160-6ee5-4d76-9f34-998f00687481", "name": "Aluminium Silt Bucket" }, "trackingCategoryRefs": [] }, { "description": "Underground - Drain Bottle Gullies 90 degree Rectangular", "accountRef": { "id": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Purchases" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "unitAmount": 82.68, "quantity": 3, "discountAmount": 0, "discountPercentage": 0, "subTotal": 248.04, "taxAmount": 24.8, "totalAmount": 272.84, "itemRef": { "id": "6", "name": "Back Inlet Roddable Gully 90� Outlet Rectangular Grid" }, "trackingCategoryRefs": [] }, { "description": "Grease Trap", "accountRef": { "id": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Purchases" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "unitAmount": 1192.51, "quantity": 8, "discountAmount": 0, "discountPercentage": 0, "subTotal": 9540.08, "taxAmount": 954.01, "totalAmount": 10494.09, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [] }, { "description": "Underground - Drain Saddle Branches 160mm x 110mm x 87 �", "accountRef": { "id": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Purchases" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "unitAmount": 220.18, "quantity": 9, "discountAmount": 0, "discountPercentage": 0, "subTotal": 1981.62, "taxAmount": 198.16, "totalAmount": 2179.78, "itemRef": { "id": "2", "name": "Solvent Weld Branch 160mm x 110mm x 87 �" }, "trackingCategoryRefs": [ { "id": "costcode_1", "name": "Green Concrete" } ] } ], "paymentAllocations": [ { "payment": { "id": "735b5f9b-9e58-4f8f-8a9d-083de599986c", "note": "Payment for direct cost 735b5f9b-9e58-4f8f-8a9d-083de599986c", "reference": "Direct Cost 735b5f9b-9e58-4f8f-8a9d-083de599986c", "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-05-02T00:00:00", "totalAmount": 13684.57 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-05-02T00:00:00", "totalAmount": -13684.57 } } ], "subTotal": 12440.52, "taxAmount": 1244.05, "totalAmount": 13684.57, "modifiedDate": "2023-04-26T12:38:18Z", "sourceModifiedDate": "2022-10-13T07:15:02", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 90, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "6ab3e391-97d7-ec11-8e7e-000d3a0cfe40", "reference": "INS000090", "note": "3931", "issueDate": "2022-05-21T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "test expenses 2", "accountRef": { "id": "30" }, "taxRateRef": { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "effectiveTaxRate": 0 }, "unitAmount": 17.89, "quantity": -1, "subTotal": -17.89, "taxAmount": 0, "totalAmount": -17.89, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "6ab3e391-97d7-ec11-8e7e-000d3a0cfe40", "accountRef": { "id": "TEST" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-05-21T00:00:00", "totalAmount": -17.89 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-05-21T00:00:00", "totalAmount": -17.89 } } ], "subTotal": -17.89, "taxAmount": 0, "totalAmount": -17.89, "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2022-05-19T17:17:33Z", "metadata": { "isDeleted": false } }, { "id": "b832f518-88d7-ec11-8e7e-000d3a0cfe40", "reference": "INS000050", "note": "3915", "issueDate": "2022-05-23T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Utilities Expense", "accountRef": { "id": "31300" }, "taxRateRef": { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "effectiveTaxRate": 0 }, "unitAmount": 14.76, "quantity": 1, "subTotal": 14.76, "taxAmount": 0, "totalAmount": 14.76, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "b832f518-88d7-ec11-8e7e-000d3a0cfe40", "accountRef": { "id": "TEST" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-05-23T00:00:00", "totalAmount": 14.76 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-05-23T00:00:00", "totalAmount": 14.76 } } ], "subTotal": 14.76, "taxAmount": 0, "totalAmount": 14.76, "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2022-05-19T15:26:48Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 67, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "190325254", "note": "Atomic Software Limite Wellington,Nzl", "issueDate": "2017-11-23T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Atomic Software Limite Wellington,Nzl", "accountRef": { "id": "285", "name": "Accommodation and Meals" }, "unitAmount": 11.92, "quantity": 1, "subTotal": 11.92, "taxAmount": 2.38, "totalAmount": 14.3, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "190325254", "note": "Atomic Software Limite Wellington,Nzl", "accountRef": { "id": "750-1", "name": "Bank Account: Business Current Account" }, "currency": "GBP", "paidOnDate": "2017-11-23T00:00:00", "totalAmount": 14.3 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2017-11-23T00:00:00", "totalAmount": 14.3 } } ], "subTotal": 11.92, "taxAmount": 2.38, "totalAmount": 14.3, "modifiedDate": "2023-04-25T14:20:36Z", "sourceModifiedDate": "2019-11-22T14:31:14Z", "metadata": { "isDeleted": false } }, { "id": "348108455", "note": "Atomic Software Limite Wellington,Nzl", "issueDate": "2017-11-23T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Atomic Software Limite Wellington,Nzl", "accountRef": { "id": "285", "name": "Accommodation and Meals" }, "unitAmount": 11.92, "quantity": 1, "subTotal": 11.92, "taxAmount": 2.38, "totalAmount": 14.3, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "348108455", "note": "Atomic Software Limite Wellington,Nzl", "accountRef": { "id": "750-1", "name": "Bank Account: Business Current Account" }, "currency": "GBP", "paidOnDate": "2017-11-23T00:00:00", "totalAmount": 14.3 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2017-11-23T00:00:00", "totalAmount": 14.3 } } ], "subTotal": 11.92, "taxAmount": 2.38, "totalAmount": 14.3, "modifiedDate": "2023-04-25T14:20:36Z", "sourceModifiedDate": "2022-10-24T12:35:29Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 456, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "29870062", "reference": "Food to keep me working", "note": "Food to keep me working", "contactRef": { "id": "Sainsburys", "dataType": "suppliers" }, "issueDate": "2019-02-12T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Food to keep me working", "accountRef": { "id": "3361426", "name": "Meals & Entertainment" }, "unitAmount": 10, "quantity": 1, "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "trackingCategoryRefs": [ { "id": "4370503", "name": "Meals & Entertainment" } ] } ], "paymentAllocations": [], "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2021-10-28T15:21:46", "metadata": { "isDeleted": false } }, { "id": "107509561", "reference": "Buying pencils", "note": "Buying pencils", "contactRef": { "id": "Pencils Wholesale", "dataType": "suppliers" }, "issueDate": "2020-01-27T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Buying pencils", "accountRef": { "id": "3380551", "name": "Supplies" }, "unitAmount": 43.48, "quantity": 1, "subTotal": 43.48, "taxAmount": 6.52, "totalAmount": 50, "trackingCategoryRefs": [ { "id": "5397997", "name": "Supplies" } ] } ], "paymentAllocations": [], "subTotal": 43.48, "taxAmount": 6.52, "totalAmount": 50, "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2021-10-28T15:21:47", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 73, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "D7B-933784104", "reference": "93", "contactRef": { "id": "360000-933272659", "dataType": "suppliers" }, "issueDate": "2022-12-01T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "3C0000-933270542", "name": "Rent" }, "unitAmount": 1200, "quantity": 1, "subTotal": 1200, "totalAmount": 1200, "trackingCategoryRefs": [ { "id": "80000007-1197713802", "name": "Overhead" } ], "tracking": { "recordRefs": [ { "id": "80000007-1197713802", "dataType": "trackingCategories" }, { "id": "800000B0-1197755238", "dataType": "customers" } ] } } ], "paymentAllocations": [ { "payment": { "id": "D7B-933784104", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-12-01T00:00:00", "totalAmount": 1200 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-12-01T00:00:00", "totalAmount": 1200 } } ], "subTotal": 1200, "taxAmount": 0, "totalAmount": 1200, "modifiedDate": "2023-04-26T09:13:57Z", "sourceModifiedDate": "2023-12-16T05:04:10", "metadata": { "isDeleted": false } }, { "id": "DFA-933785132", "reference": "95", "contactRef": { "id": "320000-933272659", "dataType": "suppliers" }, "issueDate": "2022-12-05T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "280000-933270542", "name": "Freight & Delivery" }, "unitAmount": 35, "quantity": 1, "subTotal": 35, "totalAmount": 35, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "tracking": { "recordRefs": [ { "id": "40000-933272658", "dataType": "trackingCategories" }, { "id": "1E0000-933272658", "dataType": "customers" } ] } } ], "paymentAllocations": [ { "payment": { "id": "DFA-933785132", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-12-05T00:00:00", "totalAmount": 35 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-12-05T00:00:00", "totalAmount": 35 } } ], "subTotal": 35, "taxAmount": 0, "totalAmount": 35, "modifiedDate": "2023-04-26T09:13:57Z", "sourceModifiedDate": "2023-12-16T05:04:11", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 250, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "PUR-85", "note": "Opening Balance from Bank", "issueDate": "2015-08-12T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "taxRateRef": { "id": "NON", "name": "NON", "effectiveTaxRate": 0 }, "unitAmount": 3831.8, "quantity": 1, "subTotal": 3831.8, "taxAmount": 0, "totalAmount": 3831.8, "trackingCategoryRefs": [], "tracking": { "recordRefs": [] } } ], "paymentAllocations": [ { "payment": { "id": "85", "reference": "Opening Balance from Bank", "accountRef": { "id": "57", "name": "Visa Credit Card" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2015-08-12T00:00:00", "totalAmount": 3831.8 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2015-08-12T00:00:00", "totalAmount": -3831.8 } } ], "subTotal": 3831.8, "taxAmount": 0, "totalAmount": 3831.8, "modifiedDate": "2023-04-26T09:36:40Z", "sourceModifiedDate": "2016-09-12T18:13:07Z", "metadata": { "isDeleted": false } }, { "id": "PUR-3617", "reference": "2001", "contactRef": { "id": "27", "dataType": "suppliers" }, "issueDate": "2015-11-27T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Insurance - general liability", "accountRef": { "id": "22", "name": "Insurance Expense-General Liability Insurance" }, "taxRateRef": { "id": "3_Bills", "name": "20.0% S Bills", "effectiveTaxRate": 20 }, "unitAmount": 750, "quantity": 1, "subTotal": 750, "taxAmount": 150, "totalAmount": 900, "trackingCategoryRefs": [], "tracking": { "recordRefs": [] } } ], "paymentAllocations": [ { "payment": { "id": "3617", "note": "2001", "accountRef": { "id": "81", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2015-11-27T00:00:00", "totalAmount": 900 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2015-11-27T00:00:00", "totalAmount": -900 } } ], "subTotal": 750, "taxAmount": 150, "totalAmount": 900, "modifiedDate": "2023-04-26T09:36:40Z", "sourceModifiedDate": "2022-08-19T10:19:56Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 4460, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "PUR-15", "note": "Payment to Google", "issueDate": "2018-09-21T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Payment to Google", "accountRef": { "id": "37", "name": "Computer equipment accumulated depreciation brought forward" }, "taxRateRef": { "id": "NON", "name": "NON", "effectiveTaxRate": 0 }, "unitAmount": 1.59, "quantity": 1, "subTotal": 1.59, "taxAmount": 0, "totalAmount": 1.59, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "15", "reference": "Payment to Google", "accountRef": { "id": "61", "name": "Dave PP Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-09-21T00:00:00", "totalAmount": 1.59 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2018-09-21T00:00:00", "totalAmount": -1.59 } } ], "subTotal": 1.59, "taxAmount": 0, "totalAmount": 1.59, "modifiedDate": "2023-01-18T11:02:59Z", "sourceModifiedDate": "2018-12-17T14:56:44Z" }, { "id": "PUR-9303", "note": "Payment to Google", "contactRef": { "id": "4", "dataType": "suppliers" }, "issueDate": "2018-09-21T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Payment to Google", "accountRef": { "id": "37", "name": "Computer equipment accumulated depreciation brought forward" }, "taxRateRef": { "id": "NON", "name": "NON", "effectiveTaxRate": 0 }, "unitAmount": 1.59, "quantity": 1, "subTotal": 1.59, "taxAmount": 0, "totalAmount": 1.59, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "9303", "reference": "Payment to Google", "accountRef": { "id": "61", "name": "Dave PP Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-09-21T00:00:00", "totalAmount": 1.59 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2018-09-21T00:00:00", "totalAmount": -1.59 } } ], "subTotal": 1.59, "taxAmount": 0, "totalAmount": 1.59, "modifiedDate": "2023-01-18T11:02:59Z", "sourceModifiedDate": "2022-07-11T10:32:16Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2176, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "73", "reference": "DD/STO", "issueDate": "2021-01-29T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Electrcity Direct Debit", "accountRef": { "id": "7200", "name": "Electricity" }, "taxRateRef": { "id": "3" }, "unitAmount": 150, "quantity": 1, "subTotal": 150, "taxAmount": 12, "totalAmount": 162, "trackingCategoryRefs": [ { "id": "department_0", "name": "Default" } ] } ], "paymentAllocations": [ { "payment": { "id": "73", "reference": "DD/STO", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-01-29T00:00:00", "totalAmount": 162 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2021-01-29T00:00:00", "totalAmount": 162 } } ], "subTotal": 150, "taxAmount": 12, "totalAmount": 162, "modifiedDate": "2023-03-30T14:42:35Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } }, { "id": "52", "reference": "568953", "issueDate": "2021-01-30T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Vat Payment Quater End 3112.96", "accountRef": { "id": "2202", "name": "VAT Liability" }, "taxRateRef": { "id": "9", "name": "Non-Vatable Tax Code", "effectiveTaxRate": 0 }, "unitAmount": 1497.58, "quantity": 1, "subTotal": 1497.58, "taxAmount": 0, "totalAmount": 1497.58, "trackingCategoryRefs": [ { "id": "department_0", "name": "Default" } ] } ], "paymentAllocations": [ { "payment": { "id": "52", "reference": "568953", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-01-30T00:00:00", "totalAmount": 1497.58 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2021-01-30T00:00:00", "totalAmount": 1497.58 } } ], "subTotal": 1497.58, "taxAmount": 0, "totalAmount": 1497.58, "modifiedDate": "2023-03-30T14:42:35Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 106, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "CCTRANSACTION:4355", "reference": "", "note": "Test 1", "issueDate": "2020-01-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "195", "name": "Insurance" }, "taxRateRef": { "id": "62018" }, "unitAmount": 9.99, "quantity": 1, "subTotal": 9.99, "taxAmount": 2, "totalAmount": 11.99, "trackingCategoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" } ] } ], "paymentAllocations": [ { "payment": { "id": "4355", "note": "", "reference": "", "accountRef": { "id": "348", "name": "CMRR Renewal" }, "currency": "GBP", "paidOnDate": "2020-01-20T00:00:00", "totalAmount": 11.99 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2020-01-20T00:00:00", "totalAmount": 11.99 } } ], "subTotal": 9.99, "taxAmount": 2, "totalAmount": 11.99, "modifiedDate": "2022-10-28T11:10:28Z", "sourceModifiedDate": "2022-08-22T09:26:42" }, { "id": "CCTRANSACTION:4356", "reference": "", "note": "Test 1", "issueDate": "2020-01-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "195", "name": "Insurance" }, "taxRateRef": { "id": "62022" }, "unitAmount": 9.99, "quantity": 1, "subTotal": 9.99, "taxAmount": 2, "totalAmount": 11.99, "trackingCategoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" } ] } ], "paymentAllocations": [ { "payment": { "id": "4356", "note": "", "reference": "", "accountRef": { "id": "348", "name": "CMRR Renewal" }, "currency": "GBP", "paidOnDate": "2020-01-20T00:00:00", "totalAmount": 11.99 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2020-01-20T00:00:00", "totalAmount": 11.99 } } ], "subTotal": 9.99, "taxAmount": 2, "totalAmount": 11.99, "modifiedDate": "2022-10-28T11:10:28Z", "sourceModifiedDate": "2022-02-17T23:26:16" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 57, "_links": { "current": { "href": "/companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts?page=1&pageSize=2" }, "self": { "href": "/companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts" }, "next": { "href": "/companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "dc1bb034-7bbf-4e84-b418-b7f4aee59d72", "reference": "", "contactRef": { "id": "737982b0-2811-44c9-bdb3-3b26a3a6ef8c", "dataType": "suppliers" }, "issueDate": "2022-11-22T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Bank fee", "accountRef": { "id": "2c410b86-de57-49d1-b540-4e8ce824979c", "name": "Bank Fees" }, "unitAmount": 15, "quantity": 1, "subTotal": 15, "taxAmount": 0, "totalAmount": 15, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "dc1bb034-7bbf-4e84-b418-b7f4aee59d72", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-11-22T00:00:00", "totalAmount": 15 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-11-22T00:00:00", "totalAmount": 15 } } ], "subTotal": 15, "taxAmount": 0, "totalAmount": 15, "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2021-01-03T21:43:46", "metadata": { "isDeleted": false } }, { "id": "521c2396-7f74-404c-9cca-31115296b808", "reference": "Eft", "contactRef": { "id": "74ea95ea-6e1e-435d-9c30-0dff8ae1bd80", "dataType": "suppliers" }, "issueDate": "2022-11-23T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Misc stationery", "accountRef": { "id": "cba6527d-f102-4538-b421-e483233e9d5a", "name": "Printing & Stationery" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "unitAmount": 18.09, "quantity": 1, "subTotal": 18.09, "taxAmount": 3.62, "totalAmount": 21.71, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "521c2396-7f74-404c-9cca-31115296b808", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-11-23T00:00:00", "totalAmount": 21.71 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-11-23T00:00:00", "totalAmount": 21.71 } } ], "subTotal": 18.09, "taxAmount": 3.62, "totalAmount": 21.71, "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2021-01-03T21:43:51", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 15, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company's connection.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-direct-costs" } }, "/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/directCostId" } ], "get": { "tags": [ "Direct costs" ], "summary": "Get direct cost", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectCost" }, "examples": { "Clear Books": { "value": { "id": "994ad234-ca05-466e-8e6a-117783b38cf6", "reference": "005b7b62-dc9f-42d2-85a2-4a2cefc6bab2", "note": "Direct Cost with 1 line items, totaling 242.20", "contactRef": { "id": "D4Q4iYwHou", "dataType": "suppliers" }, "issueDate": "2022-04-27T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Underground - Drain Saddle Branches 160mm x 110mm x 87 �", "accountRef": { "id": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Purchases" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "unitAmount": 220.18, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 220.18, "taxAmount": 22.02, "totalAmount": 242.2, "itemRef": { "id": "2", "name": "Solvent Weld Branch 160mm x 110mm x 87 �" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "994ad234-ca05-466e-8e6a-117783b38cf6", "note": "Payment for direct cost 994ad234-ca05-466e-8e6a-117783b38cf6", "reference": "Direct Cost 994ad234-ca05-466e-8e6a-117783b38cf6", "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-04-27T00:00:00", "totalAmount": 242.2 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-04-27T00:00:00", "totalAmount": -242.2 } } ], "subTotal": 220.18, "taxAmount": 22.02, "totalAmount": 242.2, "modifiedDate": "2023-04-26T12:38:18Z", "sourceModifiedDate": "2022-09-18T20:59:02", "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "6ab3e391-97d7-ec11-8e7e-000d3a0cfe40", "reference": "INS000090", "note": "3931", "issueDate": "2022-05-21T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "test expenses 2", "accountRef": { "id": "30" }, "taxRateRef": { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "effectiveTaxRate": 0 }, "unitAmount": 17.89, "quantity": -1, "subTotal": -17.89, "taxAmount": 0, "totalAmount": -17.89, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "6ab3e391-97d7-ec11-8e7e-000d3a0cfe40", "accountRef": { "id": "TEST" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-05-21T00:00:00", "totalAmount": -17.89 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-05-21T00:00:00", "totalAmount": -17.89 } } ], "subTotal": -17.89, "taxAmount": 0, "totalAmount": -17.89, "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2022-05-19T17:17:33Z", "metadata": { "isDeleted": false } } }, "FreeAgent": { "value": { "id": "190325254", "note": "Atomic Software Limite Wellington,Nzl", "issueDate": "2017-11-23T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Atomic Software Limite Wellington,Nzl", "accountRef": { "id": "285", "name": "Accommodation and Meals" }, "unitAmount": 11.92, "quantity": 1, "subTotal": 11.92, "taxAmount": 2.38, "totalAmount": 14.3, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "190325254", "note": "Atomic Software Limite Wellington,Nzl", "accountRef": { "id": "750-1", "name": "Bank Account: Business Current Account" }, "currency": "GBP", "paidOnDate": "2017-11-23T00:00:00", "totalAmount": 14.3 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2017-11-23T00:00:00", "totalAmount": 14.3 } } ], "subTotal": 11.92, "taxAmount": 2.38, "totalAmount": 14.3, "modifiedDate": "2023-04-25T14:20:36Z", "sourceModifiedDate": "2019-11-22T14:31:14Z", "metadata": { "isDeleted": false } } }, "FreshBooks": { "value": { "id": "29870062", "reference": "Food to keep me working", "note": "Food to keep me working", "contactRef": { "id": "Sainsburys", "dataType": "suppliers" }, "issueDate": "2019-02-12T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Food to keep me working", "accountRef": { "id": "3361426", "name": "Meals & Entertainment" }, "unitAmount": 10, "quantity": 1, "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "trackingCategoryRefs": [ { "id": "4370503", "name": "Meals & Entertainment" } ] } ], "paymentAllocations": [], "subTotal": 10, "taxAmount": 0, "totalAmount": 10, "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2021-10-28T15:21:46", "metadata": { "isDeleted": false } } }, "QuickBooks Desktop": { "value": { "id": "D7B-933784104", "reference": "93", "contactRef": { "id": "360000-933272659", "dataType": "suppliers" }, "issueDate": "2022-12-01T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "3C0000-933270542", "name": "Rent" }, "unitAmount": 1200, "quantity": 1, "subTotal": 1200, "totalAmount": 1200, "trackingCategoryRefs": [ { "id": "80000007-1197713802", "name": "Overhead" } ], "tracking": { "recordRefs": [ { "id": "80000007-1197713802", "dataType": "trackingCategories" }, { "id": "800000B0-1197755238", "dataType": "customers" } ] } } ], "paymentAllocations": [ { "payment": { "id": "D7B-933784104", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-12-01T00:00:00", "totalAmount": 1200 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-12-01T00:00:00", "totalAmount": 1200 } } ], "subTotal": 1200, "taxAmount": 0, "totalAmount": 1200, "modifiedDate": "2023-04-26T09:13:57Z", "sourceModifiedDate": "2023-12-16T05:04:10", "metadata": { "isDeleted": false } } }, "QuickBooks Online Sandbox": { "value": { "id": "PUR-85", "note": "Opening Balance from Bank", "issueDate": "2015-08-12T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "taxRateRef": { "id": "NON", "name": "NON", "effectiveTaxRate": 0 }, "unitAmount": 3831.8, "quantity": 1, "subTotal": 3831.8, "taxAmount": 0, "totalAmount": 3831.8, "trackingCategoryRefs": [], "tracking": { "recordRefs": [] } } ], "paymentAllocations": [ { "payment": { "id": "85", "reference": "Opening Balance from Bank", "accountRef": { "id": "57", "name": "Visa Credit Card" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2015-08-12T00:00:00", "totalAmount": 3831.8 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2015-08-12T00:00:00", "totalAmount": -3831.8 } } ], "subTotal": 3831.8, "taxAmount": 0, "totalAmount": 3831.8, "modifiedDate": "2023-04-26T09:36:40Z", "sourceModifiedDate": "2016-09-12T18:13:07Z", "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "PUR-15", "note": "Payment to Google", "issueDate": "2018-09-21T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Payment to Google", "accountRef": { "id": "37", "name": "Computer equipment accumulated depreciation brought forward" }, "taxRateRef": { "id": "NON", "name": "NON", "effectiveTaxRate": 0 }, "unitAmount": 1.59, "quantity": 1, "subTotal": 1.59, "taxAmount": 0, "totalAmount": 1.59, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "15", "reference": "Payment to Google", "accountRef": { "id": "61", "name": "Dave PP Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-09-21T00:00:00", "totalAmount": 1.59 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2018-09-21T00:00:00", "totalAmount": -1.59 } } ], "subTotal": 1.59, "taxAmount": 0, "totalAmount": 1.59, "modifiedDate": "2023-01-18T11:02:59Z", "sourceModifiedDate": "2018-12-17T14:56:44Z" } }, "Sage 50 (UK)": { "value": { "id": "73", "reference": "DD/STO", "issueDate": "2021-01-29T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Electrcity Direct Debit", "accountRef": { "id": "7200", "name": "Electricity" }, "taxRateRef": { "id": "3" }, "unitAmount": 150, "quantity": 1, "subTotal": 150, "taxAmount": 12, "totalAmount": 162, "trackingCategoryRefs": [ { "id": "department_0", "name": "Default" } ] } ], "paymentAllocations": [ { "payment": { "id": "73", "reference": "DD/STO", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-01-29T00:00:00", "totalAmount": 162 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2021-01-29T00:00:00", "totalAmount": 162 } } ], "subTotal": 150, "taxAmount": 12, "totalAmount": 162, "modifiedDate": "2023-03-30T14:42:35Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } } }, "Sage Intacct": { "value": { "id": "CCTRANSACTION:4355", "reference": "", "note": "Test 1", "issueDate": "2020-01-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "195", "name": "Insurance" }, "taxRateRef": { "id": "62018" }, "unitAmount": 9.99, "quantity": 1, "subTotal": 9.99, "taxAmount": 2, "totalAmount": 11.99, "trackingCategoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" } ] } ], "paymentAllocations": [ { "payment": { "id": "4355", "note": "", "reference": "", "accountRef": { "id": "348", "name": "CMRR Renewal" }, "currency": "GBP", "paidOnDate": "2020-01-20T00:00:00", "totalAmount": 11.99 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2020-01-20T00:00:00", "totalAmount": 11.99 } } ], "subTotal": 9.99, "taxAmount": 2, "totalAmount": 11.99, "modifiedDate": "2022-10-28T11:10:28Z", "sourceModifiedDate": "2022-08-22T09:26:42" } }, "Xero": { "value": { "id": "dc1bb034-7bbf-4e84-b418-b7f4aee59d72", "reference": "", "contactRef": { "id": "737982b0-2811-44c9-bdb3-3b26a3a6ef8c", "dataType": "suppliers" }, "issueDate": "2022-11-22T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Bank fee", "accountRef": { "id": "2c410b86-de57-49d1-b540-4e8ce824979c", "name": "Bank Fees" }, "unitAmount": 15, "quantity": 1, "subTotal": 15, "taxAmount": 0, "totalAmount": 15, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "dc1bb034-7bbf-4e84-b418-b7f4aee59d72", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-11-22T00:00:00", "totalAmount": 15 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-11-22T00:00:00", "totalAmount": 15 } } ], "subTotal": 15, "taxAmount": 0, "totalAmount": 15, "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2021-01-03T21:43:46", "metadata": { "isDeleted": false } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get direct cost* endpoint returns a single direct cost for a given directCostId.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a specific direct cost.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-direct-cost" } }, "/companies/{companyId}/connections/{connectionId}/options/directCosts": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create direct cost model", "tags": [ "Direct costs" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Dynamics 365 Business Central": { "value": { "type": "Object", "displayName": "Direct Cost", "description": "", "properties": { "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": false }, "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "Note", "details": "is not supported and will be ignored" } ] } }, "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "required": false, "validation": { "warnings": [], "information": [ { "field": "ContactRef", "details": "is not supported and will be ignored" } ] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "If unspecified, base currency is assumed. Must agree with the bank account in PaymentAllocations" } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "Required if the currency is not the base currency" } ] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the direct transaction excluding any taxes", "required": false, "validation": { "warnings": [], "information": [ { "field": "SubTotal", "details": "is not supported and will be ignored" } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the direct transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "TaxAmount", "details": "is not supported and will be ignored" } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the direct transaction, inclusive of tax", "required": false, "validation": { "warnings": [], "information": [ { "field": "TotalAmount", "details": "is not supported and will be ignored" } ] } }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "is not supported and will be ignored" } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "is not supported and will be ignored" } ] } }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given currency, of any discounts applied", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.DiscountAmount", "details": "is not supported and will be ignored" } ] } }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.DiscountPercentage", "details": "is not supported and will be ignored" } ] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.SubTotal", "details": "Required if totalAmount is not specified" } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxAmount", "details": "is not supported and will be ignored" } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TotalAmount", "details": "Required if subTotal is not specified" } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": false, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Name", "details": "is not supported and will be ignored" } ] } } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": false, "validation": { "warnings": [], "information": [ { "field": "TaxRateRef.Name", "details": "is not supported and will be ignored" } ] } }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": false, "validation": { "warnings": [], "information": [ { "field": "TaxRateRef.EffectiveTaxRate", "details": "is not supported and will be ignored" } ] } } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.ItemRef", "details": "is not supported and will be ignored" } ] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TrackingCategoryRefs", "details": "is not supported and will be ignored" } ] } } }, "required": true, "validation": { "warnings": [ { "field": "LineItems", "details": "Only one line is supported" } ], "information": [] } }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": false, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Name", "details": "is not supported and will be ignored" } ] } } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Payment.Currency", "details": "is not supported and will be ignored" } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the base company", "required": false, "validation": { "warnings": [], "information": [ { "field": "Payment.CurrencyRate", "details": "is not supported and will be ignored" } ] } }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": false, "validation": { "warnings": [], "information": [ { "field": "Payment.PaidOnDate", "details": "is not supported and will be ignored" } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": false, "validation": { "warnings": [], "information": [ { "field": "Payment.TotalAmount", "details": "is not supported and will be ignored" } ] } } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "Allocation.Currency", "details": "is not supported and will be ignored" } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "Allocation.CurrencyRate", "details": "is not supported and will be ignored" } ] } }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": false, "validation": { "warnings": [], "information": [ { "field": "Allocation.AllocatedOnDate", "details": "is not supported and will be ignored" } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": false, "validation": { "warnings": [], "information": [ { "field": "Allocation.TotalAmount", "details": "is not supported and will be ignored" } ] } } }, "required": true } }, "required": true, "validation": { "warnings": [ { "field": "PaymentAllocations", "details": "Only one line is supported" } ], "information": [] } } }, "required": true } }, "FreeAgent": { "value": { "type": "Object", "displayName": "Direct Cost", "description": "", "properties": { "id": { "type": "String", "displayName": "Unique Direct Transaction ID", "description": "The identifier for the direct transaction, unique to the company", "required": false, "validation": { "warnings": [ { "field": "Id", "details": "will be ignored on push. " } ], "information": [] } }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Reference", "details": "is not supported by FreeAgent and will not be mapped. " } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": true, "validation": { "warnings": [], "information": [ { "field": "Note", "details": "must be provided" } ] } }, "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": false, "validation": { "warnings": [ { "field": "ContactRef.Id", "details": "is not supported by FreeAgent and will be ignored on push. " } ], "information": [] } }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": false, "validation": { "warnings": [ { "field": "ContactRef.DataType", "details": "is not supported by FreeAgent and will be ignored on push. " } ], "information": [] } } }, "required": false }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "must be provided" } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false, "validation": { "warnings": [ { "field": "CurrencyRate", "details": "will be ignored on push. " } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "If a Note is provided, this field will be ignored on push. " } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": false, "validation": { "warnings": [ { "field": "LineItems.UnitAmount", "details": "will be ignored on push. " } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Quantity", "details": "will be ignored on push. " } ], "information": [] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "must be provided" } ] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": false, "validation": { "warnings": [ { "field": "AccountRef.Name", "details": "will be ignored on push. " } ], "information": [] } } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "will be ignored on push. " } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Name", "details": "will be ignored on push. " } ], "information": [] } }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.EffectiveTaxRate", "details": "will be ignored on push. " } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [ { "field": "LineItems", "details": "Exactly one line item must be specified" } ], "information": [] } }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the allocated payment", "required": false }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the allocated payment", "required": false }, "reference": { "type": "String", "displayName": "Reference", "description": "Reference associated with the allocated payment", "required": false }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "must be provided" } ] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": false, "validation": { "warnings": [ { "field": "AccountRef.Name", "details": "will be ignored on push. " } ], "information": [] } } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the base company", "required": false }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": false } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the transaction", "required": false }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": false } }, "required": false } }, "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the direct transaction excluding any taxes", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the direct transaction", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the direct transaction, inclusive of tax", "required": false }, "modifiedDate": { "type": "DateTime", "displayName": "Modified Date", "description": "The date the record was last updated in the system cache", "required": false, "validation": { "warnings": [ { "field": "ModifiedDate", "details": "will be ignored on push. " } ], "information": [] } }, "sourceModifiedDate": { "type": "DateTime", "displayName": "Source Modified Date", "description": "The date the record was last changed in the originating system", "required": false, "validation": { "warnings": [ { "field": "SourceModifiedDate", "details": "will be ignored on push. " } ], "information": [] } } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "Direct Cost", "description": "Direct Cost", "properties": { "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": false }, "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": true }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Should have the same sign across all line items" } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.AccountRef", "details": "Should not be a bank account" }, { "field": "LineItems.AccountRef", "details": "Should only be specified when pushing an expense" } ], "information": [] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.ItemRef", "details": "Should only be specified when pushing an item (not an expense)" } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxRateRef", "details": "Should be specified when item type is not 'Discount'" } ], "information": [] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true } }, "required": false } }, "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account of type 'Bank' OR type 'Credit Card'" } ], "information": [] } } }, "required": true } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "PaymentAllocations", "details": "Must contain a single allocation" } ] } } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Direct Cost", "description": "Direct Cost", "properties": { "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Reference", "details": "Represents the check number" } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Max length of 4096 characters." } ], "information": [] } }, "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "Must be a three letter ISO code" }, { "field": "Currency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "Currency", "details": "If not set, will default to the default currency" } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1." }, { "field": "CurrencyRate", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "required": true } }, "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the allocated payment", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "required": true, "validation": { "warnings": [], "information": [ { "field": "Payment.AccountRef", "details": "The account in which to make the deposit" } ] } }, "reference": { "type": "String", "displayName": "Reference", "description": "Reference associated with the allocated payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Payment.Reference", "details": "Use to reference the check number of this deposit." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the allocated payment", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the base company", "required": true }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": true } }, "required": true } }, "required": true, "validation": { "warnings": [ { "field": "PaymentAllocations", "details": "Must contain a single payment allocation" } ], "information": [] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the direct transaction", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the direct transaction excluding any taxes", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the direct transaction, inclusive of tax", "required": false }, "sourceModifiedDate": { "type": "DateTime", "displayName": "Source Modified Date", "description": "The date the record was last changed in the originating system", "required": false }, "modifiedDate": { "type": "DateTime", "displayName": "Modified Date", "description": "The date the record was last updated in the system cache", "required": false } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Direct Cost", "description": "Direct Cost", "properties": { "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "Suppliers", "type": "String", "displayName": "Suppliers", "required": false } ], "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": false, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "If the issue date is not supplied, the current date on the server is used." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Reference", "details": "Must be less than 22 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Required if multi-currency is enabled for the company." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": false }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": false, "validation": { "warnings": [ { "field": "Allocation.TotalAmount", "details": "Must match the sum of the line items" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": false, "validation": { "warnings": [ { "field": "Allocation.Currency", "details": "Must match the Currency of the company" } ], "information": [] } } }, "required": false }, "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": false, "validation": { "warnings": [ { "field": "Payment.TotalAmount", "details": "Must match the sum of the line items" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": false, "validation": { "warnings": [ { "field": "Payment.Currency", "details": "Must match the Currency of the company" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Must be Bank, Cash or Asset account" } ] } } }, "required": true } }, "required": true } }, "required": true, "validation": { "warnings": [ { "field": "PaymentAllocations", "details": "Must have exactly one payment allocation." } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.TrackingCategoryRefs", "details": "Must be a valid Id" } ], "information": [] } } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.TrackingCategoryRefs", "details": "Only one tracking category of type CLASS can be provided per item." }, { "field": "LineItems.TrackingCategoryRefs", "details": "Only one tracking category of type DEPARTMENT can be provided per invoice." }, { "field": "LineItems.TrackingCategoryRefs", "details": "All DEPARTMENT tracking categories must be the same" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be an Expense or Income account" } ], "information": [] } } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.AccountRef", "details": "Must be set if ItemRef is not" } ], "information": [] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.ItemRef", "details": "Must be set if AccountRef is not" } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Must be less than 4000 characters." } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxAmount", "details": "Must be specified on all line items or none. If specified will override QBO tax calculations." } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [], "information": [ { "field": "TaxRateRef.Id", "details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used." } ] } } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxRateRef", "details": "Required for all companies except QuickBooks Online France companies." } ], "information": [] } } }, "required": true } }, "required": true } }, "QuickBooks Online": { "value": { "type": "Object", "displayName": "Direct Cost", "description": "Direct Cost", "properties": { "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "Suppliers", "type": "String", "displayName": "Suppliers", "required": false } ], "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": false, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "If the issue date is not supplied, the current date on the server is used." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Reference", "details": "Must be less than 22 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Required if multi-currency is enabled for the company." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": false }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": false, "validation": { "warnings": [ { "field": "Allocation.TotalAmount", "details": "Must match the sum of the line items" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": false, "validation": { "warnings": [ { "field": "Allocation.Currency", "details": "Must match the Currency of the company" } ], "information": [] } } }, "required": false }, "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": false, "validation": { "warnings": [ { "field": "Payment.TotalAmount", "details": "Must match the sum of the line items" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": false, "validation": { "warnings": [ { "field": "Payment.Currency", "details": "Must match the Currency of the company" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Must be Bank, Cash or Asset account" } ] } } }, "required": true } }, "required": true } }, "required": true, "validation": { "warnings": [ { "field": "PaymentAllocations", "details": "Must have exactly one payment allocation." } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.TrackingCategoryRefs", "details": "Must be a valid Id" } ], "information": [] } } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.TrackingCategoryRefs", "details": "Only one tracking category of type CLASS can be provided per item." }, { "field": "LineItems.TrackingCategoryRefs", "details": "Only one tracking category of type DEPARTMENT can be provided per invoice." }, { "field": "LineItems.TrackingCategoryRefs", "details": "All DEPARTMENT tracking categories must be the same" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be an Expense or Income account" } ], "information": [] } } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.AccountRef", "details": "Must be set if ItemRef is not" } ], "information": [] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.ItemRef", "details": "Must be set if AccountRef is not" } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Must be less than 4000 characters." } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxAmount", "details": "Must be specified on all line items or none. If specified will override QBO tax calculations." } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [], "information": [ { "field": "TaxRateRef.Id", "details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used." } ] } } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxRateRef", "details": "Required for all companies except QuickBooks Online France companies." } ], "information": [] } } }, "required": true } }, "required": true } }, "Sage 50 (UK)": { "value": { "type": "Object", "displayName": "Direct Cost", "description": "Direct Cost", "properties": { "reference": { "type": "String", "displayName": "Reference", "description": "The user reference for this direct cost.", "required": false }, "issueDate": { "type": "Number", "displayName": "Issue Date", "description": "The date this payment was issued.", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency in which the direct cost is issued in.", "required": true, "validation": { "warnings": [ { "field": "currency", "details": "This must match the target account's default currency." } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Rate", "description": "The currency rate associated with this transaction.", "required": true }, "accountRef": { "type": "Object", "displayName": "Bank Account", "description": "The bank account to pay this direct cost from.", "properties": { "id": { "type": "String", "displayName": "Account Id", "description": "Nominal code of the bank account.", "required": true, "validation": { "warnings": [ { "field": "accountRef.id", "details": "Must match the ID of an existing bank account and have a max length of 8 characters." } ], "information": [] } } }, "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total", "description": "The net amount being paid in this direct cost.", "required": true, "validation": { "warnings": [], "information": [ { "details": "This must equal the sum of the line net amounts" } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The tax amount being paid in this direct cost.", "required": true, "validation": { "warnings": [], "information": [ { "details": "This must equal the sum of the line tax amounts" } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount being paid in this direct cost.", "required": true, "validation": { "warnings": [], "information": [ { "details": "This must equal the sum of the line amounts" } ] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "Line items of the direct cost.", "properties": { "description": { "type": "String", "displayName": "description", "description": "Description of the direct cost line item.", "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Code", "description": "Target bank account for the direct cost line item.", "properties": { "id": { "type": "String", "displayName": "Id", "description": "The ID of the Account the line is linked to.", "required": true } }, "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "Unit amount for the direct cost line item.", "required": true, "validation": { "warnings": [ { "field": "LineItems.unitAmount", "details": "Cannot equal 0 and will be set to Net amount if not provided accordingly." } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "Quantity for the direct cost line item.", "required": true, "validation": { "warnings": [ { "field": "LineItems.quantity", "details": "Must be 1 or -1." } ], "information": [] } }, "subTotal": { "type": "Number", "displayName": "Net Amount", "description": "Amount for the direct cost line item. Debit entries are considered positive, and credit entries are considered negative.", "required": true, "validation": { "warnings": [ { "field": "LineItems.subTotal", "details": "Cannot have both subtotal and tax amount as 0 for line item." } ], "information": [] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "Tax amount for the direct cost line item.", "required": false, "validation": { "warnings": [ { "field": "LineItems.taxAmount", "details": "Cannot have both tax amount and subtotal as 0 for line item." } ], "information": [] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "Total amount for the direct cost line item.", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.totalAmount", "details": "Will be auto populated using tax amount and net amount." } ] } }, "taxCode": { "type": "Number", "displayName": "Tax Code Id", "description": "The tax code ID associated with this transaction.", "required": true }, "trackingCategoryRefs": { "type": "Object", "displayName": "Tracking Category References", "description": "Tracking categories associated with this transaction.", "properties": { "id": { "type": "String", "displayName": "Id", "description": "The ID of the tracking category associated with the transaction", "required": true, "validation": { "warnings": [ { "field": "id", "details": "A department is required. If a project reference is provided, the cost code for that project must also be provided." } ], "information": [] } } }, "required": true } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company." } ] } } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "Direct Cost", "description": "Direct Cost", "properties": { "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": true, "validation": { "warnings": [], "information": [ { "field": "Note", "details": "Must be used to provide payee's name and contain no more than 80 characters." } ] } }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [], "information": [ { "field": "TaxRateRef.Id", "details": "Must be an existing tax rate in Sage Intacct." } ] } } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.Description", "details": "Must not contain no more than 1000 characters." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": false }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": false } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must contain at least one line item." } ] } }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": false, "validation": { "warnings": [], "information": [ { "field": "Payment.TotalAmount", "details": "If provided, must match the sum of the line items." } ] } } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": false, "validation": { "warnings": [], "information": [ { "field": "Allocation.TotalAmount", "details": "If provided, must match the sum of the line items." } ] } } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "PaymentAllocations", "details": "Must contain a single allocation." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "When supplying a currency ensure that it exists in your Sage Intacct entity otherwise the request will fail." } ], "information": [] } }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "Reference", "details": "Must not contain no more than 45 characters." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the direct transaction, inclusive of tax", "required": false, "validation": { "warnings": [], "information": [ { "field": "TotalAmount", "details": "If provided, must match the sum of the line items." } ] } } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Direct Cost", "description": "Direct Cost", "properties": { "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": true }, "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": true }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": true }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": true } }, "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given currency, of any discounts applied", "required": true }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the item referenced by the identifier", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": true } }, "required": true }, "tracking": { "type": "Object", "displayName": "Tracking", "description": "Information this item is being tracked against", "properties": { "recordRefs": { "type": "Array", "displayName": "Record References", "description": "A collection of records this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true }, "invoiceTo": { "type": "Object", "displayName": "Invoice To", "description": "The entity the record should be invoiced to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true } }, "required": true } }, "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the allocated payment", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the allocated payment", "required": true }, "reference": { "type": "String", "displayName": "Reference", "description": "Reference associated with the allocated payment", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the base company", "required": true }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": true } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the transaction", "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": true } }, "required": true } }, "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the direct transaction excluding any taxes", "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the direct transaction", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the direct transaction, inclusive of tax", "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Direct Cost", "description": "Direct Cost", "properties": { "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must be provided." } ] } }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "Reference", "details": "Must not exceed 255 characters." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": true, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Must be provided." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the direct transaction", "required": true, "validation": { "warnings": [], "information": [ { "field": "TaxAmount", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the direct transaction, inclusive of tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "TotalAmount", "details": "Must be provided." } ] } }, "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "ContactRef.Id", "details": "Must be a valid GUID." }, { "field": "ContactRef.Id", "details": "Must match the ID of an existing contact." } ], "information": [ { "field": "ContactRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "ContactRef", "details": "Must be provided." } ] } }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a bank account." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing bank account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Payment.AccountRef", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "PaymentAllocations.Payment", "details": "Must be provided." } ] } }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": true, "validation": { "warnings": [ { "field": "Allocation.TotalAmount", "details": "Must be equal to the sum of line items." } ], "information": [ { "field": "Allocation.TotalAmount", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "PaymentAllocations.Allocation", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "PaymentAllocations", "details": "Must be provided." } ] } }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Description", "details": "Must not be longer than 4000 characters long." } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false, "validation": { "warnings": [ { "field": "LineItems.TotalAmount", "details": "When negative, the push item will be converted to a DirectIncome and will be pushed accordingly." } ], "information": [ { "field": "LineItems.TotalAmount", "details": "When one line is negative, all lines must be negative." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxAmount", "details": "Must be provided." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a valid GUID." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.AccountRef", "details": "Must be provided." } ] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [], "information": [ { "field": "TrackingCategoryRefs.Id", "details": "Must be provided." } ] } } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TrackingCategoryRefs", "details": "Tracking categories must not have the same parent tracking category." }, { "field": "LineItems.TrackingCategoryRefs", "details": "Maximum of 2 Tracking Categories." } ] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax rate." } ], "information": [ { "field": "TaxRateRef.Id", "details": "If not provided, will be set to the default tax rate for the line's account." } ] } } }, "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must be a valid GUID." }, { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [ { "details": "When negative, the push item will be converted to a DirectIncome and will be pushed accordingly." } ], "information": [] } } }, "Zoho Books": { "value": { "type": "Object", "displayName": "Direct Cost", "description": "Direct Cost", "properties": { "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": false }, "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": false }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false }, "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": false } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "ContactRef", "details": "Required when pushing a negative direct cost & should reference either a Customer or Supplier when provided" } ] } }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TotalAmount", "details": "Should be provided when SubTotal is not provided" } ] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.SubTotal", "details": "Should be provided when TotalAmount is not provided" } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false } }, "required": false }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "required": false } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Is required when pushing a negative direct cost" } ] } }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Payment.Currency", "details": "Is required when pushing a negative direct cost" } ] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "Allocation.Currency", "details": "Is required when pushing a negative direct cost" } ] } } }, "required": true } }, "required": true } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-directCosts-model", "description": "The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a [direct cost](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company and integration.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support creating a direct cost.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/directCosts": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Direct costs" ], "summary": "Create direct cost", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectCost/definitions/directCostPrototype" }, "examples": { "QuickBooks Desktop": { "value": { "reference": "test ref", "note": "directCost 21/03 09.20", "contactRef": { "id": "80000001-1671793885", "dataType": "suppliers" }, "issueDate": "2023-03-21T10:19:52.223Z", "currency": "USD", "lineItems": [ { "description": "test description line 1", "unitAmount": 7, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 99, "taxAmount": 360, "totalAmount": 70, "accountRef": { "id": "8000000D-1671793811", "name": "Purchases - Hardware for Resale" }, "itemRef": { "id": "80000001-1674566705", "name": "item test" }, "trackingCategoryRefs": [ { "id": "80000001-1674553252", "name": "Class 1" } ] } ], "paymentAllocations": [ { "payment": { "note": "payment allocations note", "reference": "payment allocations reference", "accountRef": { "id": "80000028-1671794219", "name": "Bank Account 1" }, "paidOnDate": "2023-01-28T10:19:52.223Z", "totalAmount": 54 }, "allocation": { "currencyRate": 0, "allocatedOnDate": "2023-01-29T10:19:52.223Z", "totalAmount": 88 } } ], "subTotal": 362, "taxAmount": 4, "totalAmount": 366 } }, "Xero": { "value": { "reference": "Scenario One neg DC", "contactRef": { "id": "699f0091-b127-4796-9f15-41a2f42abeb2", "dataType": "suppliers" }, "issueDate": "2023-02-25", "currency": "GBP", "lineItems": [ { "description": "negative direct cost", "unitAmount": 35, "quantity": -1, "subTotal": -35, "taxAmount": -7, "totalAmount": -42, "itemRef": { "id": "965cfc0e-4d80-4059-9641-4a392f9ad549" }, "taxRateRef": { "id": "INPUT2" } } ], "paymentAllocations": [ { "payment": { "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4" }, "currency": "GBP" }, "allocation": { "totalAmount": -42 } } ], "subTotal": -35, "taxAmount": -7, "totalAmount": -42 } }, "FreeAgent": { "value": { "issueDate": "2023-02-12", "currency": "GBP", "lineItems": [ { "unitAmount": 15, "quantity": 1, "subTotal": 15, "accountRef": { "id": "288" } } ], "paymentAllocations": [ { "payment": { "accountRef": { "id": "750-1" } }, "allocation": {} } ], "subTotal": 15, "taxAmount": 0, "totalAmount": 15 } }, "Sage Intacct": { "value": { "reference": "test ref", "note": "Test 1", "issueDate": "2023-03-31T00:00:00", "currency": "USD", "currencyRate": 0.5, "lineItems": [ { "accountRef": { "id": "195" }, "unitAmount": 9.99, "quantity": 1, "subTotal": 9.99, "taxAmount": 2, "totalAmount": 11.99 } ], "paymentAllocations": [ { "payment": { "id": "4355", "note": "test note", "reference": "test reference", "accountRef": { "id": "348", "name": "CMRR Renewal" }, "currency": "USD", "paidOnDate": "2023-03-31T00:00:00", "totalAmount": 11.99 }, "allocation": { "currency": "USD", "allocatedOnDate": "2023-03-31T00:00:00", "totalAmount": 11.99 } } ], "subTotal": 9.99, "taxAmount": 2, "totalAmount": 11.99 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDirectCostResponse" }, "examples": { "FreeAgent": { "value": { "changes": [], "data": { "id": "372060709", "issueDate": "2023-02-12T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "288" }, "unitAmount": 15, "quantity": 1, "subTotal": 15, "taxAmount": 3, "totalAmount": 18, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "372060709", "accountRef": { "id": "750-1" }, "currency": "GBP", "paidOnDate": "2023-02-12T00:00:00", "totalAmount": 18 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2023-02-12T00:00:00", "totalAmount": 18 } } ], "subTotal": 15, "taxAmount": 3, "totalAmount": 18, "sourceModifiedDate": "2023-02-12T15:15:53Z" }, "dataType": "directCosts", "companyId": "a23f79d6-7cc9-486c-b388-8ab88faea947", "pushOperationKey": "0659a24d-2b66-4979-971e-4b98c3ed7f61", "dataConnectionKey": "35e38cd5-66ea-41b8-b555-9efd5b792b68", "requestedOnUtc": "2023-02-12T15:15:51.1723204Z", "completedOnUtc": "2023-02-12T15:15:54.7161036Z", "status": "Success", "statusCode": 200 } }, "Sage Intacct": { "value": { "changes": [ { "type": "Created", "recordRef": { "dataType": "directCosts" } } ], "data": { "reference": "test ref", "note": "Test 1", "issueDate": "2023-03-31T00:00:00", "currency": "USD", "currencyRate": 0.5, "lineItems": [ { "accountRef": { "id": "195" }, "taxRateRef": { "id": "95" }, "unitAmount": 9.99, "quantity": 1, "subTotal": 9.99, "taxAmount": 2, "totalAmount": 11.99, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "4355", "note": "test note", "reference": "test reference", "accountRef": { "id": "348", "name": "CMRR Renewal" }, "currency": "USD", "paidOnDate": "2023-03-31T00:00:00", "totalAmount": 11.99 }, "allocation": { "currency": "USD", "allocatedOnDate": "2023-03-31T00:00:00", "totalAmount": 11.99 } } ], "subTotal": 9.99, "taxAmount": 2, "totalAmount": 11.99 }, "dataType": "directCosts", "companyId": "d7f743a9-1804-4116-8c8a-e606f7e2f66c", "pushOperationKey": "0d74c1ad-00ad-4731-9e6e-98a86056959a", "dataConnectionKey": "fa139396-523a-4a58-bf2b-8da82c8a673f", "requestedOnUtc": "2023-03-31T12:49:51.6503324Z", "status": "Pending", "statusCode": 202 } }, "Xero": { "value": { "changes": [], "data": { "reference": "Scenario One neg DC", "contactRef": { "id": "699f0091-b127-4796-9f15-41a2f42abeb2", "dataType": "suppliers" }, "issueDate": "2023-02-25T00:00:00", "currency": "GBP", "lineItems": [ { "description": "negative direct cost", "taxRateRef": { "id": "INPUT2" }, "unitAmount": 35, "quantity": -1, "subTotal": -35, "taxAmount": -7, "totalAmount": -42, "itemRef": { "id": "965cfc0e-4d80-4059-9641-4a392f9ad549" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4" }, "currency": "GBP", "paidOnDate": "0001-01-01T00:00:00", "totalAmount": 0 }, "allocation": { "totalAmount": -42 } } ], "subTotal": 0, "taxAmount": -7, "totalAmount": -42 }, "dataType": "directCosts", "companyId": "b5efee61-3fab-4a5d-9247-de03d6eda6db", "pushOperationKey": "33347930-fcc5-4f95-aa13-4a0f7291b559", "dataConnectionKey": "1e355304-4476-422e-95cb-fa2a6d47fab4", "requestedOnUtc": "2023-02-24T13:43:26.5109173Z", "status": "Pending", "validation": { "errors": [], "warnings": [] }, "statusCode": 202 } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create direct cost* endpoint creates a new [direct cost](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company's connection.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are the expenses associated with a business' operations. For example, purchases of raw materials that are paid off at the point of the purchase and service fees are considered direct costs.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create direct cost model](https://docs.codat.io/accounting-api#/operations/get-create-directCosts-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support creating an account.\n", "operationId": "create-direct-cost" } }, "/companies/{companyId}/connections/{connectionId}/push/directCosts/{directCostId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/directCostId" } ], "delete": { "summary": "Delete direct cost", "operationId": "delete-direct-cost", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOperationSummary" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Delete direct cost* endpoint allows you to delete a specified direct cost from an accounting software. \n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are the expenses associated with a business' operations. For example, purchases of raw materials that are paid off at the point of the purchase and service fees are considered direct costs.\n\n### Process \n1. Pass the `{directCostId}` to the *Delete direct cost* endpoint and store the `pushOperationKey` returned.\n2. Check the status of the delete operation by checking the status of the push operation either via\n 1. [Push operation webhook](https://docs.codat.io/introduction/webhooks/core-rules-types#push-operation-status-has-changed) (advised),\n 2. [Push operation status endpoint](https://docs.codat.io/codat-api#/operations/get-push-operation).\n\n A `Success` status indicates that the direct cost object was deleted from the accounting software.\n3. (Optional) Check that the direct cost was deleted from the accounting software.\n\n### Effect on related objects\nBe aware that deleting a direct cost from an accounting software might cause related objects to be modified.\n\n## Integration specifics\nIntegrations that support soft delete do not permanently delete the object in the accounting software.\n\n| Integration | Soft Delete | Details | \n|--------------------|-------------|-----------------------------------------------------------------------------------------------------------|\n| QuickBooks Desktop | No | - |\n\n> **Supported Integrations**\n> \n> This functionality is currently supported for our QuickBooks Desktop integration.", "tags": [ "Direct costs" ] } }, "/companies/{companyId}/connections/{connectionId}/push/directCosts/{directCostId}/attachment": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/directCostId" } ], "post": { "tags": [ "Direct costs" ], "summary": "Upload direct cost attachment", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AttachmentUpload" } } } }, "responses": { "200": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Upload direct cost attachment* endpoint uploads an attachment and assigns it against a specific `directCostId`.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\n**Integration-specific behaviour**\n\nFor more details on supported file types by integration see [Attachments](https://docs.codat.io/accounting-api#/schemas/Attachment).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support uploading a direct cost attachment.\n", "operationId": "upload-direct-cost-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/directCostId" } ], "get": { "tags": [ "Direct costs" ], "summary": "Get direct cost attachment", "parameters": [ { "$ref": "#/components/parameters/attachmentId" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a direct cost attachment.\n", "operationId": "get-direct-cost-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}/download": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/directCostId" } ], "get": { "tags": [ "Direct costs" ], "summary": "Download direct cost attachment", "parameters": [ { "$ref": "#/components/parameters/attachmentId" } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "title": "Data", "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support downloading a direct cost attachment.\n", "operationId": "download-direct-cost-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/directCostId" } ], "get": { "tags": [ "Direct costs" ], "summary": "List direct cost attachments", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentsDataset" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`.\n\n[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support listing direct cost attachments.\n", "operationId": "list-direct-cost-attachments" } }, "/companies/{companyId}/connections/{connectionId}/data/directIncomes": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "tags": [ "Direct incomes" ], "summary": "List direct incomes", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectIncomes" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "38e8c917-0afc-4583-8ffe-1b53ad601197", "reference": "3cb8ced3-3ecb-4974-ada5-8290b0ec3355", "note": "Direct Income with 1 line items, totaling 188.33", "contactRef": { "id": "51f03576-f6b0-40d5-9fba-81a490411c03", "dataType": "customers" }, "issueDate": "2022-04-19T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Underground - Drain Yard Gully", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "unitAmount": 171.21, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 171.21, "taxAmount": 17.12, "totalAmount": 188.33, "itemRef": { "id": "00491160-6ee5-4d76-9f34-998f00687481", "name": "Aluminium Silt Bucket" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "38e8c917-0afc-4583-8ffe-1b53ad601197", "note": "Payment for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197", "reference": "Direct Income 38e8c917-0afc-4583-8ffe-1b53ad601197", "accountRef": { "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3", "name": "Undeposited Funds" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-04-19T00:00:00", "totalAmount": 188.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-04-19T00:00:00", "totalAmount": -188.33 } } ], "subTotal": 171.21, "taxAmount": 17.12, "totalAmount": 188.33, "modifiedDate": "2023-04-26T12:38:18Z", "sourceModifiedDate": "2022-05-13T01:06:00", "metadata": { "isDeleted": false } }, { "id": "c31a3778-e3ea-4d01-9281-dd2f291c8cb8", "reference": "ee4ea56f-8806-494d-9c69-7ec22e68dc5e", "note": "Direct Income with 4 line items, totaling 32095.91", "contactRef": { "id": "453ddfc0-49ce-4f66-a815-dae734be885c", "dataType": "customers" }, "issueDate": "2022-04-19T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Underground - Drain Bottle Gullies 90 degree Rectangular", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "unitAmount": 95.08, "quantity": 2, "discountAmount": 0, "discountPercentage": 0, "subTotal": 190.16, "taxAmount": 19.02, "totalAmount": 209.18, "itemRef": { "id": "6", "name": "Back Inlet Roddable Gully 90� Outlet Rectangular Grid" }, "trackingCategoryRefs": [ { "id": "costcode_9", "name": "PandaConstruction" }, { "id": "department_3", "name": "MarshallBrotherContracting" } ] }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "unitAmount": 1251.89, "quantity": 6, "discountAmount": 778.93, "discountPercentage": 10.37, "subTotal": 6732.41, "taxAmount": 673.24, "totalAmount": 7405.66, "itemRef": { "id": "51077072-d5c3-463b-9cb4-7da2e11886f9", "name": "150 Litre Grease Trap" }, "trackingCategoryRefs": [] }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "unitAmount": 2781.94, "quantity": 2, "discountAmount": 0, "discountPercentage": 0, "subTotal": 5563.88, "taxAmount": 556.39, "totalAmount": 6120.27, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [] }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "unitAmount": 2781.94, "quantity": 6, "discountAmount": 0, "discountPercentage": 0, "subTotal": 16691.64, "taxAmount": 1669.16, "totalAmount": 18360.8, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "c31a3778-e3ea-4d01-9281-dd2f291c8cb8", "note": "Payment for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8", "reference": "Direct Income c31a3778-e3ea-4d01-9281-dd2f291c8cb8", "accountRef": { "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3", "name": "Undeposited Funds" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-04-19T00:00:00", "totalAmount": 32095.91 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-04-19T00:00:00", "totalAmount": -32095.91 } } ], "subTotal": 29178.09, "taxAmount": 2917.81, "totalAmount": 32095.91, "modifiedDate": "2023-04-26T12:38:18Z", "sourceModifiedDate": "2023-02-13T00:34:00", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 518, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "8be30162-feec-ec11-82f9-000d3a8746a9", "reference": "B1234", "note": "4006", "issueDate": "2022-06-18T00:00:00", "currency": "USD", "currencyRate": 0.648364486, "lineItems": [ { "description": "Interest Income", "accountRef": { "id": "221217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Interest Income" }, "taxRateRef": { "id": "63bc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for DOMESTIC / STANDARD", "effectiveTaxRate": 10 }, "unitAmount": 7.13, "quantity": 1, "subTotal": 7.13, "taxAmount": 1.43, "totalAmount": 8.56, "trackingCategoryRefs": [ { "id": "adbc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "ADM-Administration" } ] } ], "paymentAllocations": [ { "payment": { "id": "8be30162-feec-ec11-82f9-000d3a8746a9", "accountRef": { "id": "8277672c-b8e6-ec11-82f8-0022481a77f0", "name": "B020-BoA" }, "currency": "USD", "currencyRate": 0.6483644859813084, "paidOnDate": "2022-06-18T00:00:00", "totalAmount": 8.56 }, "allocation": { "currency": "USD", "currencyRate": 0.6483644859813084, "allocatedOnDate": "2022-06-18T00:00:00", "totalAmount": 8.56 } } ], "subTotal": 7.13, "taxAmount": 1.43, "totalAmount": 8.56, "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2022-06-15T22:56:26Z", "metadata": { "isDeleted": false } }, { "id": "f68e56e0-b8bd-ed11-9a88-6045bd0f9361", "reference": "B110", "note": "4990", "issueDate": "2023-03-07T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Accounts Receivable", "accountRef": { "id": "641217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Receivable" }, "taxRateRef": { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "effectiveTaxRate": 0 }, "unitAmount": 649.4, "quantity": -1, "subTotal": -649.4, "taxAmount": 0, "totalAmount": -649.4, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "f68e56e0-b8bd-ed11-9a88-6045bd0f9361", "accountRef": { "id": "b6545a08-a9bd-ed11-9a88-0022484358c7", "name": "HOLDING_LENDING" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-03-07T00:00:00", "totalAmount": -649.4 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2023-03-07T00:00:00", "totalAmount": -649.4 } } ], "subTotal": -649.4, "taxAmount": 0, "totalAmount": -649.4, "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2023-03-08T13:55:34Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directIncomes?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directIncomes" } } } }, "FreeAgent": { "value": { "results": [ { "id": "344673327", "note": "Test Transaction 2", "issueDate": "2017-11-01T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Test Transaction 2", "accountRef": { "id": "001", "name": "Sales" }, "unitAmount": 10.5, "quantity": 1, "subTotal": 10.5, "taxAmount": 0, "totalAmount": 10.5, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "344673327", "note": "Test Transaction 2", "accountRef": { "id": "750-1", "name": "Bank Account: Business Current Account" }, "currency": "GBP", "paidOnDate": "2017-11-01T00:00:00", "totalAmount": 10.5 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2017-11-01T00:00:00", "totalAmount": 10.5 } } ], "subTotal": 10.5, "taxAmount": 0, "totalAmount": 10.5, "modifiedDate": "2023-04-25T14:20:36Z", "sourceModifiedDate": "2022-10-06T10:38:24Z", "metadata": { "isDeleted": false } }, { "id": "348104863", "note": "Codat Ltd Ref: Nov Topup", "issueDate": "2017-11-23T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Codat Ltd Ref: Nov Topup", "accountRef": { "id": "001", "name": "Sales" }, "unitAmount": 100, "quantity": 1, "subTotal": 100, "taxAmount": 0, "totalAmount": 100, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "348104863", "note": "Codat Ltd Ref: Nov Topup", "accountRef": { "id": "750-1", "name": "Bank Account: Business Current Account" }, "currency": "GBP", "paidOnDate": "2017-11-23T00:00:00", "totalAmount": 100 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2017-11-23T00:00:00", "totalAmount": 100 } } ], "subTotal": 100, "taxAmount": 0, "totalAmount": 100, "modifiedDate": "2023-04-25T14:20:36Z", "sourceModifiedDate": "2022-10-24T12:13:27Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 211, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "9B87-1181931723", "reference": "9C08-1181931827", "contactRef": { "id": "280000-933272658", "dataType": "customers" }, "issueDate": "2023-01-15T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "80000-933270541", "name": "Undeposited Funds" }, "unitAmount": 1228.18, "quantity": 1, "subTotal": 1228.18, "taxAmount": 0, "totalAmount": 1228.18, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "9B87-1181931723", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-01-15T00:00:00", "totalAmount": 1228.18 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2023-01-15T00:00:00", "totalAmount": 1228.18 } } ], "subTotal": 1228.18, "taxAmount": 0, "totalAmount": 1228.18, "modifiedDate": "2023-04-26T09:14:12Z", "sourceModifiedDate": "2023-12-16T05:06:23", "metadata": { "isDeleted": false } }, { "id": "68E0-1197775239", "reference": "96F3-1197775718", "contactRef": { "id": "800000B5-1197701259", "dataType": "customers" }, "issueDate": "2023-01-17T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "80000-933270541", "name": "Undeposited Funds" }, "unitAmount": 361.08, "quantity": 1, "subTotal": 361.08, "taxAmount": 0, "totalAmount": 361.08, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "68E0-1197775239", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-01-17T00:00:00", "totalAmount": 15281.67 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2023-01-17T00:00:00", "totalAmount": 361.08 } } ], "subTotal": 361.08, "taxAmount": 0, "totalAmount": 361.08, "modifiedDate": "2023-04-26T09:14:12Z", "sourceModifiedDate": "2023-12-16T05:06:11", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 104, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "5-1", "contactRef": { "id": "52", "dataType": "suppliers" }, "issueDate": "2015-11-24T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "contribution to start business", "accountRef": { "id": "61", "name": "Owner's Equity - Contributions" }, "taxRateRef": { "id": "2_Invoices", "name": "Exempt Invoices", "effectiveTaxRate": 0 }, "unitAmount": 10000, "quantity": 1, "discountAmount": 0, "subTotal": 10000, "taxAmount": 0, "totalAmount": 10000, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "5-1", "accountRef": { "id": "81", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2015-11-24T00:00:00", "totalAmount": 10000 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2015-11-24T00:00:00", "totalAmount": -10000 } } ], "subTotal": 10000, "taxAmount": 0, "totalAmount": 10000, "modifiedDate": "2023-04-26T09:36:04Z", "sourceModifiedDate": "2016-09-12T15:26:26Z", "metadata": { "isDeleted": false } }, { "id": "5-2", "contactRef": { "id": "53", "dataType": "suppliers" }, "issueDate": "2015-11-24T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "funds borrowed to start business", "accountRef": { "id": "63", "name": "Note Payable" }, "taxRateRef": { "id": "2_Invoices", "name": "Exempt Invoices", "effectiveTaxRate": 0 }, "unitAmount": 25000, "quantity": 1, "discountAmount": 0, "subTotal": 25000, "taxAmount": 0, "totalAmount": 25000, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "5-2", "accountRef": { "id": "81", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2015-11-24T00:00:00", "totalAmount": 25000 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2015-11-24T00:00:00", "totalAmount": -25000 } } ], "subTotal": 25000, "taxAmount": 0, "totalAmount": 25000, "modifiedDate": "2023-04-26T09:36:04Z", "sourceModifiedDate": "2016-09-12T15:26:26Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 741, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "1", "note": "Opening Balance from Bank", "issueDate": "2018-09-21T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "53", "name": "Retained profit balance forward account" }, "unitAmount": 170.23, "quantity": 1, "discountAmount": 0, "subTotal": 170.23, "taxAmount": 0, "totalAmount": 170.23, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "1", "accountRef": { "id": "61", "name": "Dave PP Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-09-21T00:00:00", "totalAmount": 170.23 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2018-09-21T00:00:00", "totalAmount": -170.23 } } ], "subTotal": 170.23, "taxAmount": 0, "totalAmount": 170.23, "modifiedDate": "2023-01-18T11:02:50Z", "sourceModifiedDate": "2018-12-17T14:56:20Z" }, { "id": "11", "note": "Payment from CD Baby, a division of Audio and Video Labs Inc", "issueDate": "2018-10-15T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Payment from CD Baby, a division of Audio and Video Labs Inc", "accountRef": { "id": "57", "name": "Sales of Product Income" }, "unitAmount": 8.12, "quantity": 1, "discountAmount": 0, "subTotal": 8.12, "taxAmount": 0, "totalAmount": 8.12, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "11", "accountRef": { "id": "61", "name": "Dave PP Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-10-15T00:00:00", "totalAmount": 8.12 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2018-10-15T00:00:00", "totalAmount": -8.12 } } ], "subTotal": 8.12, "taxAmount": 0, "totalAmount": 8.12, "modifiedDate": "2023-01-18T11:02:50Z", "sourceModifiedDate": "2018-12-17T14:56:44Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1171, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "4973", "reference": "dt test contact", "note": "dt header description", "issueDate": "2022-03-15T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Dt test line1", "accountRef": { "id": "151", "name": "Cash" }, "taxRateRef": { "id": "99", "name": "UK Sale Goods Standard Rate", "effectiveTaxRate": 20 }, "unitAmount": 125, "quantity": 1, "subTotal": 125, "taxAmount": 25, "totalAmount": 150, "trackingCategoryRefs": [ { "id": "DEPARTMENT-1", "name": "Sales" }, { "id": "LOCATION-8", "name": "United Kingdom" } ] }, { "description": "dt test line 2", "accountRef": { "id": "152", "name": "Cash Equivalents" }, "taxRateRef": { "id": "99", "name": "UK Sale Goods Standard Rate", "effectiveTaxRate": 20 }, "unitAmount": 166.67, "quantity": 1, "subTotal": 166.67, "taxAmount": 33.33, "totalAmount": 200, "trackingCategoryRefs": [ { "id": "DEPARTMENT-2", "name": "Services" }, { "id": "LOCATION-8", "name": "United Kingdom" } ] } ], "paymentAllocations": [ { "payment": { "id": "4973", "note": "dt header description", "accountRef": { "id": "289", "name": "Checking 5 - Bank Of England" }, "currency": "GBP", "paidOnDate": "2022-03-15T00:00:00", "totalAmount": 350 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2022-03-15T00:00:00", "totalAmount": 350 } } ], "subTotal": 291.67, "taxAmount": 58.33, "totalAmount": 350, "modifiedDate": "2022-10-28T11:10:26Z", "sourceModifiedDate": "2022-03-15T12:45:58Z" }, { "id": "5314", "reference": "Test Int Income", "note": "Test Description", "issueDate": "2022-03-24T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Interest earned", "accountRef": { "id": "5", "name": "Other Income" }, "unitAmount": 300, "quantity": 1, "subTotal": 300, "totalAmount": 300, "trackingCategoryRefs": [ { "id": "DEPARTMENT-1", "name": "Sales" }, { "id": "LOCATION-8", "name": "United Kingdom" } ] } ], "paymentAllocations": [ { "payment": { "id": "5314", "note": "Test Description", "reference": "Test Int Income", "accountRef": { "id": "289", "name": "Checking 5 - Bank Of England" }, "currency": "GBP", "paidOnDate": "2022-03-24T00:00:00", "totalAmount": 300 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2022-03-24T00:00:00", "totalAmount": 300 } } ], "subTotal": 300, "taxAmount": 0, "totalAmount": 300, "modifiedDate": "2022-10-28T11:10:26Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 43, "_links": { "current": { "href": "/companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes?page=1&pageSize=2" }, "self": { "href": "/companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes" }, "next": { "href": "/companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "3a1be853-5964-4afe-ad6a-fb89cbaf6606", "reference": "Sub 098801", "contactRef": { "id": "bc446de5-971e-48b5-8efd-1745149844ef", "dataType": "customers" }, "issueDate": "2023-02-14T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Long-term subscriber discount - refund on sub", "accountRef": { "id": "a40f43e2-c7b0-4187-919a-04ccdc14a630", "name": "Subscriptions" }, "taxRateRef": { "id": "EXEMPTINPUT", "name": "Exempt Expenses", "effectiveTaxRate": 0 }, "unitAmount": 35, "quantity": 1, "subTotal": 35, "taxAmount": 0, "totalAmount": 35, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "3a1be853-5964-4afe-ad6a-fb89cbaf6606", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-02-14T00:00:00", "totalAmount": 35 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2023-02-14T00:00:00", "totalAmount": 35 } } ], "subTotal": 35, "taxAmount": 0, "totalAmount": 35, "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2011-04-11T00:45:38", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directIncomes?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directIncomes" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) for a given company's connection.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-direct-incomes" } }, "/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/directIncomeId" } ], "get": { "tags": [ "Direct incomes" ], "summary": "Get direct income", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectIncome" }, "examples": { "Clear Books": { "value": { "id": "38e8c917-0afc-4583-8ffe-1b53ad601197", "reference": "3cb8ced3-3ecb-4974-ada5-8290b0ec3355", "note": "Direct Income with 1 line items, totaling 188.33", "contactRef": { "id": "51f03576-f6b0-40d5-9fba-81a490411c03", "dataType": "customers" }, "issueDate": "2022-04-19T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Underground - Drain Yard Gully", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "unitAmount": 171.21, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 171.21, "taxAmount": 17.12, "totalAmount": 188.33, "itemRef": { "id": "00491160-6ee5-4d76-9f34-998f00687481", "name": "Aluminium Silt Bucket" }, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "38e8c917-0afc-4583-8ffe-1b53ad601197", "note": "Payment for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197", "reference": "Direct Income 38e8c917-0afc-4583-8ffe-1b53ad601197", "accountRef": { "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3", "name": "Undeposited Funds" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-04-19T00:00:00", "totalAmount": 188.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-04-19T00:00:00", "totalAmount": -188.33 } } ], "subTotal": 171.21, "taxAmount": 17.12, "totalAmount": 188.33, "modifiedDate": "2023-04-26T12:38:18Z", "sourceModifiedDate": "2022-05-13T01:06:00", "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "8be30162-feec-ec11-82f9-000d3a8746a9", "reference": "B1234", "note": "4006", "issueDate": "2022-06-18T00:00:00", "currency": "USD", "currencyRate": 0.648364486, "lineItems": [ { "description": "Interest Income", "accountRef": { "id": "221217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Interest Income" }, "taxRateRef": { "id": "63bc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for DOMESTIC / STANDARD", "effectiveTaxRate": 10 }, "unitAmount": 7.13, "quantity": 1, "subTotal": 7.13, "taxAmount": 1.43, "totalAmount": 8.56, "trackingCategoryRefs": [ { "id": "adbc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "ADM-Administration" } ] } ], "paymentAllocations": [ { "payment": { "id": "8be30162-feec-ec11-82f9-000d3a8746a9", "accountRef": { "id": "8277672c-b8e6-ec11-82f8-0022481a77f0", "name": "B020-BoA" }, "currency": "USD", "currencyRate": 0.6483644859813084, "paidOnDate": "2022-06-18T00:00:00", "totalAmount": 8.56 }, "allocation": { "currency": "USD", "currencyRate": 0.6483644859813084, "allocatedOnDate": "2022-06-18T00:00:00", "totalAmount": 8.56 } } ], "subTotal": 7.13, "taxAmount": 1.43, "totalAmount": 8.56, "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2022-06-15T22:56:26Z", "metadata": { "isDeleted": false } } }, "FreeAgent": { "value": { "id": "344673327", "note": "Test Transaction 2", "issueDate": "2017-11-01T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Test Transaction 2", "accountRef": { "id": "001", "name": "Sales" }, "unitAmount": 10.5, "quantity": 1, "subTotal": 10.5, "taxAmount": 0, "totalAmount": 10.5, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "344673327", "note": "Test Transaction 2", "accountRef": { "id": "750-1", "name": "Bank Account: Business Current Account" }, "currency": "GBP", "paidOnDate": "2017-11-01T00:00:00", "totalAmount": 10.5 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2017-11-01T00:00:00", "totalAmount": 10.5 } } ], "subTotal": 10.5, "taxAmount": 0, "totalAmount": 10.5, "modifiedDate": "2023-04-25T14:20:36Z", "sourceModifiedDate": "2022-10-06T10:38:24Z", "metadata": { "isDeleted": false } } }, "QuickBooks Desktop": { "value": { "id": "9B87-1181931723", "reference": "9C08-1181931827", "contactRef": { "id": "280000-933272658", "dataType": "customers" }, "issueDate": "2023-01-15T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "80000-933270541", "name": "Undeposited Funds" }, "unitAmount": 1228.18, "quantity": 1, "subTotal": 1228.18, "taxAmount": 0, "totalAmount": 1228.18, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "9B87-1181931723", "accountRef": { "id": "20000-933270541", "name": "Checking" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-01-15T00:00:00", "totalAmount": 1228.18 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2023-01-15T00:00:00", "totalAmount": 1228.18 } } ], "subTotal": 1228.18, "taxAmount": 0, "totalAmount": 1228.18, "modifiedDate": "2023-04-26T09:14:12Z", "sourceModifiedDate": "2023-12-16T05:06:23", "metadata": { "isDeleted": false } } }, "QuickBooks Online Sandbox": { "value": { "id": "5-1", "contactRef": { "id": "52", "dataType": "suppliers" }, "issueDate": "2015-11-24T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "contribution to start business", "accountRef": { "id": "61", "name": "Owner's Equity - Contributions" }, "taxRateRef": { "id": "2_Invoices", "name": "Exempt Invoices", "effectiveTaxRate": 0 }, "unitAmount": 10000, "quantity": 1, "discountAmount": 0, "subTotal": 10000, "taxAmount": 0, "totalAmount": 10000, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "5-1", "accountRef": { "id": "81", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2015-11-24T00:00:00", "totalAmount": 10000 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2015-11-24T00:00:00", "totalAmount": -10000 } } ], "subTotal": 10000, "taxAmount": 0, "totalAmount": 10000, "modifiedDate": "2023-04-26T09:36:04Z", "sourceModifiedDate": "2016-09-12T15:26:26Z", "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "1", "note": "Opening Balance from Bank", "issueDate": "2018-09-21T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "53", "name": "Retained profit balance forward account" }, "unitAmount": 170.23, "quantity": 1, "discountAmount": 0, "subTotal": 170.23, "taxAmount": 0, "totalAmount": 170.23, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "1", "accountRef": { "id": "61", "name": "Dave PP Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-09-21T00:00:00", "totalAmount": 170.23 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2018-09-21T00:00:00", "totalAmount": -170.23 } } ], "subTotal": 170.23, "taxAmount": 0, "totalAmount": 170.23, "modifiedDate": "2023-01-18T11:02:50Z", "sourceModifiedDate": "2018-12-17T14:56:20Z" } }, "Sage Intacct": { "value": { "id": "4973", "reference": "dt test contact", "note": "dt header description", "issueDate": "2022-03-15T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Dt test line1", "accountRef": { "id": "151", "name": "Cash" }, "taxRateRef": { "id": "99", "name": "UK Sale Goods Standard Rate", "effectiveTaxRate": 20 }, "unitAmount": 125, "quantity": 1, "subTotal": 125, "taxAmount": 25, "totalAmount": 150, "trackingCategoryRefs": [ { "id": "DEPARTMENT-1", "name": "Sales" }, { "id": "LOCATION-8", "name": "United Kingdom" } ] }, { "description": "dt test line 2", "accountRef": { "id": "152", "name": "Cash Equivalents" }, "taxRateRef": { "id": "99", "name": "UK Sale Goods Standard Rate", "effectiveTaxRate": 20 }, "unitAmount": 166.67, "quantity": 1, "subTotal": 166.67, "taxAmount": 33.33, "totalAmount": 200, "trackingCategoryRefs": [ { "id": "DEPARTMENT-2", "name": "Services" }, { "id": "LOCATION-8", "name": "United Kingdom" } ] } ], "paymentAllocations": [ { "payment": { "id": "4973", "note": "dt header description", "accountRef": { "id": "289", "name": "Checking 5 - Bank Of England" }, "currency": "GBP", "paidOnDate": "2022-03-15T00:00:00", "totalAmount": 350 }, "allocation": { "currency": "GBP", "allocatedOnDate": "2022-03-15T00:00:00", "totalAmount": 350 } } ], "subTotal": 291.67, "taxAmount": 58.33, "totalAmount": 350, "modifiedDate": "2022-10-28T11:10:26Z", "sourceModifiedDate": "2022-03-15T12:45:58Z" } }, "Xero": { "value": { "id": "3a1be853-5964-4afe-ad6a-fb89cbaf6606", "reference": "Sub 098801", "contactRef": { "id": "bc446de5-971e-48b5-8efd-1745149844ef", "dataType": "customers" }, "issueDate": "2023-02-14T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Long-term subscriber discount - refund on sub", "accountRef": { "id": "a40f43e2-c7b0-4187-919a-04ccdc14a630", "name": "Subscriptions" }, "taxRateRef": { "id": "EXEMPTINPUT", "name": "Exempt Expenses", "effectiveTaxRate": 0 }, "unitAmount": 35, "quantity": 1, "subTotal": 35, "taxAmount": 0, "totalAmount": 35, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "id": "3a1be853-5964-4afe-ad6a-fb89cbaf6606", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-02-14T00:00:00", "totalAmount": 35 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2023-02-14T00:00:00", "totalAmount": 35 } } ], "subTotal": 35, "taxAmount": 0, "totalAmount": 35, "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2011-04-11T00:45:38", "metadata": { "isDeleted": false } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get direct income* endpoint returns a single direct income for a given directIncomeId.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a specific direct income.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-direct-income" } }, "/companies/{companyId}/connections/{connectionId}/options/directIncomes": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create direct income model", "tags": [ "Direct incomes" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Dynamics 365 Business Central": { "value": { "type": "Object", "displayName": "Direct Income", "description": "Direct Income", "properties": { "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": true, "validation": { "warnings": [ { "field": "Reference", "details": "Must not exceed 20 characters" } ], "information": [] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": true, "validation": { "warnings": [ { "field": "Currency", "details": "Must be the same as the PaymentAllocation.Payment.AccountRef.Id currency" } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false, "validation": { "warnings": [ { "field": "LineItems.SubTotal", "details": "Must be provided if LineItems.TotalAmount is not provided" } ], "information": [] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false, "validation": { "warnings": [ { "field": "LineItems.TotalAmount", "details": "Must be provided if LineItems.SubTotal is not provided" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true } }, "required": true } }, "required": true, "validation": { "warnings": [ { "field": "LineItems", "details": "Only one line is supported" } ], "information": [] } }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Must be a Bank Account ID" } ] } } }, "required": true } }, "required": true } }, "required": true, "validation": { "warnings": [ { "field": "PaymentAllocations", "details": "Only one line is supported" } ], "information": [] } } }, "required": true } }, "FreeAgent": { "value": { "type": "Object", "displayName": "Direct Income", "description": "Direct Income", "properties": { "id": { "type": "String", "displayName": "Unique Direct Transaction ID", "description": "The identifier for the direct transaction, unique to the company", "required": false, "validation": { "warnings": [ { "field": "Id", "details": "will be ignored on push. " } ], "information": [] } }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Reference", "details": "is not supported by FreeAgent and will not be mapped. " } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": true, "validation": { "warnings": [], "information": [ { "field": "Note", "details": "must be provided" } ] } }, "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": false, "validation": { "warnings": [ { "field": "ContactRef.Id", "details": "is not supported by FreeAgent and will be ignored on push. " } ], "information": [] } }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": false, "validation": { "warnings": [ { "field": "ContactRef.DataType", "details": "is not supported by FreeAgent and will be ignored on push. " } ], "information": [] } } }, "required": false }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "must be provided" } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false, "validation": { "warnings": [ { "field": "CurrencyRate", "details": "will be ignored on push. " } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "If a Note is provided, this field will be ignored on push. " } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": false, "validation": { "warnings": [ { "field": "LineItems.UnitAmount", "details": "will be ignored on push. " } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Quantity", "details": "will be ignored on push. " } ], "information": [] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "must be provided" } ] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": false, "validation": { "warnings": [ { "field": "AccountRef.Name", "details": "will be ignored on push. " } ], "information": [] } } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "will be ignored on push. " } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Name", "details": "will be ignored on push. " } ], "information": [] } }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.EffectiveTaxRate", "details": "will be ignored on push. " } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [ { "field": "LineItems", "details": "Exactly one line item must be specified" } ], "information": [] } }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the allocated payment", "required": false }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the allocated payment", "required": false }, "reference": { "type": "String", "displayName": "Reference", "description": "Reference associated with the allocated payment", "required": false }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "must be provided" } ] } }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": false, "validation": { "warnings": [ { "field": "AccountRef.Name", "details": "will be ignored on push. " } ], "information": [] } } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the base company", "required": false }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": false } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the transaction", "required": false }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": false } }, "required": false } }, "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the direct transaction excluding any taxes", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the direct transaction", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the direct transaction, inclusive of tax", "required": false }, "modifiedDate": { "type": "DateTime", "displayName": "Modified Date", "description": "The date the record was last updated in the system cache", "required": false, "validation": { "warnings": [ { "field": "ModifiedDate", "details": "will be ignored on push. " } ], "information": [] } }, "sourceModifiedDate": { "type": "DateTime", "displayName": "Source Modified Date", "description": "The date the record was last changed in the originating system", "required": false, "validation": { "warnings": [ { "field": "SourceModifiedDate", "details": "will be ignored on push. " } ], "information": [] } } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "Direct Income", "description": "Direct Income", "properties": { "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": false }, "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": true }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Should have the same sign across all line items" } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true } }, "required": false } }, "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account of type 'Bank'" } ], "information": [] } } }, "required": true } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "PaymentAllocations", "details": "Must contain a single allocation" } ] } } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Direct Income", "description": "Direct Income", "properties": { "id": { "type": "String", "displayName": "Unique Direct Transaction ID", "description": "The identifier for the direct transaction, unique to the company", "required": true }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Reference", "details": "Represents the check number" } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Max length of 100 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "Must be a three letter ISO code" }, { "field": "Currency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "Currency", "details": "If not set, will default to the default currency" } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1." }, { "field": "CurrencyRate", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true }, "sourceModifiedDate": { "type": "DateTime", "displayName": "Source Modified Date", "description": "The date the record was last changed in the originating system", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the direct transaction, inclusive of tax", "required": true }, "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "required": false }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "required": true } }, "required": true, "validation": { "warnings": [ { "field": "LineItems", "details": "Must contain a single line item" } ], "information": [] } }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the allocated payment", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "required": true, "validation": { "warnings": [], "information": [ { "field": "Payment.AccountRef", "details": "The account in which to make the deposit" } ] } }, "reference": { "type": "String", "displayName": "Reference", "description": "Reference associated with the allocated payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Payment.Reference", "details": "Use to reference the check number of this deposit." } ] } } }, "required": true } }, "required": true, "validation": { "warnings": [ { "field": "PaymentAllocations", "details": "Must contain a single payment allocation" } ], "information": [] } } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Direct Income", "description": "Direct Income", "properties": { "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "Customers", "type": "String", "displayName": "Customers", "required": false } ], "required": true } }, "required": false, "validation": { "warnings": [ { "field": "ContactRef", "details": "Must be a Customer reference" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Required if multi-currency is enabled for the company." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the direct transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "TaxAmount", "details": "Tax will not be overridden if TaxAmount is 0." } ] } }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Reference", "details": "Must be less than 22 characters." } ], "information": [] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "required": true }, "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Required for refunds" }, { "field": "AccountRef.Id", "details": "Must be Bank or Asset account" } ] } } }, "required": false } }, "required": true } }, "required": true, "validation": { "warnings": [ { "field": "PaymentAllocations", "details": "Must have exactly one payment allocation." } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.TrackingCategoryRefs", "details": "All DEPARTMENT tracking categories must be the same" } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Must be less than 4000 characters." } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.SubTotal", "details": "Must equal the Quantity multiplied by the UnitAmount." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "For UK companies, cannot have a mix of NON and valid tax rate IDs." } ], "information": [ { "field": "TaxRateRef.Id", "details": "For UK companies, if a value of NON is provided on all lines the directIncomes will be set to have No VAT." }, { "field": "TaxRateRef.Id", "details": "If an organisation has Automated Sales Tax enabled for US locales, then 'TAX' (Automated Sales Tax), 'NON' (no tax) or a custom tax rate can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used." } ] } } }, "required": true } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Automated Sales Tax is disabled for this company." } ] } } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "Direct Income", "description": "Direct Income", "properties": { "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": true, "validation": { "warnings": [], "information": [ { "field": "Reference", "details": "Must be used to provide payee's name and contain no more than 80 characters." } ] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Payment.AccountRef", "details": "Must be used to provide bank account id." } ] } } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "PaymentAllocations", "details": "Must contain a single payment allocation." } ] } }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false, "validation": { "warnings": [], "information": [ { "field": "TaxRateRef.Id", "details": "Must be an existing tax rate in Sage Intacct." } ] } } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxRateRef", "details": "It is only required for VAT enabled transactions." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.AccountRef", "details": "Must be used to provide an account id not linked to a bank account." } ] } }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.Description", "details": "Must not contain more than 1000 characters." } ] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": false }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": false } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must contain at least one line item." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "When supplying a currency ensure that it exists in your Sage Intacct entity otherwise the request will fail." } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Direct Income", "description": "Direct Income", "properties": { "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "The note attached to the direct transaction", "required": true }, "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": true }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": true }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": true } }, "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given currency, of any discounts applied", "required": true }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the item referenced by the identifier", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": true } }, "required": true } }, "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the allocated payment", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the allocated payment", "required": true }, "reference": { "type": "String", "displayName": "Reference", "description": "Reference associated with the allocated payment", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the base company", "required": true }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": true } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the transaction", "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": true } }, "required": true } }, "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the direct transaction excluding any taxes", "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the direct transaction", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the direct transaction, inclusive of tax", "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Direct Income", "description": "Direct Income", "properties": { "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The date the direct transaction was issued", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must be provided." } ] } }, "reference": { "type": "String", "displayName": "Reference", "description": "User friendly reference for the direct transaction", "required": false, "validation": { "warnings": [], "information": [ { "field": "Reference", "details": "Must not exceed 255 characters." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the direct transaction", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the direct transaction and the base currency of the company", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the direct transaction", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the direct transaction, inclusive of tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "TotalAmount", "details": "Must be provided." } ] } }, "contactRef": { "type": "Object", "displayName": "Contact Ref", "description": "The contact associated with the direct transaction, if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "ContactRef.Id", "details": "Must be a valid GUID." }, { "field": "ContactRef.Id", "details": "Must match the ID of an existing contact." } ], "information": [ { "field": "ContactRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "ContactRef", "details": "Must be provided." } ] } }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the direct transaction", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a bank account." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing bank account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Payment.AccountRef", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "PaymentAllocations.Payment", "details": "Must be provided." } ] } }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": true, "validation": { "warnings": [ { "field": "Allocation.TotalAmount", "details": "Must be equal to the sum of line items." } ], "information": [ { "field": "Allocation.TotalAmount", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "PaymentAllocations.Allocation", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "PaymentAllocations", "details": "Must be provided." } ] } }, "lineItems": { "type": "Array", "displayName": "Direct Transaction Lines", "description": "A collection of lines that detail items related to the direct transaction", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Description", "details": "Must not be longer than 4000 characters long." } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false, "validation": { "warnings": [ { "field": "LineItems.TotalAmount", "details": "When negative, the push item will be converted to a DirectCost and will be pushed accordingly." } ], "information": [ { "field": "LineItems.TotalAmount", "details": "When one line is negative, all lines must be negative." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a valid GUID." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.AccountRef", "details": "Must be provided." } ] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [], "information": [ { "field": "TrackingCategoryRefs.Id", "details": "Must be provided." } ] } } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TrackingCategoryRefs", "details": "Tracking categories must not have the same parent tracking category." }, { "field": "LineItems.TrackingCategoryRefs", "details": "Maximum of 2 Tracking Categories." } ] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax rate." } ], "information": [] } } }, "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must be a valid GUID." }, { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [ { "details": "When negative, the push item will be converted to a DirectCost and will be pushed accordingly." } ], "information": [] } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-directIncomes-model", "description": "The *Get create direct income model* endpoint returns the expected data for the request payload when creating a [direct income](https://docs.codat.io/accounting-api#/schemas/DirectIncome) for a given company and integration.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support creating a direct income.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/directIncomes": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Direct incomes" ], "summary": "Create direct income", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectIncome" }, "examples": { "QuickBooks Desktop": { "value": { "reference": null, "note": "test note", "contactRef": { "id": "80000002-1674552702", "dataType": "customers" }, "issueDate": "2023-02-01T16:27:40.023Z", "currency": "USD", "lineItems": [ { "description": "line description 1", "unitAmount": 9100, "quantity": 68, "discountAmount": 0, "discountPercentage": 0, "subTotal": 5320, "taxAmount": 37, "totalAmount": 12, "accountRef": { "id": "80000007-1671793811" }, "trackingCategoryRefs": [ { "id": "80000002-1674553271", "name": "string" } ] } ], "paymentAllocations": [ { "payment": { "id": "3594002235", "note": "payment allocations note", "reference": "230202 1217", "accountRef": { "id": "80000028-1671794219" }, "currency": "USD", "currencyRate": 1, "paidOnDate": "2023-02-01T16:27:40.023Z", "totalAmount": 560 }, "allocation": { "currency": "USD", "currencyRate": 1, "allocatedOnDate": "2023-02-01T16:27:40.023Z", "totalAmount": 560 } } ], "subTotal": 0, "taxAmount": 9999, "totalAmount": 9999, "metadata": { "isDeleted": true } } }, "Sage Intacct": { "value": { "reference": "test ref", "note": "Test 1", "issueDate": "2023-03-31T00:00:00", "currency": "USD", "currencyRate": 0.5, "lineItems": [ { "accountRef": { "id": "195" }, "taxRateRef": { "id": "99" }, "trackingCategoryRefs": [ { "id": "DEPARTMENT-2", "name": "Services" }, { "id": "LOCATION-8", "name": "United Kingdom" } ], "unitAmount": 9.99, "quantity": 1 } ], "paymentAllocations": [ { "payment": { "id": "4355", "note": "test note", "reference": "test reference", "accountRef": { "id": "289" }, "currency": "USD", "paidOnDate": "2023-03-31T00:00:00", "totalAmount": 11.99 }, "allocation": { "currency": "USD", "allocatedOnDate": "2023-03-31T00:00:00", "totalAmount": 11.99 } } ], "subTotal": 9.99, "taxAmount": 2, "totalAmount": 11.99 } }, "Xero": { "value": { "reference": "Scenario One neg DI", "contactRef": { "id": "699f0091-b127-4796-9f15-41a2f42abeb2", "dataType": "suppliers" }, "issueDate": "2023-02-25", "currency": "GBP", "lineItems": [ { "description": "negative direct income", "unitAmount": 35, "quantity": -1, "subTotal": -35, "taxAmount": -7, "totalAmount": -42, "accountRef": { "id": "c563b607-fb0e-4d06-9ddb-76fdeef20ae3" }, "taxRateRef": { "id": "OUTPUT2" } } ], "paymentAllocations": [ { "payment": { "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4" }, "currency": "GBP" }, "allocation": { "totalAmount": -42 } } ], "taxAmount": -7, "totalAmount": -42, "subTotal": -35 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDirectIncomeResponse" }, "examples": { "Xero": { "value": { "changes": [ { "type": "Unknown", "recordRef": { "dataType": "directIncomes" } } ], "data": { "reference": "Scenario One neg DI", "contactRef": { "id": "699f0091-b127-4796-9f15-41a2f42abeb2", "dataType": "suppliers" }, "issueDate": "2023-02-25T00:00:00", "currency": "GBP", "lineItems": [ { "description": "negative direct income", "accountRef": { "id": "c563b607-fb0e-4d06-9ddb-76fdeef20ae3" }, "taxRateRef": { "id": "OUTPUT2" }, "unitAmount": 35, "quantity": -1, "subTotal": -35, "taxAmount": -7, "totalAmount": -42, "trackingCategoryRefs": [] } ], "paymentAllocations": [ { "payment": { "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4" }, "currency": "GBP", "paidOnDate": "0001-01-01T00:00:00", "totalAmount": 0 }, "allocation": { "totalAmount": -42 } } ], "subTotal": 0, "taxAmount": -7, "totalAmount": -42 }, "dataType": "directIncomes", "companyId": "b5efee61-3fab-4a5d-9247-de03d6eda6db", "pushOperationKey": "c3be9bb9-a771-4e5b-8b50-9e52748a730a", "dataConnectionKey": "1e355304-4476-422e-95cb-fa2a6d47fab4", "requestedOnUtc": "2023-02-27T15:58:48.9160948Z", "status": "Pending", "validation": { "errors": [], "warnings": [] }, "statusCode": 202 } }, "Sage Intacct": { "value": { "changes": [ { "type": "Created", "recordRef": { "dataType": "directIncomes" } } ], "data": { "reference": "test ref", "note": "Test 1", "issueDate": "2023-03-31T00:00:00", "currency": "USD", "currencyRate": 0.5, "lineItems": [ { "accountRef": { "id": "195" }, "taxRateRef": { "id": "99" }, "unitAmount": 9.99, "quantity": 1, "trackingCategoryRefs": [ { "id": "DEPARTMENT-2", "name": "Services" }, { "id": "LOCATION-8", "name": "United Kingdom" } ] } ], "paymentAllocations": [ { "payment": { "id": "4355", "note": "test note", "reference": "test reference", "accountRef": { "id": "289" }, "currency": "USD", "paidOnDate": "2023-03-31T00:00:00", "totalAmount": 11.99 }, "allocation": { "currency": "USD", "allocatedOnDate": "2023-03-31T00:00:00", "totalAmount": 11.99 } } ], "subTotal": 9.99, "taxAmount": 2, "totalAmount": 11.99 }, "dataType": "directIncomes", "companyId": "d7f743a9-1804-4116-8c8a-e606f7e2f66c", "pushOperationKey": "cc99d39b-5d87-4160-b582-42c69353d05b", "dataConnectionKey": "fa139396-523a-4a58-bf2b-8da82c8a673f", "requestedOnUtc": "2023-03-31T14:24:46.2780738Z", "status": "Pending", "validation": { "errors": [], "warnings": [ { "itemId": "PaymentAllocations[0].Allocation.Currency", "message": "PaymentAllocations[0].Allocation.Currency is not supported, and will be ignored.", "validatorName": "Allocation" }, { "itemId": "PaymentAllocations[0].Allocation.TotalAmount", "message": "PaymentAllocations[0].Allocation.TotalAmount is not supported, and will be ignored.", "validatorName": "Allocation" }, { "itemId": "PaymentAllocations[0].Allocation.AllocatedOnDate", "message": "PaymentAllocations[0].Allocation.AllocatedOnDate is not supported, and will be ignored.", "validatorName": "Allocation" }, { "itemId": "PaymentAllocations[0].PaymentAllocationPayment.Id", "message": "PaymentAllocations[0].PaymentAllocationPayment.Id is not supported, and will be ignored.", "validatorName": "PaymentAllocationPayment" }, { "itemId": "PaymentAllocations[0].PaymentAllocationPayment.Note", "message": "PaymentAllocations[0].PaymentAllocationPayment.Note is not supported, and will be ignored.", "validatorName": "PaymentAllocationPayment" }, { "itemId": "PaymentAllocations[0].PaymentAllocationPayment.Reference", "message": "PaymentAllocations[0].PaymentAllocationPayment.Reference is not supported, and will be ignored.", "validatorName": "PaymentAllocationPayment" }, { "itemId": "PaymentAllocations[0].PaymentAllocationPayment.Currency", "message": "PaymentAllocations[0].PaymentAllocationPayment.Currency is not supported, and will be ignored.", "validatorName": "PaymentAllocationPayment" }, { "itemId": "PaymentAllocations[0].PaymentAllocationPayment.TotalAmount", "message": "PaymentAllocations[0].PaymentAllocationPayment.TotalAmount is not supported, and will be ignored.", "validatorName": "PaymentAllocationPayment" }, { "itemId": "PaymentAllocations[0].PaymentAllocationPayment.PaidOnDate", "message": "PaymentAllocations[0].PaymentAllocationPayment.PaidOnDate is not supported, and will be ignored.", "validatorName": "PaymentAllocationPayment" }, { "itemId": "SubTotal", "message": "SubTotal is not supported, and will be ignored.", "validatorName": "DirectIncome" }, { "itemId": "TotalAmount", "message": "TotalAmount is not supported, and will be ignored.", "validatorName": "DirectIncome" }, { "itemId": "TaxAmount", "message": "TaxAmount is not supported, and will be ignored.", "validatorName": "DirectIncome" } ] }, "statusCode": 202 } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create direct income* endpoint creates a new [direct income](https://docs.codat.io/accounting-api#/schemas/DirectIncome) for a given company's connection.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale. For example, cash sales of items to a customer, referral commissions, and service fee refunds are considered direct incomes.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create direct income model](https://docs.codat.io/accounting-api#/operations/get-create-directIncomes-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support creating an account.\n", "operationId": "create-direct-income" } }, "/companies/{companyId}/connections/{connectionId}/push/directIncomes/{directIncomeId}/attachment": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/directIncomeId" } ], "post": { "tags": [ "Direct incomes" ], "summary": "Create direct income attachment", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AttachmentUpload" } } } }, "responses": { "200": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Upload direct income attachment* endpoint uploads an attachment and assigns it against a specific `directIncomeId`.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\n**Integration-specific behaviour**\n\nFor more details on supported file types by integration see [Attachments](https://docs.codat.io/accounting-api#/schemas/Attachment).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support uploading a direct income attachment.\n", "operationId": "upload-direct-income-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/directIncomeId" }, { "$ref": "#/components/parameters/attachmentId" } ], "get": { "tags": [ "Direct incomes" ], "summary": "Get direct income attachment", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support getting a direct income attachment.\n", "operationId": "get-direct-income-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}/download": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/directIncomeId" }, { "$ref": "#/components/parameters/attachmentId" } ], "get": { "tags": [ "Direct incomes" ], "summary": "Download direct income attachment", "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "title": "Data", "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support downloading a direct income attachment.\n", "operationId": "download-direct-income-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/directIncomeId" } ], "get": { "tags": [ "Direct incomes" ], "summary": "List direct income attachments", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentsDataset" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`.\n\n[Direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome) are sales of items directly to a customer where payment is received at the point of the sale.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directIncomes) for integrations that support listing direct income attachments.\n", "operationId": "list-direct-income-attachments" } }, "/companies/{companyId}/data/financials/balanceSheet": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Reports" ], "summary": "Get balance sheet", "description": "Gets the latest balance sheet for a company.", "operationId": "get-balance-sheet", "x-speakeasy-name-override": "get-balance-sheet", "parameters": [ { "$ref": "#/components/parameters/periodLength" }, { "$ref": "#/components/parameters/periodsToCompare" }, { "$ref": "#/components/parameters/startMonth" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceSheet" }, "examples": { "Clear Books": { "value": { "currency": "GBP", "reports": [ { "date": "2023-03-31T00:00:00", "assets": { "accountId": "", "name": "Assets", "value": 4643976.27, "items": [ { "accountId": "", "name": "Fixed Assets", "value": 3930291.27, "items": [ { "accountId": "724ca578-8b5d-4bdb-ad45-e3820eee9de9", "name": "Office Equipment", "value": 2354838.89, "items": [] }, { "accountId": "be3eb911-034b-42de-95db-0d58ac978b7f", "name": "Computer Equipment", "value": 1575452.38, "items": [] } ] }, { "accountId": "", "name": "Current Assets", "value": 713685, "items": [ { "accountId": "1b6266d1-1e44-46c5-8eb5-a8f98e03124e", "name": "Accounts Receivable", "value": 66538.63, "items": [] }, { "accountId": "22de1660-d745-4809-a363-16b134607e66", "name": "Prepayments", "value": 27250.93, "items": [] }, { "accountId": "e5d7612c-1671-47b4-b733-5db48363fcd0", "name": "Inventory", "value": 113157.44, "items": [] }, { "accountId": "", "name": "Bank", "value": 506738, "items": [ { "accountId": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account", "value": 506738, "items": [] } ] } ] } ] }, "liabilities": { "accountId": "", "name": "Liabilities", "value": 1183797.31, "items": [ { "accountId": "", "name": "Current Liabilities", "value": 544797.71, "items": [ { "accountId": "3a872b81-d1af-4d31-9bfa-a37280b8f68c", "name": "VAT", "value": 27683.3, "items": [] }, { "accountId": "d19852a2-e292-4eb9-a909-9dadb95c0e76", "name": "Rounding", "value": 0, "items": [] }, { "accountId": "9be6382f-6b33-402d-b448-0db1dbf67a98", "name": "Historical Adjustment", "value": 8985.44, "items": [] }, { "accountId": "53bf27a7-7497-4c61-9887-dfaad5c6d80a", "name": "Accounts Payable", "value": 36981.83, "items": [] }, { "accountId": "8852a857-aa9d-4706-839f-638e9d6b5a66", "name": "Unpaid Expense Claims", "value": 0, "items": [] }, { "accountId": "3b58f7ff-fa16-453a-9931-f020816d76e7", "name": "Interest Payables", "value": 1193.59, "items": [] }, { "accountId": "8636effc-50fb-45ba-8b2b-18336fa29b6b", "name": "John Smith", "value": 1147.11, "items": [] }, { "accountId": "e2530acd-91c8-48f8-a35f-935dbd7432e2", "name": "Accruals", "value": 439935.82, "items": [] }, { "accountId": "62060aae-e5a6-4db5-a3bb-6abec6d47959", "name": "Credit Card Control Account", "value": 28870.62, "items": [] } ] }, { "accountId": "", "name": "Long Term Liability", "value": 638999.6, "items": [ { "accountId": "55008233-40e7-41ac-84af-2255fa028c2e", "name": "Loan", "value": 638999.6, "items": [] } ] } ] }, "netAssets": 3460178.96, "equity": { "accountId": "", "name": "Equity", "value": 3460178.96, "items": [ { "accountId": "39225d6f-3722-4508-ac3f-a2f6ec96ad31", "name": "Retained Earnings", "value": 3405201.39, "items": [] }, { "accountId": "78828dd9-6008-4662-b43c-e9d87907fd2b", "name": "Current Year Earnings", "value": 54977.57, "items": [] } ] } }, { "date": "2023-02-28T00:00:00", "assets": { "accountId": "", "name": "Assets", "value": 4599890.71, "items": [ { "accountId": "", "name": "Fixed Assets", "value": 3882793.51, "items": [ { "accountId": "724ca578-8b5d-4bdb-ad45-e3820eee9de9", "name": "Office Equipment", "value": 2036803.36, "items": [] }, { "accountId": "be3eb911-034b-42de-95db-0d58ac978b7f", "name": "Computer Equipment", "value": 1845990.15, "items": [] } ] }, { "accountId": "", "name": "Current Assets", "value": 717097.2, "items": [ { "accountId": "1b6266d1-1e44-46c5-8eb5-a8f98e03124e", "name": "Accounts Receivable", "value": 136245.44, "items": [] }, { "accountId": "22de1660-d745-4809-a363-16b134607e66", "name": "Prepayments", "value": 18719.25, "items": [] }, { "accountId": "e5d7612c-1671-47b4-b733-5db48363fcd0", "name": "Inventory", "value": 146898.62, "items": [] }, { "accountId": "", "name": "Bank", "value": 415233.89, "items": [ { "accountId": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account", "value": 415233.89, "items": [] } ] } ] } ] }, "liabilities": { "accountId": "", "name": "Liabilities", "value": 1150262.51, "items": [ { "accountId": "", "name": "Current Liabilities", "value": 508579.57, "items": [ { "accountId": "3a872b81-d1af-4d31-9bfa-a37280b8f68c", "name": "VAT", "value": 22517.83, "items": [] }, { "accountId": "d19852a2-e292-4eb9-a909-9dadb95c0e76", "name": "Rounding", "value": 0, "items": [] }, { "accountId": "9be6382f-6b33-402d-b448-0db1dbf67a98", "name": "Historical Adjustment", "value": 5994.86, "items": [] }, { "accountId": "53bf27a7-7497-4c61-9887-dfaad5c6d80a", "name": "Accounts Payable", "value": 49993.06, "items": [] }, { "accountId": "8852a857-aa9d-4706-839f-638e9d6b5a66", "name": "Unpaid Expense Claims", "value": 0, "items": [] }, { "accountId": "3b58f7ff-fa16-453a-9931-f020816d76e7", "name": "Interest Payables", "value": 1424.88, "items": [] }, { "accountId": "8636effc-50fb-45ba-8b2b-18336fa29b6b", "name": "John Smith", "value": 1863.01, "items": [] }, { "accountId": "e2530acd-91c8-48f8-a35f-935dbd7432e2", "name": "Accruals", "value": 399839.88, "items": [] }, { "accountId": "62060aae-e5a6-4db5-a3bb-6abec6d47959", "name": "Credit Card Control Account", "value": 26946.05, "items": [] } ] }, { "accountId": "", "name": "Long Term Liability", "value": 641682.94, "items": [ { "accountId": "55008233-40e7-41ac-84af-2255fa028c2e", "name": "Loan", "value": 641682.94, "items": [] } ] } ] }, "netAssets": 3449628.2, "equity": { "accountId": "", "name": "Equity", "value": 3449628.19, "items": [ { "accountId": "39225d6f-3722-4508-ac3f-a2f6ec96ad31", "name": "Retained Earnings", "value": 3405201.39, "items": [] }, { "accountId": "78828dd9-6008-4662-b43c-e9d87907fd2b", "name": "Current Year Earnings", "value": 44426.8, "items": [] } ] } } ], "mostRecentAvailableMonth": "2023-03-31T00:00:00", "earliestAvailableMonth": "2018-04-01T00:00:00" } }, "Dynamics 365 Business Central": { "value": { "currency": "GBP", "reports": [ { "date": "2023-03-27T00:00:00", "assets": { "name": "Assets", "value": 260454.26, "items": [ { "name": "", "value": 27.34, "items": [ { "accountId": "c0861a65-c69f-ec11-80f1-0022481b4546", "name": "10 - Account no cat Balance Sheet", "value": 27.34, "items": [] }, { "accountId": "9cc90e3e-843d-ed11-97e8-0022481b89f2", "name": "12345 - Income Statement and Asset", "value": 0, "items": [] } ] }, { "name": "Equipment", "value": 5504.37, "items": [ { "accountId": "5b9782f7-0fe7-ec11-82f9-0022481afc56", "name": "1350 - Iana test", "value": 16, "items": [] }, { "accountId": "6c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40800 - Equipment", "value": 5488.37, "items": [] } ] }, { "name": "Cash", "value": 36998.49, "items": [ { "accountId": "5e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40100 - Checking account", "value": -35824.11, "items": [] }, { "accountId": "601217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40200 - Savings account", "value": 2802.59, "items": [] }, { "accountId": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40300 - Petty Cash", "value": 70020.01, "items": [] }, { "accountId": "5c062318-3c59-ed11-8c36-002248c5e6c0", "name": "4544 - cash bal", "value": 0, "items": [] } ] }, { "name": "Accounts Receivable", "value": 189399.22, "items": [ { "accountId": "641217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40400 - Accounts Receivable", "value": 129008.09, "items": [] }, { "accountId": "9cb05c6f-9fbd-ed11-9a88-000d3a7ea13c", "name": "40450 - test3", "value": 0, "items": [] }, { "accountId": "7a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "46200 - Purchase VAT 20 % EU", "value": -11635.12, "items": [] }, { "accountId": "7c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "46210 - Purchase VAT 5 % EU", "value": 0, "items": [] }, { "accountId": "7e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "46300 - Purchase VAT 20 %", "value": 71992.44, "items": [] }, { "accountId": "801217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "46310 - Purchase VAT 5 %", "value": 9.35, "items": [] }, { "accountId": "821217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "46320 - Purchase Full VAT 5 %", "value": 10, "items": [] }, { "accountId": "841217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "46330 - Purchase Full VAT 20 %", "value": 14.46, "items": [] }, { "accountId": "1bd1222e-94bd-ed11-9a88-6045bd0f961f", "name": "9999 - BaleSales", "value": 0, "items": [] } ] }, { "name": "Prepaid Expenses", "value": -1040, "items": [ { "accountId": "661217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40500 - Prepaid Rent", "value": 0, "items": [] }, { "accountId": "681217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40600 - Prepaid Insurance", "value": -1040, "items": [] }, { "accountId": "781217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "41000 - Vendor Prepayments", "value": 0, "items": [] } ] }, { "name": "Inventory", "value": 26065.84, "items": [ { "accountId": "6a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40700 - Inventory", "value": 26065.84, "items": [] } ] }, { "name": "Accumulated Depreciation", "value": 3499, "items": [ { "accountId": "6e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40900 - Accumulated Depreciation", "value": 3499, "items": [] } ] }, { "name": "Assets", "value": 0, "items": [ { "accountId": "701217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40910 - WIP Job Sales", "value": 0, "items": [] }, { "accountId": "721217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40920 - Invoiced Job Sales", "value": 0, "items": [] }, { "accountId": "741217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40940 - Accrued Job Costs", "value": 0, "items": [] }, { "accountId": "761217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40950 - WIP Job Costs", "value": 0, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 99721.85, "items": [ { "name": "Current Liabilities", "value": 99735.85, "items": [ { "accountId": "8a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "50100 - Accounts Payable", "value": 42435.31, "items": [] }, { "accountId": "8c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "50200 - Purchase Discounts", "value": 210.22, "items": [] }, { "accountId": "8e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "50300 - Purchase Returns & Allowances", "value": 0, "items": [] }, { "accountId": "901217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "50400 - Deferred Revenue", "value": 0, "items": [] }, { "accountId": "921217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "50500 - Credit Cards", "value": 0, "items": [] }, { "accountId": "9e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "52000 - Customer Prepayments", "value": 0, "items": [] }, { "accountId": "a01217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "56100 - Sales VAT 20 %", "value": 57906.98, "items": [] }, { "accountId": "a21217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "56110 - Sales VAT 5 %", "value": -816.66, "items": [] }, { "accountId": "a41217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "56120 - Sales Full VAT 5 %", "value": 0, "items": [] }, { "accountId": "a61217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "56130 - Sales Full VAT 20 %", "value": 0, "items": [] }, { "accountId": "a81217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "56140 - VAT Payable", "value": 0, "items": [] } ] }, { "name": "Payroll Liabilities", "value": -14, "items": [ { "accountId": "941217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "50700 - Accrued Salaries & Wages", "value": 0, "items": [] }, { "accountId": "961217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "51400 - Employee Benefits Payable", "value": 0, "items": [] }, { "accountId": "981217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "51500 - Holiday Compensation Payable", "value": 7, "items": [] }, { "accountId": "9a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "51600 - Employees Payable", "value": -21, "items": [] } ] }, { "name": "Long Term Liabilities", "value": 0, "items": [ { "accountId": "9c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "51900 - Notes Payable", "value": 0, "items": [] } ] } ] }, "netAssets": 160732.41, "equity": { "name": "Equity", "value": 160732.41, "items": [ { "name": "Common Stock", "value": 19988.72, "items": [ { "accountId": "aa1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "60100 - Share Capital", "value": 19988.72, "items": [] } ] }, { "name": "Retained Earnings", "value": 69723.14, "items": [ { "accountId": "ac1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "60200 - Retained Earnings", "value": 69723.14, "items": [] } ] }, { "name": "Dividends", "value": 0, "items": [ { "accountId": "b01217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "60300 - Dividends", "value": 0, "items": [] } ] }, { "accountId": "NO-ID-EARNINGS-SO-FAR", "name": "Earnings so far", "value": 71020.55, "items": [] } ] } }, { "date": "2023-02-28T00:00:00", "assets": { "name": "Assets", "value": 262531.32, "items": [ { "name": "", "value": 27.34, "items": [ { "accountId": "c0861a65-c69f-ec11-80f1-0022481b4546", "name": "10 - Account no cat Balance Sheet", "value": 27.34, "items": [] }, { "accountId": "9cc90e3e-843d-ed11-97e8-0022481b89f2", "name": "12345 - Income Statement and Asset", "value": 0, "items": [] } ] }, { "name": "Equipment", "value": 5504.37, "items": [ { "accountId": "5b9782f7-0fe7-ec11-82f9-0022481afc56", "name": "1350 - Iana test", "value": 16, "items": [] }, { "accountId": "6c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40800 - Equipment", "value": 5488.37, "items": [] } ] }, { "name": "Cash", "value": 37693.84, "items": [ { "accountId": "5e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40100 - Checking account", "value": -35778.16, "items": [] }, { "accountId": "601217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40200 - Savings account", "value": 2802.59, "items": [] }, { "accountId": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40300 - Petty Cash", "value": 70669.41, "items": [] }, { "accountId": "5c062318-3c59-ed11-8c36-002248c5e6c0", "name": "4544 - cash bal", "value": 0, "items": [] } ] }, { "name": "Accounts Receivable", "value": 188021.29, "items": [ { "accountId": "641217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40400 - Accounts Receivable", "value": 127634.34, "items": [] }, { "accountId": "9cb05c6f-9fbd-ed11-9a88-000d3a7ea13c", "name": "40450 - test3", "value": 0, "items": [] }, { "accountId": "7a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "46200 - Purchase VAT 20 % EU", "value": -11635.12, "items": [] }, { "accountId": "7c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "46210 - Purchase VAT 5 % EU", "value": 0, "items": [] }, { "accountId": "7e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "46300 - Purchase VAT 20 %", "value": 71988.26, "items": [] }, { "accountId": "801217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "46310 - Purchase VAT 5 %", "value": 9.35, "items": [] }, { "accountId": "821217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "46320 - Purchase Full VAT 5 %", "value": 10, "items": [] }, { "accountId": "841217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "46330 - Purchase Full VAT 20 %", "value": 14.46, "items": [] }, { "accountId": "1bd1222e-94bd-ed11-9a88-6045bd0f961f", "name": "9999 - BaleSales", "value": 0, "items": [] } ] }, { "name": "Prepaid Expenses", "value": -1040, "items": [ { "accountId": "661217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40500 - Prepaid Rent", "value": 0, "items": [] }, { "accountId": "681217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40600 - Prepaid Insurance", "value": -1040, "items": [] }, { "accountId": "781217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "41000 - Vendor Prepayments", "value": 0, "items": [] } ] }, { "name": "Inventory", "value": 28825.48, "items": [ { "accountId": "6a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40700 - Inventory", "value": 28825.48, "items": [] } ] }, { "name": "Accumulated Depreciation", "value": 3499, "items": [ { "accountId": "6e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40900 - Accumulated Depreciation", "value": 3499, "items": [] } ] }, { "name": "Assets", "value": 0, "items": [ { "accountId": "701217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40910 - WIP Job Sales", "value": 0, "items": [] }, { "accountId": "721217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40920 - Invoiced Job Sales", "value": 0, "items": [] }, { "accountId": "741217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40940 - Accrued Job Costs", "value": 0, "items": [] }, { "accountId": "761217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "40950 - WIP Job Costs", "value": 0, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 99680, "items": [ { "name": "Current Liabilities", "value": 99694, "items": [ { "accountId": "8a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "50100 - Accounts Payable", "value": 42459.31, "items": [] }, { "accountId": "8c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "50200 - Purchase Discounts", "value": 210.22, "items": [] }, { "accountId": "8e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "50300 - Purchase Returns & Allowances", "value": 0, "items": [] }, { "accountId": "901217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "50400 - Deferred Revenue", "value": 0, "items": [] }, { "accountId": "921217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "50500 - Credit Cards", "value": 0, "items": [] }, { "accountId": "9e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "52000 - Customer Prepayments", "value": 0, "items": [] }, { "accountId": "a01217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "56100 - Sales VAT 20 %", "value": 57841.13, "items": [] }, { "accountId": "a21217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "56110 - Sales VAT 5 %", "value": -816.66, "items": [] }, { "accountId": "a41217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "56120 - Sales Full VAT 5 %", "value": 0, "items": [] }, { "accountId": "a61217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "56130 - Sales Full VAT 20 %", "value": 0, "items": [] }, { "accountId": "a81217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "56140 - VAT Payable", "value": 0, "items": [] } ] }, { "name": "Payroll Liabilities", "value": -14, "items": [ { "accountId": "941217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "50700 - Accrued Salaries & Wages", "value": 0, "items": [] }, { "accountId": "961217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "51400 - Employee Benefits Payable", "value": 0, "items": [] }, { "accountId": "981217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "51500 - Holiday Compensation Payable", "value": 7, "items": [] }, { "accountId": "9a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "51600 - Employees Payable", "value": -21, "items": [] } ] }, { "name": "Long Term Liabilities", "value": 0, "items": [ { "accountId": "9c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "51900 - Notes Payable", "value": 0, "items": [] } ] } ] }, "netAssets": 162851.32, "equity": { "name": "Equity", "value": 162851.32, "items": [ { "name": "Common Stock", "value": 19988.72, "items": [ { "accountId": "aa1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "60100 - Share Capital", "value": 19988.72, "items": [] } ] }, { "name": "Retained Earnings", "value": 69723.14, "items": [ { "accountId": "ac1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "60200 - Retained Earnings", "value": 69723.14, "items": [] } ] }, { "name": "Dividends", "value": 0, "items": [ { "accountId": "b01217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "60300 - Dividends", "value": 0, "items": [] } ] }, { "accountId": "NO-ID-EARNINGS-SO-FAR", "name": "Earnings so far", "value": 73139.46, "items": [] } ] } } ], "mostRecentAvailableMonth": "2023-03-31T00:00:00", "earliestAvailableMonth": "2022-09-01T00:00:00" } }, "Exact (Netherlands)": { "value": { "reports": [] } }, "Exact (UK)": { "value": { "currency": "GBP", "reports": [ { "date": "2022-10-31T00:00:00Z", "assets": { "name": "Assets", "value": -2, "items": [ { "accountId": "cf9572e7-8afa-4339-9113-af32a66d9df9", "name": "15400 - Trade Debtors", "value": -3, "items": [] }, { "accountId": "ba382d88-a4e5-4117-8fc6-4752ee8bc93d", "name": "15801 - Standard account", "value": 1, "items": [] } ] }, "liabilities": { "name": "Liabilities", "value": 0, "items": [] }, "netAssets": -2, "equity": { "name": "Equities", "value": -2, "items": [ { "accountId": "PROFIT-AND-LOSS", "name": "Profit for this period", "value": -2, "items": [] } ] } }, { "date": "2022-09-30T00:00:00Z", "assets": { "name": "Assets", "value": 208, "items": [ { "accountId": "885ff551-664d-451b-995b-cb114c9877d0", "name": "15890 - Unallocated Cash", "value": 0, "items": [] }, { "accountId": "cf9572e7-8afa-4339-9113-af32a66d9df9", "name": "15400 - Trade Debtors", "value": 78, "items": [] }, { "accountId": "4a4e34b5-7f62-4b64-a44a-073398b14b41", "name": "15880 - Bank", "value": 130, "items": [] } ] }, "liabilities": { "name": "Liabilities", "value": 0, "items": [ { "accountId": "88d733a8-51e1-4ee7-b2a0-fb49879e36cc", "name": "21000 - Trade Creditors", "value": 0, "items": [] } ] }, "netAssets": 208, "equity": { "name": "Equities", "value": 208, "items": [ { "accountId": "PROFIT-AND-LOSS", "name": "Profit for this period", "value": 208, "items": [] } ] } } ], "mostRecentAvailableMonth": "2022-10-31T00:00:00", "earliestAvailableMonth": "2022-04-01T00:00:00" } }, "FreshBooks": { "value": { "currency": "GBP", "reports": [ { "date": "2023-04-30T00:00:00", "assets": { "name": "assets", "value": 38416.28, "items": [ { "accountId": "167679", "name": "Cash", "value": -3011.5, "items": [ { "accountId": "291721", "name": "Petty Cash", "value": -3022.5, "items": [] }, { "accountId": "3427097", "name": "Cash", "value": 11, "items": [] } ] }, { "accountId": "67357", "name": "Accounts Receivable", "value": 41445.53, "items": [ { "accountId": "128611", "name": "Accounts Receivable", "value": 41445.53, "items": [] } ] }, { "accountId": "2761661", "name": "Current Asset", "value": -11, "items": [ { "accountId": "3420060", "name": "Prepaid Expenses", "value": -11, "items": [] } ] }, { "accountId": "2288207", "name": "Property, Plant, and Equipment", "value": -6.75, "items": [ { "accountId": "2792069", "name": "Office Equipment", "value": -6.75, "items": [] } ] } ] }, "liabilities": { "name": "liabilities", "value": 9310.72, "items": [ { "accountId": "2288209", "name": "Accounts Payable", "value": 460.39, "items": [ { "accountId": "3385145", "name": "Accounts Payable", "value": 460.39, "items": [] } ] }, { "accountId": "67361", "name": "Taxes Payable", "value": 36.75, "items": [ { "accountId": "128615", "name": "VAT", "value": -108.9, "items": [] }, { "accountId": "3380553", "name": "Customs Duty", "value": -2.5, "items": [] }, { "accountId": "3380555", "name": "Excise Duty", "value": -54.45, "items": [] }, { "accountId": "3384241", "name": "tax 50", "value": 0.7, "items": [] }, { "accountId": "3384293", "name": "helloabdul", "value": 86.03, "items": [] }, { "accountId": "3384425", "name": "hello2", "value": 114.76, "items": [] }, { "accountId": "3420099", "name": "VAT1", "value": 1.11, "items": [] } ] }, { "accountId": "237025", "name": "Customer Credit", "value": 8813.58, "items": [ { "accountId": "392937", "name": "Customer Credit", "value": 8813.58, "items": [] } ] } ] }, "netAssets": 29105.56, "equity": { "name": "equity", "value": 29105.56, "items": [ { "accountId": "", "name": "Net Income", "value": 29105.56, "items": [] } ] } }, { "date": "2023-03-31T00:00:00", "assets": { "name": "assets", "value": 38416.28, "items": [ { "accountId": "167679", "name": "Cash", "value": -3011.5, "items": [ { "accountId": "291721", "name": "Petty Cash", "value": -3022.5, "items": [] }, { "accountId": "3427097", "name": "Cash", "value": 11, "items": [] } ] }, { "accountId": "67357", "name": "Accounts Receivable", "value": 41445.53, "items": [ { "accountId": "128611", "name": "Accounts Receivable", "value": 41445.53, "items": [] } ] }, { "accountId": "2761661", "name": "Current Asset", "value": -11, "items": [ { "accountId": "3420060", "name": "Prepaid Expenses", "value": -11, "items": [] } ] }, { "accountId": "2288207", "name": "Property, Plant, and Equipment", "value": -6.75, "items": [ { "accountId": "2792069", "name": "Office Equipment", "value": -6.75, "items": [] } ] } ] }, "liabilities": { "name": "liabilities", "value": 9310.72, "items": [ { "accountId": "2288209", "name": "Accounts Payable", "value": 460.39, "items": [ { "accountId": "3385145", "name": "Accounts Payable", "value": 460.39, "items": [] } ] }, { "accountId": "67361", "name": "Taxes Payable", "value": 36.75, "items": [ { "accountId": "128615", "name": "VAT", "value": -108.9, "items": [] }, { "accountId": "3380553", "name": "Customs Duty", "value": -2.5, "items": [] }, { "accountId": "3380555", "name": "Excise Duty", "value": -54.45, "items": [] }, { "accountId": "3384241", "name": "tax 50", "value": 0.7, "items": [] }, { "accountId": "3384293", "name": "helloabdul", "value": 86.03, "items": [] }, { "accountId": "3384425", "name": "hello2", "value": 114.76, "items": [] }, { "accountId": "3420099", "name": "VAT1", "value": 1.11, "items": [] } ] }, { "accountId": "237025", "name": "Customer Credit", "value": 8813.58, "items": [ { "accountId": "392937", "name": "Customer Credit", "value": 8813.58, "items": [] } ] } ] }, "netAssets": 29105.56, "equity": { "name": "equity", "value": 29105.56, "items": [ { "accountId": "", "name": "Net Income", "value": 29105.56, "items": [] } ] } } ], "mostRecentAvailableMonth": "2023-04-30T00:00:00", "earliestAvailableMonth": "2022-10-01T00:00:00" } }, "KashFlow": { "value": { "currency": "GBP", "reports": [ { "date": "2022-09-30T00:00:00", "assets": { "name": "Assets", "value": 109979.14, "items": [ { "name": "Fixed Assets", "value": 923.62, "items": [ { "accountId": "29362903", "name": "FIXED ASSET CODE (SALES)", "value": -100, "items": [] }, { "accountId": "29362906", "name": "FIXED ASSET CODE (OUTGOING)", "value": 1006, "items": [] }, { "accountId": "29358753", "name": "TESTCODE", "value": 9.29, "items": [] }, { "accountId": "21481884", "name": "Computer equipment cost", "value": 8.33, "items": [] } ] }, { "name": "Current Assets", "value": 109055.52, "items": [ { "accountId": "21481886", "name": "Trade debtors", "value": 67166.51, "items": [] }, { "accountId": "636062", "name": "Current account", "value": 425.33, "items": [] }, { "accountId": "680495", "name": "Test Account", "value": 38003, "items": [] }, { "accountId": "684416", "name": "Tide Account 2", "value": 303.22, "items": [] }, { "accountId": "684418", "name": "New Tide Account", "value": 303.22, "items": [] }, { "accountId": "686687", "name": "Pete Test 02/05", "value": 301.64, "items": [] }, { "accountId": "696204", "name": "Go Live", "value": 9, "items": [] }, { "accountId": "696740", "name": "Production Test", "value": 0.08, "items": [] }, { "accountId": "707236", "name": "Dave Push Test uat", "value": 123.41, "items": [] }, { "accountId": "707240", "name": "Dave Push Test integ", "value": 139.54, "items": [] }, { "accountId": "813944", "name": "Please dont balance", "value": 110, "items": [] }, { "accountId": "765768", "name": "16th Account", "value": 326, "items": [] }, { "accountId": "809283", "name": "abduls company credit card", "value": 13.85, "items": [] }, { "accountId": "809318", "name": "ASSET ACCOUNT", "value": 110, "items": [] }, { "accountId": "776582", "name": "VandanaKasAcc1", "value": 20, "items": [] }, { "accountId": "780580", "name": "ABRAHAM2", "value": 40, "items": [] }, { "accountId": "780605", "name": "AbeVanTest3", "value": 10, "items": [] }, { "accountId": "780619", "name": "VandanaAccTest4", "value": 92.63, "items": [] }, { "accountId": "780669", "name": "NewXeroAccount10", "value": 21, "items": [] }, { "accountId": "780672", "name": "NewKasAccount10", "value": 111, "items": [] }, { "accountId": "809742", "name": "HSBBBBB", "value": 111, "items": [] }, { "accountId": "833089", "name": "AAAAA", "value": 260, "items": [] }, { "accountId": "21481890", "name": "Output VAT", "value": 511.04, "items": [] }, { "accountId": "21481891", "name": "Input VAT", "value": 504.05, "items": [] }, { "accountId": "21481895", "name": "CIS deductions", "value": 40, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 80187.1, "items": [ { "name": "Current Liabilities", "value": 80187.1, "items": [ { "accountId": "21481902", "name": "Other", "value": 43799.56, "items": [] }, { "accountId": "21481888", "name": "Cash in hand", "value": 317.07, "items": [] }, { "accountId": "612964", "name": "Bank account", "value": 33011.08, "items": [] }, { "accountId": "687106", "name": "May 4th Account", "value": 926.81, "items": [] }, { "accountId": "21481892", "name": "VAT control account", "value": 322, "items": [] }, { "accountId": "21481893", "name": "Trade creditors", "value": 1618.27, "items": [] }, { "accountId": "29553868", "name": "Creditors Control Account", "value": 192.31, "items": [] } ] } ] }, "netAssets": 29792.04, "equity": { "name": "Equity", "value": 29792.05, "items": [ { "name": "Capital and Reserves", "value": 29792.05, "items": [ { "accountId": "21481901", "name": "Retained profit/loss", "value": 31402.01, "items": [] }, { "accountId": "0", "name": "P&L Account", "value": -1609.96, "items": [] } ] } ] } }, { "date": "2022-08-31T00:00:00", "assets": { "name": "Assets", "value": 109979.14, "items": [ { "name": "Fixed Assets", "value": 923.62, "items": [ { "accountId": "29362903", "name": "FIXED ASSET CODE (SALES)", "value": -100, "items": [] }, { "accountId": "29362906", "name": "FIXED ASSET CODE (OUTGOING)", "value": 1006, "items": [] }, { "accountId": "29358753", "name": "TESTCODE", "value": 9.29, "items": [] }, { "accountId": "21481884", "name": "Computer equipment cost", "value": 8.33, "items": [] } ] }, { "name": "Current Assets", "value": 109055.52, "items": [ { "accountId": "21481886", "name": "Trade debtors", "value": 67166.51, "items": [] }, { "accountId": "636062", "name": "Current account", "value": 425.33, "items": [] }, { "accountId": "680495", "name": "Test Account", "value": 38003, "items": [] }, { "accountId": "684416", "name": "Tide Account 2", "value": 303.22, "items": [] }, { "accountId": "684418", "name": "New Tide Account", "value": 303.22, "items": [] }, { "accountId": "686687", "name": "Pete Test 02/05", "value": 301.64, "items": [] }, { "accountId": "696204", "name": "Go Live", "value": 9, "items": [] }, { "accountId": "696740", "name": "Production Test", "value": 0.08, "items": [] }, { "accountId": "707236", "name": "Dave Push Test uat", "value": 123.41, "items": [] }, { "accountId": "707240", "name": "Dave Push Test integ", "value": 139.54, "items": [] }, { "accountId": "813944", "name": "Please dont balance", "value": 110, "items": [] }, { "accountId": "765768", "name": "16th Account", "value": 326, "items": [] }, { "accountId": "809283", "name": "abduls company credit card", "value": 13.85, "items": [] }, { "accountId": "809318", "name": "ASSET ACCOUNT", "value": 110, "items": [] }, { "accountId": "776582", "name": "VandanaKasAcc1", "value": 20, "items": [] }, { "accountId": "780580", "name": "ABRAHAM2", "value": 40, "items": [] }, { "accountId": "780605", "name": "AbeVanTest3", "value": 10, "items": [] }, { "accountId": "780619", "name": "VandanaAccTest4", "value": 92.63, "items": [] }, { "accountId": "780669", "name": "NewXeroAccount10", "value": 21, "items": [] }, { "accountId": "780672", "name": "NewKasAccount10", "value": 111, "items": [] }, { "accountId": "809742", "name": "HSBBBBB", "value": 111, "items": [] }, { "accountId": "833089", "name": "AAAAA", "value": 260, "items": [] }, { "accountId": "21481890", "name": "Output VAT", "value": 511.04, "items": [] }, { "accountId": "21481891", "name": "Input VAT", "value": 504.05, "items": [] }, { "accountId": "21481895", "name": "CIS deductions", "value": 40, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 80187.1, "items": [ { "name": "Current Liabilities", "value": 80187.1, "items": [ { "accountId": "21481902", "name": "Other", "value": 43799.56, "items": [] }, { "accountId": "21481888", "name": "Cash in hand", "value": 317.07, "items": [] }, { "accountId": "612964", "name": "Bank account", "value": 33011.08, "items": [] }, { "accountId": "687106", "name": "May 4th Account", "value": 926.81, "items": [] }, { "accountId": "21481892", "name": "VAT control account", "value": 322, "items": [] }, { "accountId": "21481893", "name": "Trade creditors", "value": 1618.27, "items": [] }, { "accountId": "29553868", "name": "Creditors Control Account", "value": 192.31, "items": [] } ] } ] }, "netAssets": 29792.04, "equity": { "name": "Equity", "value": 29792.05, "items": [ { "name": "Capital and Reserves", "value": 29792.05, "items": [ { "accountId": "21481901", "name": "Retained profit/loss", "value": 31402.01, "items": [] }, { "accountId": "0", "name": "P&L Account", "value": -1609.96, "items": [] } ] } ] } } ], "mostRecentAvailableMonth": "2022-09-30T00:00:00", "earliestAvailableMonth": "2022-03-01T00:00:00" } }, "MYOB AccountRight and Essentials": { "value": { "currency": "GBP", "reports": [ { "date": "2022-11-30T00:00:00", "assets": { "name": "Assets", "value": 0, "items": [] }, "liabilities": { "name": "Liabilities", "value": 0, "items": [] }, "netAssets": 0, "equity": { "name": "Equity", "value": 0, "items": [] } }, { "date": "2022-10-31T00:00:00", "assets": { "name": "Assets", "value": 0, "items": [] }, "liabilities": { "name": "Liabilities", "value": 0, "items": [] }, "netAssets": 0, "equity": { "name": "Equity", "value": 0, "items": [] } } ], "mostRecentAvailableMonth": "2022-11-30T00:00:00", "earliestAvailableMonth": "2022-05-01T00:00:00" } }, "Oracle NetSuite": { "value": { "currency": "GBP", "reports": [ { "date": "2023-05-31T00:00:00", "assets": { "accountId": "", "name": "Assets", "value": 703, "items": [ { "accountId": "119", "name": "Accounts Receivable", "value": -565, "items": [] }, { "accountId": "122", "name": "Undeposited Funds", "value": 10, "items": [] }, { "accountId": "211", "name": "VAT on Purchases", "value": 24, "items": [] }, { "accountId": "716", "name": "Inventory In Transit", "value": 120, "items": [] }, { "accountId": "825", "name": "Codat Europe Bank", "value": 558.22, "items": [ { "accountId": "825", "name": "Codat Europe Bank", "value": 558.22, "items": [] } ] }, { "accountId": "844", "name": "Asset account test 2", "value": 555.78, "items": [ { "accountId": "844", "name": "Asset account test 2", "value": 555.78, "items": [] } ] } ] }, "liabilities": { "accountId": "", "name": "Liabilities", "value": 635.55, "items": [ { "accountId": "111", "name": "Accounts Payable", "value": 635.55, "items": [ { "accountId": "111", "name": "Accounts Payable", "value": 635.55, "items": [] } ] } ] }, "netAssets": 67.45, "equity": { "accountId": "", "name": "Equity", "value": 67.45, "items": [ { "accountId": "851", "name": "Demo account equity", "value": -11, "items": [] }, { "name": "Net Income", "value": 78.45, "items": [] } ] } }, { "date": "2023-04-30T00:00:00", "assets": { "accountId": "", "name": "Assets", "value": 703, "items": [ { "accountId": "119", "name": "Accounts Receivable", "value": -565, "items": [] }, { "accountId": "122", "name": "Undeposited Funds", "value": 10, "items": [] }, { "accountId": "211", "name": "VAT on Purchases", "value": 24, "items": [] }, { "accountId": "716", "name": "Inventory In Transit", "value": 120, "items": [] }, { "accountId": "825", "name": "Codat Europe Bank", "value": 558.22, "items": [ { "accountId": "825", "name": "Codat Europe Bank", "value": 558.22, "items": [] } ] }, { "accountId": "844", "name": "Asset account test 2", "value": 555.78, "items": [ { "accountId": "844", "name": "Asset account test 2", "value": 555.78, "items": [] } ] } ] }, "liabilities": { "accountId": "", "name": "Liabilities", "value": 635.55, "items": [ { "accountId": "111", "name": "Accounts Payable", "value": 635.55, "items": [ { "accountId": "111", "name": "Accounts Payable", "value": 635.55, "items": [] } ] } ] }, "netAssets": 67.45, "equity": { "accountId": "", "name": "Equity", "value": 67.45, "items": [ { "accountId": "851", "name": "Demo account equity", "value": -11, "items": [] }, { "name": "Net Income", "value": 78.45, "items": [] } ] } } ], "mostRecentAvailableMonth": "2023-05-31T00:00:00", "earliestAvailableMonth": "2022-11-01T00:00:00" } }, "QuickBooks Desktop": { "value": { "currency": "GBP", "reports": [ { "date": "2023-04-30T00:00:00", "assets": { "name": "ASSETS", "value": 549695.86, "items": [ { "name": "Current Assets", "value": 81821.64, "items": [ { "name": "Checking/Savings", "value": 57007.53, "items": [ { "accountId": "20000-933270541", "name": "10100 � Checking", "value": 40814.11, "items": [] }, { "accountId": "30000-933270541", "name": "10300 � Savings", "value": 15693.42, "items": [] }, { "accountId": "550001-1071509830", "name": "10400 � Petty Cash", "value": 500, "items": [] } ] }, { "name": "Accounts Receivable", "value": 7719.99, "items": [ { "accountId": "40000-933270541", "name": "11000 � Accounts Receivable", "value": 7719.99, "items": [] } ] }, { "name": "Other Current Assets", "value": 17094.12, "items": [ { "accountId": "60000-933270541", "name": "12100 � Inventory Asset", "value": 13177.4, "items": [] }, { "accountId": "50000-933270541", "name": "12800 � Employee Advances", "value": 770, "items": [] }, { "accountId": "370001-1071514466", "name": "13100 � Pre-paid Insurance", "value": 1350, "items": [] }, { "accountId": "70000-933270541", "name": "13400 � Retainage Receivable", "value": 1796.72, "items": [] } ] } ] }, { "name": "Fixed Assets", "value": 466154.22, "items": [ { "accountId": "5F0000-1197755449", "name": "15000 � Furniture and Equipment", "value": 22826, "items": [] }, { "accountId": "90000-933270541", "name": "15100 � Vehicles", "value": 78936.91, "items": [] }, { "accountId": "600000-1197756365", "name": "15200 � Buildings and Improvements", "value": 325000, "items": [] }, { "accountId": "590000-1071511920", "name": "15300 � Construction Equipment", "value": 15300, "items": [] }, { "accountId": "610000-1197756496", "name": "16900 � Land", "value": 90000, "items": [] }, { "accountId": "620000-1197756666", "name": "17000 � Accumulated Depreciation", "value": -65908.69, "items": [] } ] }, { "name": "Other Assets", "value": 1720, "items": [ { "accountId": "80000063-1197709076", "name": "18700 � Security Deposits", "value": 1720, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 451499.2, "items": [ { "name": "Current Liabilities", "value": 6718.02, "items": [ { "name": "Accounts Payable", "value": 5000, "items": [ { "accountId": "C0000-933270541", "name": "20000 � Accounts Payable", "value": 5000, "items": [] } ] }, { "name": "Credit Cards", "value": 1400, "items": [ { "accountId": "570000-1071509253", "name": "20500 � QuickBooks Credit Card", "value": 1400, "items": [] } ] }, { "name": "Other Current Liabilities", "value": 318.02, "items": [ { "accountId": "100000-933270541", "name": "25500 � Sales Tax Payable", "value": 318.02, "items": [] } ] } ] }, { "name": "Long Term Liabilities", "value": 444781.18, "items": [ { "accountId": "120000-933270541", "name": "23000 � Loan - Vehicles (Van)", "value": 19932.64, "items": [] }, { "accountId": "80000075-1197719780", "name": "23100 � Loan - Vehicles (Utility Truck)", "value": 19936.91, "items": [] }, { "accountId": "80000076-1197719828", "name": "23200 � Loan - Vehicles (Pickup Truck)", "value": 22641, "items": [] }, { "accountId": "5B0000-1197774305", "name": "28100 � Loan - Construction Equipment", "value": 14343.11, "items": [] }, { "accountId": "80000068-1197710590", "name": "28200 � Loan - Furniture/Office Equip", "value": 21000, "items": [] }, { "accountId": "8000008F-1197954502", "name": "28700 � Note Payable - Bank of Anycity", "value": 50644.52, "items": [] }, { "accountId": "80000067-1197709946", "name": "28900 � Mortgage - Office Building", "value": 296283, "items": [] } ] } ] }, "netAssets": 98196.66, "equity": { "name": "Equity", "value": 98196.66, "items": [ { "accountId": "10000-933270541", "name": "30000 � Opening Bal Equity", "value": 38773.75, "items": [] }, { "accountId": "80000066-1197709715", "name": "30100 � Capital Stock", "value": 500, "items": [] }, { "accountId": "160000-933270541", "name": "32000 � Retained Earnings", "value": 36213.97, "items": [] }, { "name": "Net Income", "value": 22708.94, "items": [] } ] } }, { "date": "2023-03-31T00:00:00", "assets": { "name": "ASSETS", "value": 547971.05, "items": [ { "name": "Current Assets", "value": 80096.83, "items": [ { "name": "Checking/Savings", "value": 45769.39, "items": [ { "accountId": "20000-933270541", "name": "10100 � Checking", "value": 29575.97, "items": [] }, { "accountId": "30000-933270541", "name": "10300 � Savings", "value": 15693.42, "items": [] }, { "accountId": "550001-1071509830", "name": "10400 � Petty Cash", "value": 500, "items": [] } ] }, { "name": "Accounts Receivable", "value": 16228.47, "items": [ { "accountId": "40000-933270541", "name": "11000 � Accounts Receivable", "value": 16228.47, "items": [] } ] }, { "name": "Other Current Assets", "value": 18098.97, "items": [ { "accountId": "60000-933270541", "name": "12100 � Inventory Asset", "value": 13507.25, "items": [] }, { "accountId": "50000-933270541", "name": "12800 � Employee Advances", "value": 770, "items": [] }, { "accountId": "370001-1071514466", "name": "13100 � Pre-paid Insurance", "value": 2025, "items": [] }, { "accountId": "70000-933270541", "name": "13400 � Retainage Receivable", "value": 1796.72, "items": [] } ] } ] }, { "name": "Fixed Assets", "value": 466154.22, "items": [ { "accountId": "5F0000-1197755449", "name": "15000 � Furniture and Equipment", "value": 22826, "items": [] }, { "accountId": "90000-933270541", "name": "15100 � Vehicles", "value": 78936.91, "items": [] }, { "accountId": "600000-1197756365", "name": "15200 � Buildings and Improvements", "value": 325000, "items": [] }, { "accountId": "590000-1071511920", "name": "15300 � Construction Equipment", "value": 15300, "items": [] }, { "accountId": "610000-1197756496", "name": "16900 � Land", "value": 90000, "items": [] }, { "accountId": "620000-1197756666", "name": "17000 � Accumulated Depreciation", "value": -65908.69, "items": [] } ] }, { "name": "Other Assets", "value": 1720, "items": [ { "accountId": "80000063-1197709076", "name": "18700 � Security Deposits", "value": 1720, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 453300.75, "items": [ { "name": "Current Liabilities", "value": 5714, "items": [ { "name": "Accounts Payable", "value": 5714, "items": [ { "accountId": "C0000-933270541", "name": "20000 � Accounts Payable", "value": 5714, "items": [] } ] } ] }, { "name": "Long Term Liabilities", "value": 447586.75, "items": [ { "accountId": "120000-933270541", "name": "23000 � Loan - Vehicles (Van)", "value": 20376.27, "items": [] }, { "accountId": "80000075-1197719780", "name": "23100 � Loan - Vehicles (Utility Truck)", "value": 19936.91, "items": [] }, { "accountId": "80000076-1197719828", "name": "23200 � Loan - Vehicles (Pickup Truck)", "value": 22641, "items": [] }, { "accountId": "5B0000-1197774305", "name": "28100 � Loan - Construction Equipment", "value": 14343.11, "items": [] }, { "accountId": "80000068-1197710590", "name": "28200 � Loan - Furniture/Office Equip", "value": 21000, "items": [] }, { "accountId": "8000008F-1197954502", "name": "28700 � Note Payable - Bank of Anycity", "value": 53006.46, "items": [] }, { "accountId": "80000067-1197709946", "name": "28900 � Mortgage - Office Building", "value": 296283, "items": [] } ] } ] }, "netAssets": 94670.3, "equity": { "name": "Equity", "value": 94670.3, "items": [ { "accountId": "10000-933270541", "name": "30000 � Opening Bal Equity", "value": 38773.75, "items": [] }, { "accountId": "80000066-1197709715", "name": "30100 � Capital Stock", "value": 500, "items": [] }, { "accountId": "160000-933270541", "name": "32000 � Retained Earnings", "value": 36213.97, "items": [] }, { "name": "Net Income", "value": 19182.58, "items": [] } ] } } ], "mostRecentAvailableMonth": "2023-04-30T00:00:00", "earliestAvailableMonth": "2022-10-01T00:00:00" } }, "QuickBooks Online Sandbox": { "value": { "currency": "GBP", "reports": [ { "date": "2023-04-30T00:00:00", "assets": { "name": "Assets", "value": 3856584.88, "items": [ { "name": "Fixed Asset", "value": 2766.17, "items": [ { "accountId": "3", "name": "Accumulated Depreciation", "value": -399.96, "items": [] }, { "accountId": "5", "name": "Furniture and Equipment", "value": 2750, "items": [] }, { "accountId": "7", "name": "Leasehold Improvements", "value": -99.12, "items": [] }, { "accountId": "9", "name": "Vehicles", "value": 515.25, "items": [] } ] }, { "name": "Bank", "value": 520021.91, "items": [ { "accountId": "114", "name": "0983741 SamplePushBankAccount2", "value": 40.5, "items": [] }, { "accountId": "175", "name": "1 Push-FrontDoor-Test-1", "value": 112, "items": [] }, { "accountId": "134", "name": "1001001 Revenue", "value": -235.34, "items": [] }, { "accountId": "110", "name": "101 Push Refactor Test", "value": -149.4, "items": [] }, { "accountId": "102", "name": "10101 IntegrationTest", "value": -1444.14, "items": [] }, { "accountId": "103", "name": "101011 testdemo1", "value": 18.6, "items": [] }, { "accountId": "104", "name": "101012 Dave Test", "value": -5.4, "items": [] }, { "accountId": "105", "name": "101013 Push Test", "value": 5.4, "items": [] }, { "accountId": "107", "name": "11 aaa", "value": 23610.49, "items": [] }, { "accountId": "115", "name": "1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111", "value": -9000.81, "items": [] }, { "accountId": "100", "name": "1131 Savings2", "value": 30281.54, "items": [] }, { "accountId": "109", "name": "122 Generic Push Test", "value": -1079.05, "items": [] }, { "accountId": "101", "name": "123 Test Savings", "value": 2293.37, "items": [] }, { "accountId": "111", "name": "123123 Steve Test", "value": -1104.2, "items": [] }, { "accountId": "124", "name": "123175 Nominal Card", "value": -2013.04, "items": [] }, { "accountId": "137", "name": "1232 test 55", "value": 1.29, "items": [] }, { "accountId": "122", "name": "1234567 Card3million", "value": -85, "items": [] }, { "accountId": "176", "name": "12345671 testName_1", "value": 17546.08, "items": [] }, { "accountId": "165", "name": "123564 Huws testing name", "value": -2, "items": [] }, { "accountId": "159", "name": "1533465364 Huws test name", "value": 282.21, "items": [] }, { "accountId": "161", "name": "160894 Tom Automated Tests ExpensesAccount", "value": -15900.6, "items": [] }, { "accountId": "108", "name": "19191 New Push Operation Test", "value": 317.54, "items": [] }, { "accountId": "139", "name": "2501 Barclays", "value": 211127.4, "items": [] }, { "accountId": "140", "name": "2502 HSBC", "value": 109500.4, "items": [] }, { "accountId": "141", "name": "2503 BoA", "value": 128050.89, "items": [] }, { "accountId": "138", "name": "4234 test55", "value": -29.28, "items": [] }, { "accountId": "106", "name": "aa aa", "value": -5.4, "items": [] }, { "accountId": "129", "name": "Account Test 11", "value": 33.93, "items": [] }, { "accountId": "147", "name": "Bank EUR", "value": 188.5, "items": [] }, { "accountId": "173", "name": "Cash on hand", "value": 2655, "items": [] }, { "accountId": "178", "name": "Citi", "value": 189.11, "items": [] }, { "accountId": "81", "name": "Current", "value": 24513.64, "items": [] }, { "accountId": "177", "name": "HSBC HKD", "value": -39.39, "items": [] }, { "accountId": "169", "name": "Matt Ager Test UI Parent Account", "value": 75, "items": [] }, { "accountId": "89", "name": "TestBankAccount_1", "value": 272.07, "items": [] } ] }, { "name": "Accounts Receivable", "value": 3074459.19, "items": [ { "accountId": "70", "name": "Debtors", "value": 3041138.07, "items": [] }, { "accountId": "80", "name": "Debtors - USD", "value": 33315.2, "items": [] }, { "accountId": "125", "name": "Debtors 2", "value": -7.45, "items": [] }, { "accountId": "88", "name": "TestBankAccount", "value": 13.37, "items": [] } ] }, { "name": "Other Current Asset", "value": 259337.61, "items": [ { "accountId": "98", "name": "Account_001", "value": 545.86, "items": [] }, { "accountId": "185", "name": "Loans To Officers", "value": 1200, "items": [] }, { "accountId": "179", "name": "Loans to Others", "value": 58.2, "items": [] }, { "accountId": "171", "name": "Matt Ager Test UI Parent Account 1", "value": 11, "items": [] }, { "accountId": "168", "name": "Other current assets", "value": 10, "items": [] }, { "accountId": "65", "name": "Stock Asset", "value": 36524, "items": [] }, { "accountId": "150", "name": "stock test", "value": 10, "items": [] }, { "accountId": "77", "name": "Uncategorised Asset", "value": 47.8, "items": [] }, { "accountId": "85", "name": "Undeposited Funds", "value": 220930.75, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 169469.71, "items": [ { "name": "Accounts Payable", "value": 93748.74, "items": [ { "accountId": "71", "name": "Creditors", "value": 93635.4, "items": [] }, { "accountId": "74", "name": "Creditors - HKD", "value": 113.34, "items": [] } ] }, { "name": "Credit Card", "value": 10841.34, "items": [ { "accountId": "142", "name": "2504 Amex - CC", "value": 9957.72, "items": [] }, { "accountId": "126", "name": "Credit Card 2", "value": -71.91, "items": [] }, { "accountId": "183", "name": "Expense Automated Tests Credit Card", "value": -2469.91, "items": [] }, { "accountId": "57", "name": "Visa Credit Card", "value": 3425.44, "items": [] } ] }, { "name": "Other Current Liability", "value": 10001.33, "items": [ { "accountId": "118", "name": "Current Liabilities", "value": 82.12, "items": [] }, { "accountId": "157", "name": "Loan Payable - Kay's Bank", "value": 12726, "items": [] }, { "accountId": "187", "name": "Payroll Clearing", "value": -3458.3, "items": [] }, { "accountId": "53", "name": "VAT Control", "value": -4738.49, "items": [] }, { "accountId": "54", "name": "VAT Suspense", "value": 5390, "items": [] } ] }, { "name": "Long Term Liability", "value": 54878.3, "items": [ { "accountId": "158", "name": "Loan Long term borrowings - Jay's Bank", "value": 35630, "items": [] }, { "accountId": "84", "name": "Long term borrowings", "value": -1100, "items": [] }, { "accountId": "63", "name": "Note Payable", "value": 19348.3, "items": [] }, { "accountId": "86", "name": "Accruals and deferred income", "value": 1000, "items": [] } ] } ] }, "netAssets": 3687115.17, "equity": { "name": "Equity", "value": 3687115.17, "items": [ { "name": "Equity", "value": 3697585.43, "items": [ { "accountId": "55", "name": "Opening Balance Equity", "value": 966720.56, "items": [] }, { "accountId": "2", "name": "Retained Earnings", "value": 2706364.87, "items": [] }, { "accountId": "61", "name": "Owner's Equity - Contributions", "value": 25500, "items": [] }, { "accountId": "62", "name": "Owner's Equity - Draws", "value": -1000, "items": [] } ] }, { "name": "Profit for the year", "value": -10470.26, "items": [] } ] } }, { "date": "2023-03-31T00:00:00", "assets": { "name": "Assets", "value": 4385453.25, "items": [ { "name": "Fixed Asset", "value": 2766.17, "items": [ { "accountId": "3", "name": "Accumulated Depreciation", "value": -399.96, "items": [] }, { "accountId": "5", "name": "Furniture and Equipment", "value": 2750, "items": [] }, { "accountId": "7", "name": "Leasehold Improvements", "value": -99.12, "items": [] }, { "accountId": "9", "name": "Vehicles", "value": 515.25, "items": [] } ] }, { "name": "Bank", "value": 1048102.14, "items": [ { "accountId": "114", "name": "0983741 SamplePushBankAccount2", "value": 40.5, "items": [] }, { "accountId": "175", "name": "1 Push-FrontDoor-Test-1", "value": 112, "items": [] }, { "accountId": "134", "name": "1001001 Revenue", "value": -235.34, "items": [] }, { "accountId": "110", "name": "101 Push Refactor Test", "value": -149.4, "items": [] }, { "accountId": "102", "name": "10101 IntegrationTest", "value": -1444.14, "items": [] }, { "accountId": "103", "name": "101011 testdemo1", "value": 18.6, "items": [] }, { "accountId": "104", "name": "101012 Dave Test", "value": -5.4, "items": [] }, { "accountId": "105", "name": "101013 Push Test", "value": 5.4, "items": [] }, { "accountId": "107", "name": "11 aaa", "value": 23610.49, "items": [] }, { "accountId": "115", "name": "1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111", "value": -9000.81, "items": [] }, { "accountId": "100", "name": "1131 Savings2", "value": 30281.54, "items": [] }, { "accountId": "109", "name": "122 Generic Push Test", "value": -1079.05, "items": [] }, { "accountId": "101", "name": "123 Test Savings", "value": 2293.37, "items": [] }, { "accountId": "111", "name": "123123 Steve Test", "value": -1104.2, "items": [] }, { "accountId": "124", "name": "123175 Nominal Card", "value": -2013.04, "items": [] }, { "accountId": "137", "name": "1232 test 55", "value": 1.29, "items": [] }, { "accountId": "122", "name": "1234567 Card3million", "value": -85, "items": [] }, { "accountId": "176", "name": "12345671 testName_1", "value": 14029.28, "items": [] }, { "accountId": "165", "name": "123564 Huws testing name", "value": -2, "items": [] }, { "accountId": "159", "name": "1533465364 Huws test name", "value": 282.21, "items": [] }, { "accountId": "161", "name": "160894 Tom Automated Tests ExpensesAccount", "value": -11410.5, "items": [] }, { "accountId": "108", "name": "19191 New Push Operation Test", "value": 317.54, "items": [] }, { "accountId": "139", "name": "2501 Barclays", "value": 741293.8, "items": [] }, { "accountId": "140", "name": "2502 HSBC", "value": 109155.93, "items": [] }, { "accountId": "141", "name": "2503 BoA", "value": 128055.89, "items": [] }, { "accountId": "138", "name": "4234 test55", "value": -14.28, "items": [] }, { "accountId": "106", "name": "aa aa", "value": -5.4, "items": [] }, { "accountId": "129", "name": "Account Test 11", "value": 33.93, "items": [] }, { "accountId": "147", "name": "Bank EUR", "value": 188.5, "items": [] }, { "accountId": "173", "name": "Cash on hand", "value": -5, "items": [] }, { "accountId": "178", "name": "Citi", "value": 189.11, "items": [] }, { "accountId": "81", "name": "Current", "value": 24438.64, "items": [] }, { "accountId": "177", "name": "HSBC HKD", "value": -39.39, "items": [] }, { "accountId": "169", "name": "Matt Ager Test UI Parent Account", "value": 75, "items": [] }, { "accountId": "89", "name": "TestBankAccount_1", "value": 272.07, "items": [] } ] }, { "name": "Accounts Receivable", "value": 3075173.68, "items": [ { "accountId": "70", "name": "Debtors", "value": 3041854.11, "items": [] }, { "accountId": "80", "name": "Debtors - USD", "value": 33315.2, "items": [] }, { "accountId": "125", "name": "Debtors 2", "value": -9, "items": [] }, { "accountId": "88", "name": "TestBankAccount", "value": 13.37, "items": [] } ] }, { "name": "Other Current Asset", "value": 259411.26, "items": [ { "accountId": "98", "name": "Account_001", "value": 545.86, "items": [] }, { "accountId": "185", "name": "Loans To Officers", "value": 1200, "items": [] }, { "accountId": "179", "name": "Loans to Others", "value": 58.2, "items": [] }, { "accountId": "171", "name": "Matt Ager Test UI Parent Account 1", "value": 11, "items": [] }, { "accountId": "168", "name": "Other current assets", "value": 10, "items": [] }, { "accountId": "65", "name": "Stock Asset", "value": 36533.45, "items": [] }, { "accountId": "150", "name": "stock test", "value": 10, "items": [] }, { "accountId": "77", "name": "Uncategorised Asset", "value": 47.8, "items": [] }, { "accountId": "85", "name": "Undeposited Funds", "value": 220994.95, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 699368.94, "items": [ { "name": "Accounts Payable", "value": 93773.74, "items": [ { "accountId": "71", "name": "Creditors", "value": 93660.4, "items": [] }, { "accountId": "74", "name": "Creditors - HKD", "value": 113.34, "items": [] } ] }, { "name": "Credit Card", "value": 12226.79, "items": [ { "accountId": "142", "name": "2504 Amex - CC", "value": 11004.72, "items": [] }, { "accountId": "126", "name": "Credit Card 2", "value": -71.91, "items": [] }, { "accountId": "183", "name": "Expense Automated Tests Credit Card", "value": -2471.46, "items": [] }, { "accountId": "57", "name": "Visa Credit Card", "value": 3765.44, "items": [] } ] }, { "name": "Other Current Liability", "value": 538490.11, "items": [ { "accountId": "118", "name": "Current Liabilities", "value": 72.12, "items": [] }, { "accountId": "157", "name": "Loan Payable - Kay's Bank", "value": 12726, "items": [] }, { "accountId": "187", "name": "Payroll Clearing", "value": -3458.3, "items": [] }, { "accountId": "53", "name": "VAT Control", "value": -3792.71, "items": [] }, { "accountId": "54", "name": "VAT Suspense", "value": 532943, "items": [] } ] }, { "name": "Long Term Liability", "value": 54878.3, "items": [ { "accountId": "158", "name": "Loan Long term borrowings - Jay's Bank", "value": 35630, "items": [] }, { "accountId": "84", "name": "Long term borrowings", "value": -1100, "items": [] }, { "accountId": "63", "name": "Note Payable", "value": 19348.3, "items": [] }, { "accountId": "86", "name": "Accruals and deferred income", "value": 1000, "items": [] } ] } ] }, "netAssets": 3686084.31, "equity": { "name": "Equity", "value": 3686084.31, "items": [ { "name": "Equity", "value": 3697585.43, "items": [ { "accountId": "55", "name": "Opening Balance Equity", "value": 966720.56, "items": [] }, { "accountId": "2", "name": "Retained Earnings", "value": 2706364.87, "items": [] }, { "accountId": "61", "name": "Owner's Equity - Contributions", "value": 25500, "items": [] }, { "accountId": "62", "name": "Owner's Equity - Draws", "value": -1000, "items": [] } ] }, { "name": "Profit for the year", "value": -11501.12, "items": [] } ] } } ], "mostRecentAvailableMonth": "2023-04-30T00:00:00", "earliestAvailableMonth": "2022-10-01T00:00:00" } }, "QuickBooks Online": { "value": { "reports": [] } }, "Sage 50 (UK)": { "value": { "currency": "GBP", "reports": [ { "date": "2023-03-31T00:00:00", "assets": { "name": "Assets", "value": 239322.69, "items": [ { "name": "Fixed Assets", "value": 81530.08, "items": [ { "name": "Plant and Machinery", "value": 46515, "items": [ { "accountId": "0020", "name": "Plant and Machinery", "value": 50000, "items": [] }, { "accountId": "0021", "name": "Plant/Machinery Depreciation", "value": -3485, "items": [] } ] }, { "name": "Furniture and Fixtures", "value": 16807, "items": [ { "accountId": "0040", "name": "Furniture and Fixtures", "value": 16900, "items": [] }, { "accountId": "0041", "name": "Furniture/Fixture Depreciation", "value": -93, "items": [] } ] }, { "name": "Motor Vehicles", "value": 18208.08, "items": [ { "accountId": "0051", "name": "Motor Vehicles Depreciation", "value": -2091.92, "items": [] }, { "accountId": "0050", "name": "Motor Vehicles", "value": 20300, "items": [] } ] } ] }, { "name": "Current Assets", "value": 157792.61, "items": [ { "name": "Stock", "value": 35000, "items": [ { "accountId": "1001", "name": "Stock", "value": 35000, "items": [] } ] }, { "name": "Debtors", "value": 90640.61, "items": [ { "accountId": "1100", "name": "Debtors Control Account", "value": 90640.61, "items": [] }, { "accountId": "1103", "name": "Prepayments", "value": 0, "items": [] } ] }, { "name": "Deposits and Cash", "value": 5148.01, "items": [ { "accountId": "1220", "name": "Building Society Account", "value": 507.53, "items": [] }, { "accountId": "1230", "name": "Petty Cash", "value": 1130.48, "items": [] }, { "accountId": "1210", "name": "Bank Deposit Account", "value": 3510, "items": [] } ] }, { "name": "VAT Liability", "value": 27003.99, "items": [ { "accountId": "2201", "name": "Purchase Tax Control Account", "value": 12203.64, "items": [] }, { "accountId": "2202", "name": "VAT Liability", "value": 14800.35, "items": [] } ] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 97996.05, "items": [ { "name": "Current Liabilities", "value": 84941.05, "items": [ { "name": "Bank Account", "value": 20091.04, "items": [ { "accountId": "1200", "name": "Bank Current Account", "value": 20091.04, "items": [] } ] }, { "name": "Credit Card (Creditors)", "value": -9358.97, "items": [ { "accountId": "1240", "name": "Company Credit Card", "value": -9358.97, "items": [] } ] }, { "name": "Creditors : Short Term", "value": 44502.68, "items": [ { "accountId": "2100", "name": "Creditors Control Account", "value": 44502.68, "items": [] }, { "accountId": "2109", "name": "Accruals", "value": 0, "items": [] } ] }, { "name": "VAT Liability", "value": 22182.53, "items": [ { "accountId": "2200", "name": "Sales Tax Control Account", "value": 22182.53, "items": [] } ] }, { "name": "Taxation", "value": 7403.77, "items": [ { "accountId": "2210", "name": "P.A.Y.E.", "value": 5396.79, "items": [] }, { "accountId": "2211", "name": "National Insurance", "value": 2006.98, "items": [] } ] }, { "name": "Wages", "value": 120, "items": [ { "accountId": "2220", "name": "Net Wages", "value": 0, "items": [] }, { "accountId": "2230", "name": "Pension Fund", "value": 120, "items": [] } ] } ] }, { "name": "Non-Current Liabilities", "value": 13055, "items": [ { "name": "Creditors : Long Term", "value": 13055, "items": [ { "accountId": "2310", "name": "Hire Purchase", "value": 6160, "items": [] }, { "accountId": "2300", "name": "Loans", "value": 6895, "items": [] } ] } ] } ] }, "netAssets": 141326.64, "equity": { "name": "Equity", "value": 141326.64, "items": [ { "name": "Share Capital", "value": 96332, "items": [ { "accountId": "3000", "name": "Ordinary Shares", "value": 96332, "items": [] } ] }, { "name": "Profit and Loss Account", "value": 44994.64, "items": [] } ] } }, { "date": "2023-02-28T00:00:00", "assets": { "name": "Assets", "value": 239322.69, "items": [ { "name": "Fixed Assets", "value": 81530.08, "items": [ { "name": "Plant and Machinery", "value": 46515, "items": [ { "accountId": "0020", "name": "Plant and Machinery", "value": 50000, "items": [] }, { "accountId": "0021", "name": "Plant/Machinery Depreciation", "value": -3485, "items": [] } ] }, { "name": "Furniture and Fixtures", "value": 16807, "items": [ { "accountId": "0040", "name": "Furniture and Fixtures", "value": 16900, "items": [] }, { "accountId": "0041", "name": "Furniture/Fixture Depreciation", "value": -93, "items": [] } ] }, { "name": "Motor Vehicles", "value": 18208.08, "items": [ { "accountId": "0051", "name": "Motor Vehicles Depreciation", "value": -2091.92, "items": [] }, { "accountId": "0050", "name": "Motor Vehicles", "value": 20300, "items": [] } ] } ] }, { "name": "Current Assets", "value": 157792.61, "items": [ { "name": "Stock", "value": 35000, "items": [ { "accountId": "1001", "name": "Stock", "value": 35000, "items": [] } ] }, { "name": "Debtors", "value": 90640.61, "items": [ { "accountId": "1100", "name": "Debtors Control Account", "value": 90640.61, "items": [] }, { "accountId": "1103", "name": "Prepayments", "value": 0, "items": [] } ] }, { "name": "Deposits and Cash", "value": 5148.01, "items": [ { "accountId": "1220", "name": "Building Society Account", "value": 507.53, "items": [] }, { "accountId": "1230", "name": "Petty Cash", "value": 1130.48, "items": [] }, { "accountId": "1210", "name": "Bank Deposit Account", "value": 3510, "items": [] } ] }, { "name": "VAT Liability", "value": 27003.99, "items": [ { "accountId": "2201", "name": "Purchase Tax Control Account", "value": 12203.64, "items": [] }, { "accountId": "2202", "name": "VAT Liability", "value": 14800.35, "items": [] } ] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 97996.05, "items": [ { "name": "Current Liabilities", "value": 84941.05, "items": [ { "name": "Bank Account", "value": 20091.04, "items": [ { "accountId": "1200", "name": "Bank Current Account", "value": 20091.04, "items": [] } ] }, { "name": "Credit Card (Creditors)", "value": -9358.97, "items": [ { "accountId": "1240", "name": "Company Credit Card", "value": -9358.97, "items": [] } ] }, { "name": "Creditors : Short Term", "value": 44502.68, "items": [ { "accountId": "2100", "name": "Creditors Control Account", "value": 44502.68, "items": [] }, { "accountId": "2109", "name": "Accruals", "value": 0, "items": [] } ] }, { "name": "VAT Liability", "value": 22182.53, "items": [ { "accountId": "2200", "name": "Sales Tax Control Account", "value": 22182.53, "items": [] } ] }, { "name": "Taxation", "value": 7403.77, "items": [ { "accountId": "2210", "name": "P.A.Y.E.", "value": 5396.79, "items": [] }, { "accountId": "2211", "name": "National Insurance", "value": 2006.98, "items": [] } ] }, { "name": "Wages", "value": 120, "items": [ { "accountId": "2220", "name": "Net Wages", "value": 0, "items": [] }, { "accountId": "2230", "name": "Pension Fund", "value": 120, "items": [] } ] } ] }, { "name": "Non-Current Liabilities", "value": 13055, "items": [ { "name": "Creditors : Long Term", "value": 13055, "items": [ { "accountId": "2310", "name": "Hire Purchase", "value": 6160, "items": [] }, { "accountId": "2300", "name": "Loans", "value": 6895, "items": [] } ] } ] } ] }, "netAssets": 141326.64, "equity": { "name": "Equity", "value": 141326.64, "items": [ { "name": "Share Capital", "value": 96332, "items": [ { "accountId": "3000", "name": "Ordinary Shares", "value": 96332, "items": [] } ] }, { "name": "Profit and Loss Account", "value": 44994.64, "items": [] } ] } } ], "mostRecentAvailableMonth": "2023-03-31T00:00:00", "earliestAvailableMonth": "2021-04-01T00:00:00" } }, "Sage Business Cloud Accounting": { "value": { "currency": "GBP", "reports": [ { "date": "2022-10-31T00:00:00", "assets": { "name": "Assets", "value": 1740591.73, "items": [ { "accountId": "9a25937b267a11e797950a57719b2edb", "name": "1200 - Current", "value": 8493.25, "items": [] }, { "accountId": "9a3e4bc6267a11e797950a57719b2edb", "name": "1210 - Cash", "value": 2664.25, "items": [] }, { "accountId": "9a98cf79267a11e797950a57719b2edb", "name": "1 - Assets - Cost", "value": 1302.24, "items": [] }, { "accountId": "9a990bbd267a11e797950a57719b2edb", "name": "30 - Office equipment and IT - Cost", "value": 100, "items": [] }, { "accountId": "9a99117b267a11e797950a57719b2edb", "name": "40 - Fixtures and fittings - Cost", "value": 485, "items": [] }, { "accountId": "9a9915ef267a11e797950a57719b2edb", "name": "50 - Motor Vehicles - Cost", "value": -426.67, "items": [] }, { "accountId": "9a991c56267a11e797950a57719b2edb", "name": "1100 - Trade Debtors", "value": 1425254.88, "items": [] }, { "accountId": "9a991e47267a11e797950a57719b2edb", "name": "1101 - Provision for doubtful debtors", "value": 25, "items": [] }, { "accountId": "7e6c7ed52c2d11e8b45c025132dab352", "name": "1220 - Savings", "value": -155764.91, "items": [] }, { "accountId": "2572c8766afc11e8aaa5027d54329956", "name": "1230 - Tide Current", "value": 509590.44, "items": [] }, { "accountId": "e5889b459f544926ac5b8e6756df2ad4", "name": "1560 - Abdi Internet Bank", "value": 49.61, "items": [] }, { "accountId": "b17083bc9b2748b4ab321b024e260eda", "name": "147852 - Abdi Live Test", "value": -225830.75, "items": [] }, { "accountId": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "12345678 - ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl", "value": 34321.11, "items": [] }, { "accountId": "ae17d64a96a741719f1d31045aa4a8ef", "name": "11113 - bills bank account", "value": 2919.35, "items": [] }, { "accountId": "7c8be6c5e19a40cd92f93e36aecd4156", "name": "12345698 - Abdi Savings", "value": 8949, "items": [] }, { "accountId": "5a64e8ada630412eb8fd1762175b3182", "name": "12345748 - My Test Bank Account", "value": 20438.71, "items": [] }, { "accountId": "8cd0b0b93f0f4c8ba3434bc72d297cc2", "name": "12345758 - AlexT", "value": 1080, "items": [] }, { "accountId": "d340f7af2ba249cbb1c4cf12a6fdae14", "name": "12345768 - AbdiCredit", "value": -40, "items": [] }, { "accountId": "8065f6270c984d6dae78ce817399ac4d", "name": "101010 - Test Push Account", "value": 120, "items": [] }, { "accountId": "b34c43d0f3cd404ead4b282c2163c021", "name": "231 - TestArch12345", "value": -20, "items": [] }, { "accountId": "0f114074c6874794961e6e4b1ab6e4b1", "name": "466 - TestArch321", "value": 0.01, "items": [] }, { "accountId": "fd4573ca207742d7bc8f04481952e53a", "name": "1004 - Card Provider Bank Account", "value": -4, "items": [] }, { "accountId": "90f1a608fcee4bddbc81cce5f6335060", "name": "345678 - Capital on Tap Bank Account CC", "value": -120, "items": [] }, { "accountId": "5e77ffb2faa540a794f2dbd157064556", "name": "12345788 - Mike B Commerce Test Bank Account", "value": 89120.55, "items": [] }, { "accountId": "ad11ee61cdc54d4bb991f4855d9608b0", "name": "12345798 - Current Account 5", "value": 30, "items": [] }, { "accountId": "f8cfa3dd79da436683f1768de75858b0", "name": "12345818 - Maria's Current Account", "value": 1732.13, "items": [] }, { "accountId": "e6717e9019c7456787e9054822772ebb", "name": "12345828 - Joseph Test", "value": 15662, "items": [] }, { "accountId": "495afbea7acb4be38cb5910b8c8db27d", "name": "56743 - Nic Test Bank Account", "value": 13.4, "items": [] }, { "accountId": "f7559ab5cf8a493aa436503bd9712158", "name": "12345858 - Rob Credit Card", "value": -200, "items": [] }, { "accountId": "83fbaf62ee244bebbee822d97b267c55", "name": "12345898 - Joseph (EUR)", "value": 95.09, "items": [] }, { "accountId": "afac9b7c22184fae8f7bc734d880b166", "name": "12345928 - Matt Ager test loan", "value": 10, "items": [] }, { "accountId": "553ed57b302b4eda881b129b6abda736", "name": "12345938 - Matt Ager Test Current Account", "value": 239.77, "items": [] }, { "accountId": "785c9d9f9b954307bd700bede22cf0b5", "name": "12345948 - Matt Ager Test Savings Account", "value": 195, "items": [] }, { "accountId": "3c18fba9e0ba414bb6668bc0668a3090", "name": "12345958 - Matt Ager Test Credit Card", "value": 30, "items": [] }, { "accountId": "a11475c87cd54d0bb81951852ad91035", "name": "12345968 - Matt Ager Test Cash", "value": 290, "items": [] }, { "accountId": "3d067bcf4a4b4a408ef3abaa4d944b91", "name": "12345978 - Matt Ager Test Other Bank Account", "value": 20, "items": [] }, { "accountId": "179e02763960436c903b7ff2708659a2", "name": "12345988 - Matt Ager Test EUR Account", "value": -58.16, "items": [] }, { "accountId": "bb6151d3fd744fa6a81f2164b1d156dc", "name": "13918348 - PUSH 1 Matt Ager Test EUR Account", "value": 9, "items": [] }, { "accountId": "9a207c1a748b45f29117fa7126c12a9e", "name": "13918594 - Australian Current Account", "value": 1.43, "items": [] }, { "accountId": "ab8e9947a5434c848e9a294188664117", "name": "13918604 - Bank Account 70", "value": -70, "items": [] }, { "accountId": "77650bcb6a1d4924be22d6a5da309031", "name": "13918624 - COT GBP Account", "value": -10, "items": [] }, { "accountId": "8be8979ae30c46a6830dc653c9ad4400", "name": "57436 - Capital on Tap Business Credit Card", "value": -105, "items": [] } ] }, "liabilities": { "name": "Liabilities", "value": 173084617.49, "items": [ { "accountId": "9a992290267a11e797950a57719b2edb", "name": "2100 - Trade Creditors", "value": 183778965.2, "items": [] }, { "accountId": "9a992966267a11e797950a57719b2edb", "name": "2200 - VAT on Sales", "value": 57234.67, "items": [] }, { "accountId": "9a992b99267a11e797950a57719b2edb", "name": "2201 - VAT on Purchases", "value": -34745.24, "items": [] }, { "accountId": "9a992d9e267a11e797950a57719b2edb", "name": "2202 - VAT Liability", "value": 256.86, "items": [] }, { "accountId": "9a992fb3267a11e797950a57719b2edb", "name": "2203 - VAT Allocations & Adjustments", "value": -40, "items": [] }, { "accountId": "9a9931b4267a11e797950a57719b2edb", "name": "2205 - VAT on Sales - Holding Account", "value": 199200.59, "items": [] }, { "accountId": "9a9933d1267a11e797950a57719b2edb", "name": "2206 - VAT on Purchases - Holding Account", "value": -10893226.32, "items": [] }, { "accountId": "b954fb00e56447259a9f0cd84dbb6125", "name": "12345 - Pete Bill Account", "value": -6383.05, "items": [] }, { "accountId": "7723dee96cbb435a800c2f7c047f47f3", "name": "312323 - Commerce Prepaid", "value": -12842.93, "items": [] }, { "accountId": "f96e7c899a1c4336bfbfe3d91ff4c157", "name": "121212 - Commerce Prepaid2", "value": -464.36, "items": [] }, { "accountId": "7ed323223f8d4d8f8f737d76e380a254", "name": "987 - Mike B Commerce Prepaid Test Account", "value": -5011.84, "items": [] }, { "accountId": "a2b43df636774b5a92fbfd889e390348", "name": "989 - Mike B Commerce Loan Test Account", "value": 62, "items": [] }, { "accountId": "5cdf52bfb00d4d86b5a01e8af0761fe5", "name": "990 - Mike B Commerce Loan Test Account", "value": 1538.24, "items": [] }, { "accountId": "09f1976c146f40c6b2009b26f1d20f97", "name": "42 - TestDatatypesAccount", "value": 100, "items": [] }, { "accountId": "229eb087d0574c28be42fa4cc89af1f3", "name": "2110 - Trade Creditors", "value": -26.33, "items": [] } ] }, "netAssets": -171344025.76, "equity": { "name": "Equities", "value": -171344025.76, "items": [ { "accountId": "PROFIT-AND-LOSS", "name": "Profit for this period", "value": -171344025.76, "items": [] } ] } }, { "date": "2022-09-30T00:00:00", "assets": { "name": "Assets", "value": 1748139.93, "items": [ { "accountId": "9a25937b267a11e797950a57719b2edb", "name": "1200 - Current", "value": 8493.25, "items": [] }, { "accountId": "9a3e4bc6267a11e797950a57719b2edb", "name": "1210 - Cash", "value": 2664.25, "items": [] }, { "accountId": "9a98cf79267a11e797950a57719b2edb", "name": "1 - Assets - Cost", "value": 1302.24, "items": [] }, { "accountId": "9a990bbd267a11e797950a57719b2edb", "name": "30 - Office equipment and IT - Cost", "value": 100, "items": [] }, { "accountId": "9a99117b267a11e797950a57719b2edb", "name": "40 - Fixtures and fittings - Cost", "value": 485, "items": [] }, { "accountId": "9a9915ef267a11e797950a57719b2edb", "name": "50 - Motor Vehicles - Cost", "value": -426.67, "items": [] }, { "accountId": "9a991c56267a11e797950a57719b2edb", "name": "1100 - Trade Debtors", "value": 1432812.05, "items": [] }, { "accountId": "9a991e47267a11e797950a57719b2edb", "name": "1101 - Provision for doubtful debtors", "value": 25, "items": [] }, { "accountId": "7e6c7ed52c2d11e8b45c025132dab352", "name": "1220 - Savings", "value": -155764.91, "items": [] }, { "accountId": "2572c8766afc11e8aaa5027d54329956", "name": "1230 - Tide Current", "value": 509590.44, "items": [] }, { "accountId": "e5889b459f544926ac5b8e6756df2ad4", "name": "1560 - Abdi Internet Bank", "value": 49.61, "items": [] }, { "accountId": "b17083bc9b2748b4ab321b024e260eda", "name": "147852 - Abdi Live Test", "value": -225830.75, "items": [] }, { "accountId": "92b80ba619d34cafbedd0eb2e69a82f7", "name": "12345678 - ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl", "value": 34321.11, "items": [] }, { "accountId": "ae17d64a96a741719f1d31045aa4a8ef", "name": "11113 - bills bank account", "value": 2919.35, "items": [] }, { "accountId": "7c8be6c5e19a40cd92f93e36aecd4156", "name": "12345698 - Abdi Savings", "value": 8949, "items": [] }, { "accountId": "5a64e8ada630412eb8fd1762175b3182", "name": "12345748 - My Test Bank Account", "value": 20438.74, "items": [] }, { "accountId": "8cd0b0b93f0f4c8ba3434bc72d297cc2", "name": "12345758 - AlexT", "value": 1080, "items": [] }, { "accountId": "d340f7af2ba249cbb1c4cf12a6fdae14", "name": "12345768 - AbdiCredit", "value": -40, "items": [] }, { "accountId": "8065f6270c984d6dae78ce817399ac4d", "name": "101010 - Test Push Account", "value": 120, "items": [] }, { "accountId": "b34c43d0f3cd404ead4b282c2163c021", "name": "231 - TestArch12345", "value": -20, "items": [] }, { "accountId": "0f114074c6874794961e6e4b1ab6e4b1", "name": "466 - TestArch321", "value": 0.01, "items": [] }, { "accountId": "fd4573ca207742d7bc8f04481952e53a", "name": "1004 - Card Provider Bank Account", "value": -4, "items": [] }, { "accountId": "90f1a608fcee4bddbc81cce5f6335060", "name": "345678 - Capital on Tap Bank Account CC", "value": -120, "items": [] }, { "accountId": "5e77ffb2faa540a794f2dbd157064556", "name": "12345788 - Mike B Commerce Test Bank Account", "value": 89120.55, "items": [] }, { "accountId": "ad11ee61cdc54d4bb991f4855d9608b0", "name": "12345798 - Current Account 5", "value": 30, "items": [] }, { "accountId": "f8cfa3dd79da436683f1768de75858b0", "name": "12345818 - Maria's Current Account", "value": 1732.13, "items": [] }, { "accountId": "e6717e9019c7456787e9054822772ebb", "name": "12345828 - Joseph Test", "value": 15662, "items": [] }, { "accountId": "495afbea7acb4be38cb5910b8c8db27d", "name": "56743 - Nic Test Bank Account", "value": 13.4, "items": [] }, { "accountId": "f7559ab5cf8a493aa436503bd9712158", "name": "12345858 - Rob Credit Card", "value": -200, "items": [] }, { "accountId": "83fbaf62ee244bebbee822d97b267c55", "name": "12345898 - Joseph (EUR)", "value": 95.09, "items": [] }, { "accountId": "afac9b7c22184fae8f7bc734d880b166", "name": "12345928 - Matt Ager test loan", "value": 10, "items": [] }, { "accountId": "553ed57b302b4eda881b129b6abda736", "name": "12345938 - Matt Ager Test Current Account", "value": 239.77, "items": [] }, { "accountId": "785c9d9f9b954307bd700bede22cf0b5", "name": "12345948 - Matt Ager Test Savings Account", "value": 195, "items": [] }, { "accountId": "3c18fba9e0ba414bb6668bc0668a3090", "name": "12345958 - Matt Ager Test Credit Card", "value": 30, "items": [] }, { "accountId": "a11475c87cd54d0bb81951852ad91035", "name": "12345968 - Matt Ager Test Cash", "value": 290, "items": [] }, { "accountId": "3d067bcf4a4b4a408ef3abaa4d944b91", "name": "12345978 - Matt Ager Test Other Bank Account", "value": 20, "items": [] }, { "accountId": "179e02763960436c903b7ff2708659a2", "name": "12345988 - Matt Ager Test EUR Account", "value": -58.16, "items": [] }, { "accountId": "9a207c1a748b45f29117fa7126c12a9e", "name": "13918594 - Australian Current Account", "value": 1.43, "items": [] }, { "accountId": "ab8e9947a5434c848e9a294188664117", "name": "13918604 - Bank Account 70", "value": -70, "items": [] }, { "accountId": "77650bcb6a1d4924be22d6a5da309031", "name": "13918624 - COT GBP Account", "value": -10, "items": [] }, { "accountId": "8be8979ae30c46a6830dc653c9ad4400", "name": "57436 - Capital on Tap Business Credit Card", "value": -105, "items": [] } ] }, "liabilities": { "name": "Liabilities", "value": 161482418.52, "items": [ { "accountId": "9a992290267a11e797950a57719b2edb", "name": "2100 - Trade Creditors", "value": 171440565.23, "items": [] }, { "accountId": "9a992966267a11e797950a57719b2edb", "name": "2200 - VAT on Sales", "value": 57232.9, "items": [] }, { "accountId": "9a992b99267a11e797950a57719b2edb", "name": "2201 - VAT on Purchases", "value": -34745.24, "items": [] }, { "accountId": "9a992d9e267a11e797950a57719b2edb", "name": "2202 - VAT Liability", "value": 256.86, "items": [] }, { "accountId": "9a992fb3267a11e797950a57719b2edb", "name": "2203 - VAT Allocations & Adjustments", "value": -40, "items": [] }, { "accountId": "9a9931b4267a11e797950a57719b2edb", "name": "2205 - VAT on Sales - Holding Account", "value": 199003.36, "items": [] }, { "accountId": "9a9933d1267a11e797950a57719b2edb", "name": "2206 - VAT on Purchases - Holding Account", "value": -10156826.32, "items": [] }, { "accountId": "b954fb00e56447259a9f0cd84dbb6125", "name": "12345 - Pete Bill Account", "value": -6383.05, "items": [] }, { "accountId": "7723dee96cbb435a800c2f7c047f47f3", "name": "312323 - Commerce Prepaid", "value": -12842.93, "items": [] }, { "accountId": "f96e7c899a1c4336bfbfe3d91ff4c157", "name": "121212 - Commerce Prepaid2", "value": -464.36, "items": [] }, { "accountId": "7ed323223f8d4d8f8f737d76e380a254", "name": "987 - Mike B Commerce Prepaid Test Account", "value": -5011.84, "items": [] }, { "accountId": "a2b43df636774b5a92fbfd889e390348", "name": "989 - Mike B Commerce Loan Test Account", "value": 62, "items": [] }, { "accountId": "5cdf52bfb00d4d86b5a01e8af0761fe5", "name": "990 - Mike B Commerce Loan Test Account", "value": 1538.24, "items": [] }, { "accountId": "09f1976c146f40c6b2009b26f1d20f97", "name": "42 - TestDatatypesAccount", "value": 100, "items": [] }, { "accountId": "229eb087d0574c28be42fa4cc89af1f3", "name": "2110 - Trade Creditors", "value": -26.33, "items": [] } ] }, "netAssets": -159734278.59, "equity": { "name": "Equities", "value": -159734278.59, "items": [ { "accountId": "PROFIT-AND-LOSS", "name": "Profit for this period", "value": -159734278.59, "items": [] } ] } } ], "mostRecentAvailableMonth": "2022-10-31T00:00:00", "earliestAvailableMonth": "2022-04-01T00:00:00" } }, "Wave": { "value": { "currency": "GBP", "reports": [ { "date": "2022-11-30T00:00:00", "assets": { "name": "Assets", "value": 2220.87, "items": [ { "name": "Cash and Bank", "value": 1001.87, "items": [ { "name": "Abdi Bank", "value": 158.9, "items": [] }, { "name": "Cash on Hand", "value": 245.31, "items": [] }, { "name": "Current Account", "value": 597.66, "items": [] } ] }, { "name": "Other Current Assets", "value": 219, "items": [ { "name": "Accounts Receivable", "value": 211.99, "items": [] }, { "name": "Unrealized Gain on Foreign Exchange", "value": 7.01, "items": [] } ] }, { "name": "Long-term Assets", "value": 1000, "items": [ { "name": "Furniture", "value": 1000, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 4641.15, "items": [ { "name": "Current Liabilities", "value": 4641.15, "items": [ { "name": "Accounts Payable", "value": 3557.14, "items": [] }, { "name": "Abdul's new Tax", "value": 7.54, "items": [] }, { "name": "FederalABC", "value": 1002.6, "items": [] }, { "name": "STANDARD", "value": 73.87, "items": [] } ] } ] }, "netAssets": -2420.28, "equity": { "name": "Equity", "value": -2420.28, "items": [ { "name": "Other Equity", "value": 63.8, "items": [ { "name": "Owner Investment / Drawings", "value": -36.2, "items": [] }, { "name": "Some Equity", "value": 100, "items": [] } ] }, { "name": "Retained Earnings", "value": -2484.08, "items": [ { "name": "Profit for all prior years", "value": -1950.59, "items": [] }, { "name": "Profit between Jan 1, 2022 and Nov 30, 2022", "value": -533.49, "items": [] } ] } ] } }, { "date": "2022-10-31T00:00:00", "assets": { "name": "Assets", "value": 2222.22, "items": [ { "name": "Cash and Bank", "value": 1001.87, "items": [ { "name": "Abdi Bank", "value": 158.9, "items": [] }, { "name": "Cash on Hand", "value": 245.31, "items": [] }, { "name": "Current Account", "value": 597.66, "items": [] } ] }, { "name": "Other Current Assets", "value": 220.35, "items": [ { "name": "Accounts Receivable", "value": 211.99, "items": [] }, { "name": "Unrealized Gain on Foreign Exchange", "value": 8.36, "items": [] } ] }, { "name": "Long-term Assets", "value": 1000, "items": [ { "name": "Furniture", "value": 1000, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 4086.15, "items": [ { "name": "Current Liabilities", "value": 4086.15, "items": [ { "name": "Accounts Payable", "value": 3002.14, "items": [] }, { "name": "Abdul's new Tax", "value": 7.54, "items": [] }, { "name": "FederalABC", "value": 1002.6, "items": [] }, { "name": "STANDARD", "value": 73.87, "items": [] } ] } ] }, "netAssets": -1863.93, "equity": { "name": "Equity", "value": -1863.93, "items": [ { "name": "Other Equity", "value": 63.8, "items": [ { "name": "Owner Investment / Drawings", "value": -36.2, "items": [] }, { "name": "Some Equity", "value": 100, "items": [] } ] }, { "name": "Retained Earnings", "value": -1927.73, "items": [ { "name": "Profit for all prior years", "value": -1950.59, "items": [] }, { "name": "Profit between Jan 1, 2022 and Oct 31, 2022", "value": 22.86, "items": [] } ] } ] } } ], "mostRecentAvailableMonth": "2022-11-30T00:00:00", "earliestAvailableMonth": "2022-05-01T00:00:00" } }, "Xero": { "value": { "currency": "GBP", "reports": [ { "date": "2023-03-31T23:59:59", "assets": { "name": "Assets", "value": 24166.8, "items": [ { "name": "Current Assets", "value": 21486.84, "items": [ { "name": "Bank", "value": 924.25, "items": [ { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account", "value": 924.25, "items": [] } ] }, { "accountId": "a1e2c53a-18b9-40cb-8e87-e2db200fe8af", "name": "Inventory", "value": 121.21, "items": [] }, { "accountId": "8add7c44-ffe0-4a42-869e-b85dadd5eac1", "name": "Accounts Receivable", "value": 20441.38, "items": [] } ] }, { "name": "Fixed Assets", "value": 2679.96, "items": [ { "accountId": "a4602fb6-2e9d-4064-b318-c409032692ba", "name": "Office Equipment", "value": 3665.63, "items": [] }, { "accountId": "8d1ae68b-1251-4b44-9d7a-639b3976935c", "name": "Computer Equipment", "value": -985.67, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 14265.73, "items": [ { "name": "Current Liabilities", "value": 14265.73, "items": [ { "accountId": "b12f79b9-a082-4b8b-971e-d321292943c7", "name": "VAT", "value": 1194.45, "items": [] }, { "accountId": "1873bf00-e52f-48e9-89d6-619c93723f60", "name": "Unpaid Expense Claims", "value": 150.85, "items": [] }, { "accountId": "7ff95c6a-5849-4030-a361-52165fab6490", "name": "Historical Adjustment", "value": 4130.98, "items": [] }, { "accountId": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "name": "Accounts Payable", "value": 8789.45, "items": [] } ] } ] }, "netAssets": 9901.07, "equity": { "name": "Equity", "value": 9901.07, "items": [ { "accountId": "524c9f2d-e680-4861-82f6-4ad171b51de5", "name": "Retained Earnings", "value": -7961.99, "items": [] }, { "accountId": "abababab-abab-abab-abab-abababababab", "name": "Current Year Earnings", "value": 17863.06, "items": [] } ] } }, { "date": "2023-02-28T23:59:59", "assets": { "name": "Assets", "value": 24166.8, "items": [ { "name": "Current Assets", "value": 21486.84, "items": [ { "name": "Bank", "value": 924.25, "items": [ { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account", "value": 924.25, "items": [] } ] }, { "accountId": "a1e2c53a-18b9-40cb-8e87-e2db200fe8af", "name": "Inventory", "value": 121.21, "items": [] }, { "accountId": "8add7c44-ffe0-4a42-869e-b85dadd5eac1", "name": "Accounts Receivable", "value": 20441.38, "items": [] } ] }, { "name": "Fixed Assets", "value": 2679.96, "items": [ { "accountId": "a4602fb6-2e9d-4064-b318-c409032692ba", "name": "Office Equipment", "value": 3665.63, "items": [] }, { "accountId": "8d1ae68b-1251-4b44-9d7a-639b3976935c", "name": "Computer Equipment", "value": -985.67, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 14265.73, "items": [ { "name": "Current Liabilities", "value": 14265.73, "items": [ { "accountId": "b12f79b9-a082-4b8b-971e-d321292943c7", "name": "VAT", "value": 1194.45, "items": [] }, { "accountId": "1873bf00-e52f-48e9-89d6-619c93723f60", "name": "Unpaid Expense Claims", "value": 150.85, "items": [] }, { "accountId": "7ff95c6a-5849-4030-a361-52165fab6490", "name": "Historical Adjustment", "value": 4130.98, "items": [] }, { "accountId": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "name": "Accounts Payable", "value": 8789.45, "items": [] } ] } ] }, "netAssets": 9901.07, "equity": { "name": "Equity", "value": 9901.07, "items": [ { "accountId": "524c9f2d-e680-4861-82f6-4ad171b51de5", "name": "Retained Earnings", "value": -7961.99, "items": [] }, { "accountId": "abababab-abab-abab-abab-abababababab", "name": "Current Year Earnings", "value": 17863.06, "items": [] } ] } } ], "mostRecentAvailableMonth": "2023-03-31T00:00:00", "earliestAvailableMonth": "2022-09-01T00:00:00" } }, "Zoho Books": { "value": { "currency": "GBP", "reports": [ { "date": "2022-10-31T00:00:00", "assets": { "name": "Assets", "value": 63170.61, "items": [ { "name": "Current Assets", "value": 63150.61, "items": [ { "name": "Cash", "value": 1678.31, "items": [ { "accountId": "104957000000000349", "name": "Petty Cash", "value": -8246.75, "items": [] }, { "accountId": "104957000000000346", "name": "Undeposited Funds", "value": 9925.06, "items": [] } ] }, { "name": "Bank", "value": 69910.1, "items": [ { "accountId": "104957000000060010", "name": "Abdi Test", "value": 69858.44, "items": [] }, { "accountId": "104957000000065002", "name": "Abdi Test 2", "value": 20, "items": [] }, { "accountId": "104957000000080006", "name": "EUR Test Bank Account", "value": 24.29, "items": [] }, { "accountId": "104957000000508001", "name": "Subtra USD wallet", "value": 7.37, "items": [] } ] }, { "accountId": "104957000000000352", "name": "Accounts Receivable", "value": -959.64, "items": [] }, { "name": "Other Current Assets", "value": -7478.16, "items": [ { "accountId": "104957000000000358", "name": "Advance Tax", "value": 2.63, "items": [] }, { "accountId": "104957000000000457", "name": "Employee Advance", "value": 0, "items": [] }, { "accountId": "104957000000033015", "name": "Input VAT", "value": 356.84, "items": [] }, { "accountId": "104957000000000511", "name": "Inventory Asset", "value": 90.06, "items": [] }, { "accountId": "104957000000032010", "name": "Prepaid Expenses", "value": -8017.69, "items": [] }, { "accountId": "104957000000388007", "name": "Sales to Customers (Cash)", "value": 0, "items": [] }, { "accountId": "104957000000093001", "name": "Test prepaid expenses child account", "value": 0, "items": [] }, { "accountId": "104957000000096007", "name": "Test prepaid expenses child account 2", "value": 100, "items": [] }, { "accountId": "104957000000096001", "name": "Test prepaid expenses child child account", "value": -50, "items": [] }, { "accountId": "104957000000085001", "name": "Test stock account", "value": 40, "items": [] } ] } ] }, { "name": "Other Assets", "value": 0, "items": [] }, { "name": "Fixed Assets", "value": 20, "items": [ { "accountId": "104957000000000355", "name": "Furniture and Equipment", "value": 20, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 8615.39, "items": [ { "name": "Liabilities", "value": 8615.39, "items": [ { "name": "Current Liabilities", "value": 8615.39, "items": [ { "accountId": "104957000000000361", "name": "Accounts Payable", "value": 2084.6, "items": [] }, { "accountId": "104957000000618001", "name": "Creadit Card - BA Company", "value": 656.05, "items": [] }, { "accountId": "104957000000183010", "name": "Credit Card", "value": 26.25, "items": [] }, { "accountId": "104957000000000460", "name": "Employee Reimbursements", "value": 10.35, "items": [] }, { "accountId": "104957000000000499", "name": "Opening Balance Adjustments", "value": 0, "items": [] }, { "accountId": "104957000000033017", "name": "Output VAT", "value": 3934.75, "items": [] }, { "accountId": "104957000000000501", "name": "Unearned Revenue", "value": 1903.39, "items": [] }, { "accountId": "104957000000054026", "name": "VAT MOSS Payable", "value": 0, "items": [] }, { "accountId": "104957000000000364", "name": "VAT Payable", "value": 0, "items": [] } ] }, { "name": "Long Term Liabilities", "value": 0, "items": [] }, { "name": "Other Liabilities", "value": 0, "items": [ { "accountId": "104957000000006001", "name": "Tag Adjustments", "value": 0, "items": [] } ] } ] } ] }, "netAssets": 54555.22, "equity": { "name": "Equities", "value": 54555.22, "items": [ { "accountId": "", "name": "Current Year Earnings", "value": -15199.89, "items": [] }, { "accountId": "104957000000000451", "name": "Drawing", "value": 0, "items": [] }, { "accountId": "104957000000000373", "name": "Opening Balance Offset", "value": 10000, "items": [] }, { "accountId": "104957000000000370", "name": "Owner's Equity", "value": 0, "items": [] }, { "accountId": "104957000000000367", "name": "Retained Earnings", "value": 59755.11, "items": [] } ] } }, { "date": "2022-09-01T00:00:00", "assets": { "name": "Assets", "value": 63170.61, "items": [ { "name": "Current Assets", "value": 63150.61, "items": [ { "name": "Cash", "value": 1678.31, "items": [ { "accountId": "104957000000000349", "name": "Petty Cash", "value": -8246.75, "items": [] }, { "accountId": "104957000000000346", "name": "Undeposited Funds", "value": 9925.06, "items": [] } ] }, { "name": "Bank", "value": 69910.1, "items": [ { "accountId": "104957000000060010", "name": "Abdi Test", "value": 69858.44, "items": [] }, { "accountId": "104957000000065002", "name": "Abdi Test 2", "value": 20, "items": [] }, { "accountId": "104957000000080006", "name": "EUR Test Bank Account", "value": 24.29, "items": [] }, { "accountId": "104957000000508001", "name": "Subtra USD wallet", "value": 7.37, "items": [] } ] }, { "accountId": "104957000000000352", "name": "Accounts Receivable", "value": -959.64, "items": [] }, { "name": "Other Current Assets", "value": -7478.16, "items": [ { "accountId": "104957000000000358", "name": "Advance Tax", "value": 2.63, "items": [] }, { "accountId": "104957000000000457", "name": "Employee Advance", "value": 0, "items": [] }, { "accountId": "104957000000033015", "name": "Input VAT", "value": 356.84, "items": [] }, { "accountId": "104957000000000511", "name": "Inventory Asset", "value": 90.06, "items": [] }, { "accountId": "104957000000032010", "name": "Prepaid Expenses", "value": -8017.69, "items": [] }, { "accountId": "104957000000388007", "name": "Sales to Customers (Cash)", "value": 0, "items": [] }, { "accountId": "104957000000093001", "name": "Test prepaid expenses child account", "value": 0, "items": [] }, { "accountId": "104957000000096007", "name": "Test prepaid expenses child account 2", "value": 100, "items": [] }, { "accountId": "104957000000096001", "name": "Test prepaid expenses child child account", "value": -50, "items": [] }, { "accountId": "104957000000085001", "name": "Test stock account", "value": 40, "items": [] } ] } ] }, { "name": "Other Assets", "value": 0, "items": [] }, { "name": "Fixed Assets", "value": 20, "items": [ { "accountId": "104957000000000355", "name": "Furniture and Equipment", "value": 20, "items": [] } ] } ] }, "liabilities": { "name": "Liabilities", "value": 8615.39, "items": [ { "name": "Liabilities", "value": 8615.39, "items": [ { "name": "Current Liabilities", "value": 8615.39, "items": [ { "accountId": "104957000000000361", "name": "Accounts Payable", "value": 2084.6, "items": [] }, { "accountId": "104957000000618001", "name": "Creadit Card - BA Company", "value": 656.05, "items": [] }, { "accountId": "104957000000183010", "name": "Credit Card", "value": 26.25, "items": [] }, { "accountId": "104957000000000460", "name": "Employee Reimbursements", "value": 10.35, "items": [] }, { "accountId": "104957000000000499", "name": "Opening Balance Adjustments", "value": 0, "items": [] }, { "accountId": "104957000000033017", "name": "Output VAT", "value": 3934.75, "items": [] }, { "accountId": "104957000000000501", "name": "Unearned Revenue", "value": 1903.39, "items": [] }, { "accountId": "104957000000054026", "name": "VAT MOSS Payable", "value": 0, "items": [] }, { "accountId": "104957000000000364", "name": "VAT Payable", "value": 0, "items": [] } ] }, { "name": "Long Term Liabilities", "value": 0, "items": [] }, { "name": "Other Liabilities", "value": 0, "items": [ { "accountId": "104957000000006001", "name": "Tag Adjustments", "value": 0, "items": [] } ] } ] } ] }, "netAssets": 54555.22, "equity": { "name": "Equities", "value": 54555.22, "items": [ { "accountId": "", "name": "Current Year Earnings", "value": -15199.89, "items": [] }, { "accountId": "104957000000000451", "name": "Drawing", "value": 0, "items": [] }, { "accountId": "104957000000000373", "name": "Opening Balance Offset", "value": 10000, "items": [] }, { "accountId": "104957000000000370", "name": "Owner's Equity", "value": 0, "items": [] }, { "accountId": "104957000000000367", "name": "Retained Earnings", "value": 59755.11, "items": [] } ] } } ], "mostRecentAvailableMonth": "2022-10-31T00:00:00", "earliestAvailableMonth": "2022-04-01T00:00:00" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/data/financials/profitAndLoss": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Reports" ], "summary": "Get profit and loss", "description": "Gets the latest profit and loss for a company.", "operationId": "get-profit-and-loss", "x-speakeasy-name-override": "get-profit-and-loss", "parameters": [ { "$ref": "#/components/parameters/periodLength" }, { "$ref": "#/components/parameters/periodsToCompare" }, { "$ref": "#/components/parameters/startMonth" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfitAndLossReport" }, "examples": { "Clear Books": { "value": { "reports": [ { "fromDate": "2023-03-01T00:00:00", "toDate": "2023-03-31T00:00:00", "income": { "accountId": "", "name": "Income", "value": 146840.42, "items": [ { "accountId": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales", "value": 146840.42, "items": [] } ] }, "costOfSales": { "accountId": "", "name": "Cost of Sales", "value": 29955.45, "items": [ { "accountId": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Purchases", "value": 29955.45, "items": [] } ] }, "grossProfit": 116884.97, "expenses": { "accountId": "", "name": "Expenses", "value": 62407.18, "items": [ { "accountId": "868591ad-f9c2-4956-a5ec-c32c1d48c6f3", "name": "Advertising & Marketing", "value": 24962.87, "items": [] }, { "accountId": "940c8a59-3348-4a0b-a1b1-781d9f29cc8b", "name": "Depreciation Expense", "value": 1550.12, "items": [] }, { "accountId": "e7ac3baa-cfbe-40c1-a172-83d22e84435b", "name": "Entertainment-100% business", "value": 1410.61, "items": [] }, { "accountId": "b5e801e8-8dbc-4390-ac99-3b0fff54a89f", "name": "General Expenses", "value": 1283.66, "items": [] }, { "accountId": "5360066d-1474-49f6-a7a5-c66d5f6032ba", "name": "Light, Power, Heating", "value": 1168.13, "items": [] }, { "accountId": "138a8eb3-5c08-4e59-a3bc-892119694447", "name": "Motor Vehicle Expenses", "value": 944.89, "items": [] }, { "accountId": "1734ff00-2a17-45b4-8db6-2dc2e832c460", "name": "Postage, Freight & Courier", "value": 977.96, "items": [] }, { "accountId": "7aa7988a-ff61-4cb8-bef3-15395355d108", "name": "Printing & Stationery", "value": 889.94, "items": [] }, { "accountId": "9cbe5fe4-ca60-4792-8bf1-de01fb7010aa", "name": "Rent", "value": 8000, "items": [] }, { "accountId": "04f7111b-55d4-4efc-b329-1bd5c791933a", "name": "Repairs & Maintenance", "value": 719.86, "items": [] }, { "accountId": "7d8d0322-f452-47de-a8e8-54b0130e6f38", "name": "Subscriptions", "value": 40, "items": [] }, { "accountId": "043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03", "name": "Telephone & Internet", "value": 45, "items": [] }, { "accountId": "df62060b-41cc-4bf2-9de7-c7e537b5663a", "name": "Travel - National", "value": 6000.46, "items": [] }, { "accountId": "eef78ed1-dfed-447c-bdba-3a49fb2c044b", "name": "Audit & Accountancy fees", "value": 0, "items": [] }, { "accountId": "f3aa84fe-5c31-4107-b207-7e0419f636d7", "name": "Bank Fees", "value": 609.29, "items": [] }, { "accountId": "c16f5c35-8283-47da-9d09-5fecb183b0cb", "name": "Cleaning", "value": 130, "items": [] }, { "accountId": "fb3210ef-edeb-48af-bb49-b85d40c1e6bb", "name": "Corporation Tax", "value": 630.62, "items": [] }, { "accountId": "7f6a0e92-65be-4333-9a0a-d981b03bedd1", "name": "Wages", "value": 12000, "items": [] }, { "accountId": "e8a0a24e-2dab-46b1-bfe1-6e92551c04e8", "name": "Purchase Discounts", "value": 510.1, "items": [] }, { "accountId": "4378ddba-36b4-4b35-9970-bd972b20d137", "name": "Amortization", "value": 5.72, "items": [] }, { "accountId": "78785fd7-f197-4c34-aa17-6e76b9255d34", "name": "Interest Paid (operating)", "value": 527.95, "items": [] } ] }, "netOperatingProfit": 54477.79, "otherExpenses": { "accountId": "", "name": "Other Expenses", "value": 350.44, "items": [ { "accountId": "cbf82e0d-87a7-464d-b567-9274ea94a1c0", "name": "Charitable and Political Donations", "value": 350.44, "items": [] } ] }, "otherIncome": { "accountId": "", "name": "Other Income", "value": 850.22, "items": [ { "accountId": "68794a8f-b22d-4520-b97b-025b7cb10f94", "name": "Other Revenue", "value": 850.22, "items": [] } ] }, "netOtherIncome": 499.78, "netProfit": 54977.57 }, { "fromDate": "2023-02-01T00:00:00", "toDate": "2023-02-28T00:00:00", "income": { "accountId": "", "name": "Income", "value": 108461.81, "items": [ { "accountId": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales", "value": 108461.81, "items": [] } ] }, "costOfSales": { "accountId": "", "name": "Cost of Sales", "value": 18438.51, "items": [ { "accountId": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Purchases", "value": 18438.51, "items": [] } ] }, "grossProfit": 90023.3, "expenses": { "accountId": "", "name": "Expenses", "value": 46096.28, "items": [ { "accountId": "868591ad-f9c2-4956-a5ec-c32c1d48c6f3", "name": "Advertising & Marketing", "value": 18438.51, "items": [] }, { "accountId": "940c8a59-3348-4a0b-a1b1-781d9f29cc8b", "name": "Depreciation Expense", "value": 669.33, "items": [] }, { "accountId": "e7ac3baa-cfbe-40c1-a172-83d22e84435b", "name": "Entertainment-100% business", "value": 609.09, "items": [] }, { "accountId": "b5e801e8-8dbc-4390-ac99-3b0fff54a89f", "name": "General Expenses", "value": 554.28, "items": [] }, { "accountId": "5360066d-1474-49f6-a7a5-c66d5f6032ba", "name": "Light, Power, Heating", "value": 448.35, "items": [] }, { "accountId": "138a8eb3-5c08-4e59-a3bc-892119694447", "name": "Motor Vehicle Expenses", "value": 412.48, "items": [] }, { "accountId": "1734ff00-2a17-45b4-8db6-2dc2e832c460", "name": "Postage, Freight & Courier", "value": 426.92, "items": [] }, { "accountId": "7aa7988a-ff61-4cb8-bef3-15395355d108", "name": "Printing & Stationery", "value": 388.49, "items": [] }, { "accountId": "9cbe5fe4-ca60-4792-8bf1-de01fb7010aa", "name": "Rent", "value": 8000, "items": [] }, { "accountId": "04f7111b-55d4-4efc-b329-1bd5c791933a", "name": "Repairs & Maintenance", "value": 314.25, "items": [] }, { "accountId": "7d8d0322-f452-47de-a8e8-54b0130e6f38", "name": "Subscriptions", "value": 40, "items": [] }, { "accountId": "043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03", "name": "Telephone & Internet", "value": 45, "items": [] }, { "accountId": "df62060b-41cc-4bf2-9de7-c7e537b5663a", "name": "Travel - National", "value": 325.25, "items": [] }, { "accountId": "eef78ed1-dfed-447c-bdba-3a49fb2c044b", "name": "Audit & Accountancy fees", "value": 0, "items": [] }, { "accountId": "f3aa84fe-5c31-4107-b207-7e0419f636d7", "name": "Bank Fees", "value": 2600.97, "items": [] }, { "accountId": "c16f5c35-8283-47da-9d09-5fecb183b0cb", "name": "Cleaning", "value": 130, "items": [] }, { "accountId": "fb3210ef-edeb-48af-bb49-b85d40c1e6bb", "name": "Corporation Tax", "value": 239.41, "items": [] }, { "accountId": "7f6a0e92-65be-4333-9a0a-d981b03bedd1", "name": "Wages", "value": 12000, "items": [] }, { "accountId": "e8a0a24e-2dab-46b1-bfe1-6e92551c04e8", "name": "Purchase Discounts", "value": 220.26, "items": [] }, { "accountId": "4378ddba-36b4-4b35-9970-bd972b20d137", "name": "Amortization", "value": 5.72, "items": [] }, { "accountId": "78785fd7-f197-4c34-aa17-6e76b9255d34", "name": "Interest Paid (operating)", "value": 227.97, "items": [] } ] }, "netOperatingProfit": 43927.02, "otherExpenses": { "accountId": "", "name": "Other Expenses", "value": 350.44, "items": [ { "accountId": "cbf82e0d-87a7-464d-b567-9274ea94a1c0", "name": "Charitable and Political Donations", "value": 350.44, "items": [] } ] }, "otherIncome": { "accountId": "", "name": "Other Income", "value": 850.22, "items": [ { "accountId": "68794a8f-b22d-4520-b97b-025b7cb10f94", "name": "Other Revenue", "value": 850.22, "items": [] } ] }, "netOtherIncome": 499.78, "netProfit": 44426.8 } ], "reportBasis": "Unknown", "currency": "GBP", "mostRecentAvailableMonth": "2023-03-01T00:00:00", "earliestAvailableMonth": "2018-04-01T00:00:00" } }, "Dynamics 365 Business Central": { "value": { "reports": [ { "fromDate": "2023-03-01T00:00:00", "toDate": "2023-03-31T00:00:00", "income": { "name": "Income", "value": 658.5, "items": [ { "name": "Sales Returns & Allowances", "value": 0, "items": [ { "accountId": "8aba49ae-461a-ed11-90eb-000d3a873324", "name": "0121 - ", "value": 0, "items": [] }, { "accountId": "1e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10400 - Sales Returns & Allowances", "value": 0, "items": [] } ] }, { "name": "Income, Services", "value": 0, "items": [ { "accountId": "ac6a3a74-c69f-ec11-80f1-0022481b4546", "name": "10005-1 - Child", "value": 0, "items": [] }, { "accountId": "161217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10100 - Income, Services", "value": 0, "items": [] } ] }, { "name": "Income, Jobs", "value": 0, "items": [ { "accountId": "1f2618f9-c79f-ec11-80f1-0022481b4546", "name": "10005-2 - Child Child", "value": 0, "items": [] }, { "accountId": "1a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10250 - Job Sales", "value": 0, "items": [] } ] }, { "name": "", "value": 0, "items": [ { "accountId": "de1cabee-4a33-ed11-97e8-0022481aa72d", "name": "1005002 - Test account no cat 2", "value": 0, "items": [] }, { "accountId": "b74b0c08-aa59-eb11-89f9-00224800a7ae", "name": "1006 - Account without category Income ", "value": 0, "items": [] }, { "accountId": "023a8eba-c12e-ed11-97e8-000d3a8753f5", "name": "3213 - vdfgdf", "value": 0, "items": [] }, { "accountId": "aa666f5a-c22e-ed11-97e8-0022480052b7", "name": "TEST INCOME A/C - ", "value": 0, "items": [] } ] }, { "name": "Income, Product Sales", "value": 658.5, "items": [ { "accountId": "181217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10200 - Income, Product Sales", "value": 658.5, "items": [] } ] }, { "name": "Sales Discounts", "value": 0, "items": [ { "accountId": "1c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10300 - Sales Discounts", "value": 0, "items": [] } ] }, { "name": "Job Sales Contra", "value": 0, "items": [ { "accountId": "201217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10450 - Job Sales Applied", "value": 0, "items": [] } ] }, { "name": "Income", "value": 0, "items": [ { "accountId": "221217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10500 - Interest Income", "value": 0, "items": [] } ] } ] }, "costOfSales": { "name": "Cost of Goods Sold", "value": 2735.64, "items": [ { "name": "Materials", "value": 2735.64, "items": [ { "accountId": "281217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "20100 - Cost of Materials", "value": 2735.64, "items": [] } ] }, { "name": "Labour", "value": 0, "items": [ { "accountId": "2a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "20200 - Cost of Labour", "value": 0, "items": [] } ] }, { "name": "Jobs Cost", "value": 0, "items": [ { "accountId": "2c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "20300 - Job Costs", "value": 0, "items": [] } ] } ] }, "grossProfit": -2077.14, "expenses": { "name": "Expense", "value": 41.77, "items": [ { "name": "", "value": 0, "items": [ { "accountId": "e9b4e2c2-4b33-ed11-97e8-0022481aa72d", "name": "1005003 - Expense Test account no cat", "value": 0, "items": [] }, { "accountId": "1d60f4a2-6d19-ed11-90eb-002248009024", "name": "1234512345 - Invalid VAT Posting Setup", "value": 0, "items": [] } ] }, { "name": "Interest Expense", "value": 0, "items": [ { "accountId": "bd407350-340b-ec11-86bc-0022481a4971", "name": "1093 - export with misc type", "value": 0, "items": [] }, { "accountId": "381217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30300 - Interest Expense", "value": 0, "items": [] } ] }, { "name": "Other Income & Expenses", "value": 0, "items": [ { "accountId": "2e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "20399 - Job Costs Applied", "value": 0, "items": [] }, { "accountId": "4e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31400 - Office Supplies Expense", "value": 0, "items": [] }, { "accountId": "501217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31500 - Miscellaneous Expense", "value": 0, "items": [] }, { "accountId": "521217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31600 - Depreciation, Equipment", "value": 0, "items": [] }, { "accountId": "541217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31900 - Rounding", "value": 0, "items": [] } ] }, { "name": "Benefits Expense", "value": 0, "items": [ { "accountId": "57a95f12-9ecf-ec11-8e7e-00224800faf5", "name": "23 - test account", "value": 0, "items": [] } ] }, { "name": "Fees Expense", "value": 0, "items": [ { "accountId": "3f6818aa-a4cf-ec11-8e7e-00224800faf5", "name": "30 - test expenses 2", "value": 0, "items": [] }, { "accountId": "3a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30400 - Bank Charges and Fees", "value": 0, "items": [] }, { "accountId": "3c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30500 - Processing Fees", "value": 0, "items": [] } ] }, { "name": "Rent Expense", "value": 0, "items": [ { "accountId": "341217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30100 - Rent Expense", "value": 0, "items": [] } ] }, { "name": "Advertising Expense", "value": 0, "items": [ { "accountId": "361217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30200 - Advertising Expense", "value": 0, "items": [] } ] }, { "name": "Bad Debt Expense", "value": 0, "items": [ { "accountId": "3e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30600 - Bad Debt Expense", "value": 0, "items": [] } ] }, { "name": "Salaries Expense", "value": 0, "items": [ { "accountId": "401217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30700 - Salaries Expense", "value": 0, "items": [] } ] }, { "name": "Payroll Expense", "value": 0, "items": [ { "accountId": "421217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30800 - Payroll Tax Expense", "value": 0, "items": [] }, { "accountId": "441217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30900 - Workers Compensation ", "value": 0, "items": [] } ] }, { "name": "Insurance Expense", "value": 41.77, "items": [ { "accountId": "461217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31000 - Health & Dental Insurance Expense", "value": 41.77, "items": [] }, { "accountId": "481217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31100 - Life Insurance Expense", "value": 0, "items": [] } ] }, { "name": "Repairs and Maintenance Expense", "value": 0, "items": [ { "accountId": "4a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31200 - Repairs and Maintenance Expense", "value": 0, "items": [] } ] }, { "name": "Utilities Expense", "value": 0, "items": [ { "accountId": "4c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31300 - Utilities Expense", "value": 0, "items": [] } ] }, { "name": "Travel Expense", "value": 0, "items": [ { "accountId": "61d17174-61db-ec11-82f9-002248008de8", "name": "999992 - Payhawk General", "value": 0, "items": [] }, { "accountId": "3a37ed38-a6cf-ec11-8e7e-00224800faf5", "name": "999998 - Payhawk General", "value": 0, "items": [] }, { "accountId": "64ee049b-a1cf-ec11-8e7e-00224800faf5", "name": "999999 - Payhawk General", "value": 0, "items": [] } ] } ] }, "netOperatingProfit": -2118.91, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": -2118.91 }, { "fromDate": "2023-02-01T00:00:00", "toDate": "2023-02-28T00:00:00", "income": { "name": "Income", "value": 414.51, "items": [ { "name": "Sales Returns & Allowances", "value": -125.17, "items": [ { "accountId": "8aba49ae-461a-ed11-90eb-000d3a873324", "name": "0121 - ", "value": -125.17, "items": [] }, { "accountId": "1e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10400 - Sales Returns & Allowances", "value": 0, "items": [] } ] }, { "name": "Income, Services", "value": -10, "items": [ { "accountId": "ac6a3a74-c69f-ec11-80f1-0022481b4546", "name": "10005-1 - Child", "value": -10, "items": [] }, { "accountId": "161217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10100 - Income, Services", "value": 0, "items": [] } ] }, { "name": "Income, Jobs", "value": -12.91, "items": [ { "accountId": "1f2618f9-c79f-ec11-80f1-0022481b4546", "name": "10005-2 - Child Child", "value": -12.91, "items": [] }, { "accountId": "1a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10250 - Job Sales", "value": 0, "items": [] } ] }, { "name": "", "value": 0, "items": [ { "accountId": "de1cabee-4a33-ed11-97e8-0022481aa72d", "name": "1005002 - Test account no cat 2", "value": 0, "items": [] }, { "accountId": "b74b0c08-aa59-eb11-89f9-00224800a7ae", "name": "1006 - Account without category Income ", "value": 0, "items": [] }, { "accountId": "023a8eba-c12e-ed11-97e8-000d3a8753f5", "name": "3213 - vdfgdf", "value": 0, "items": [] }, { "accountId": "aa666f5a-c22e-ed11-97e8-0022480052b7", "name": "TEST INCOME A/C - ", "value": 0, "items": [] } ] }, { "name": "Income, Product Sales", "value": 430.4, "items": [ { "accountId": "181217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10200 - Income, Product Sales", "value": 430.4, "items": [] } ] }, { "name": "Sales Discounts", "value": 0, "items": [ { "accountId": "1c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10300 - Sales Discounts", "value": 0, "items": [] } ] }, { "name": "Job Sales Contra", "value": 0, "items": [ { "accountId": "201217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10450 - Job Sales Applied", "value": 0, "items": [] } ] }, { "name": "Income", "value": 132.19, "items": [ { "accountId": "221217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "10500 - Interest Income", "value": 132.19, "items": [] } ] } ] }, "costOfSales": { "name": "Cost of Goods Sold", "value": 328, "items": [ { "name": "Materials", "value": 328, "items": [ { "accountId": "281217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "20100 - Cost of Materials", "value": 328, "items": [] } ] }, { "name": "Labour", "value": 0, "items": [ { "accountId": "2a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "20200 - Cost of Labour", "value": 0, "items": [] } ] }, { "name": "Jobs Cost", "value": 0, "items": [ { "accountId": "2c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "20300 - Job Costs", "value": 0, "items": [] } ] } ] }, "grossProfit": 86.51, "expenses": { "name": "Expense", "value": 1482.02, "items": [ { "name": "", "value": 9.52, "items": [ { "accountId": "e9b4e2c2-4b33-ed11-97e8-0022481aa72d", "name": "1005003 - Expense Test account no cat", "value": 0, "items": [] }, { "accountId": "1d60f4a2-6d19-ed11-90eb-002248009024", "name": "1234512345 - Invalid VAT Posting Setup", "value": 9.52, "items": [] } ] }, { "name": "Interest Expense", "value": 0, "items": [ { "accountId": "bd407350-340b-ec11-86bc-0022481a4971", "name": "1093 - export with misc type", "value": 0, "items": [] }, { "accountId": "381217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30300 - Interest Expense", "value": 0, "items": [] } ] }, { "name": "Other Income & Expenses", "value": 0, "items": [ { "accountId": "2e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "20399 - Job Costs Applied", "value": 0, "items": [] }, { "accountId": "4e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31400 - Office Supplies Expense", "value": 0, "items": [] }, { "accountId": "501217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31500 - Miscellaneous Expense", "value": 0, "items": [] }, { "accountId": "521217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31600 - Depreciation, Equipment", "value": 0, "items": [] }, { "accountId": "541217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31900 - Rounding", "value": 0, "items": [] } ] }, { "name": "Benefits Expense", "value": 0, "items": [ { "accountId": "57a95f12-9ecf-ec11-8e7e-00224800faf5", "name": "23 - test account", "value": 0, "items": [] } ] }, { "name": "Fees Expense", "value": 0, "items": [ { "accountId": "3f6818aa-a4cf-ec11-8e7e-00224800faf5", "name": "30 - test expenses 2", "value": 0, "items": [] }, { "accountId": "3a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30400 - Bank Charges and Fees", "value": 0, "items": [] }, { "accountId": "3c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30500 - Processing Fees", "value": 0, "items": [] } ] }, { "name": "Rent Expense", "value": 0, "items": [ { "accountId": "341217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30100 - Rent Expense", "value": 0, "items": [] } ] }, { "name": "Advertising Expense", "value": 0, "items": [ { "accountId": "361217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30200 - Advertising Expense", "value": 0, "items": [] } ] }, { "name": "Bad Debt Expense", "value": -1.82, "items": [ { "accountId": "3e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30600 - Bad Debt Expense", "value": -1.82, "items": [] } ] }, { "name": "Salaries Expense", "value": 0, "items": [ { "accountId": "401217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30700 - Salaries Expense", "value": 0, "items": [] } ] }, { "name": "Payroll Expense", "value": 0, "items": [ { "accountId": "421217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30800 - Payroll Tax Expense", "value": 0, "items": [] }, { "accountId": "441217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "30900 - Workers Compensation ", "value": 0, "items": [] } ] }, { "name": "Insurance Expense", "value": 1474.32, "items": [ { "accountId": "461217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31000 - Health & Dental Insurance Expense", "value": 1474.32, "items": [] }, { "accountId": "481217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31100 - Life Insurance Expense", "value": 0, "items": [] } ] }, { "name": "Repairs and Maintenance Expense", "value": 0, "items": [ { "accountId": "4a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31200 - Repairs and Maintenance Expense", "value": 0, "items": [] } ] }, { "name": "Utilities Expense", "value": 0, "items": [ { "accountId": "4c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "31300 - Utilities Expense", "value": 0, "items": [] } ] }, { "name": "Travel Expense", "value": 0, "items": [ { "accountId": "61d17174-61db-ec11-82f9-002248008de8", "name": "999992 - Payhawk General", "value": 0, "items": [] }, { "accountId": "3a37ed38-a6cf-ec11-8e7e-00224800faf5", "name": "999998 - Payhawk General", "value": 0, "items": [] }, { "accountId": "64ee049b-a1cf-ec11-8e7e-00224800faf5", "name": "999999 - Payhawk General", "value": 0, "items": [] } ] } ] }, "netOperatingProfit": -1395.51, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": -1395.51 } ], "reportBasis": "Accrual", "currency": "GBP", "mostRecentAvailableMonth": "2023-03-01T00:00:00", "earliestAvailableMonth": "2021-04-01T00:00:00" } }, "Exact (Netherlands)": { "value": { "reports": [ { "fromDate": "2022-09-01T00:00:00Z", "toDate": "2022-09-30T00:00:00Z", "income": { "name": "Income", "value": -286, "items": [ { "accountId": "2421e8a0-5355-4ec0-af11-021fe4f39fcd", "name": "8000 - Omzet binnenland hoog tarief", "value": -286, "items": [] }, { "accountId": "0b5b5d8b-1c0c-4767-88d8-c99206da6ace", "name": "555777 - Sales", "value": 0, "items": [] } ] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": -286, "expenses": { "name": "Expenses", "value": 0, "items": [] }, "netOperatingProfit": -286, "otherExpenses": { "name": "Other Expenses", "value": 5.25, "items": [ { "accountId": "e405eff6-5c15-43b9-a5f0-ba592b26fbbe", "name": "9410 - Inkoopkortingen", "value": 5.25, "items": [] } ] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": -5.25, "netProfit": -291.25 }, { "fromDate": "2022-08-01T00:00:00Z", "toDate": "2022-08-31T00:00:00Z", "income": { "name": "Income", "value": 664.73, "items": [ { "accountId": "2421e8a0-5355-4ec0-af11-021fe4f39fcd", "name": "8000 - Omzet binnenland hoog tarief", "value": 643.33, "items": [] }, { "accountId": "62981769-c358-4ee5-aa8a-c9d5c559dd5c", "name": "9275 - Activa realisatie verlies", "value": -13.6, "items": [] }, { "accountId": "f93008c5-f45b-4200-82a8-d0d5e1584ee7", "name": "1234567 - james_test2", "value": 35, "items": [] } ] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 664.73, "expenses": { "name": "Expenses", "value": 13.6, "items": [ { "accountId": "62981769-c358-4ee5-aa8a-c9d5c559dd5c", "name": "9275 - Activa realisatie verlies", "value": 13.6, "items": [] } ] }, "netOperatingProfit": 651.13, "otherExpenses": { "name": "Other Expenses", "value": 45, "items": [ { "accountId": "e405eff6-5c15-43b9-a5f0-ba592b26fbbe", "name": "9410 - Inkoopkortingen", "value": 45, "items": [] } ] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": -45, "netProfit": 606.13 } ], "reportBasis": "Unknown", "currency": "EUR", "mostRecentAvailableMonth": "2022-09-01T00:00:00", "earliestAvailableMonth": "2020-11-01T00:00:00" } }, "Exact (UK)": { "value": { "reports": [ { "fromDate": "2022-10-01T00:00:00Z", "toDate": "2022-10-31T00:00:00Z", "income": { "name": "Income", "value": -2, "items": [ { "accountId": "43acd218-6a95-445f-994c-660273e0ced9", "name": "41000 - Sales", "value": -2, "items": [] } ] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": -2, "expenses": { "name": "Expenses", "value": 0, "items": [] }, "netOperatingProfit": -2, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": -2 }, { "fromDate": "2022-09-01T00:00:00Z", "toDate": "2022-09-30T00:00:00Z", "income": { "name": "Income", "value": 208, "items": [ { "accountId": "43acd218-6a95-445f-994c-660273e0ced9", "name": "41000 - Sales", "value": 208, "items": [] } ] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 208, "expenses": { "name": "Expenses", "value": 0, "items": [] }, "netOperatingProfit": 208, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 208 } ], "reportBasis": "Unknown", "currency": "GBP", "mostRecentAvailableMonth": "2022-10-01T00:00:00", "earliestAvailableMonth": "2020-11-01T00:00:00" } }, "FreshBooks": { "value": { "reports": [ { "fromDate": "2023-04-01T00:00:00", "toDate": "2023-04-30T00:00:00", "income": { "name": "Income", "value": 0, "items": [] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 0, "items": [] }, "netOperatingProfit": 0, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 0 }, { "fromDate": "2023-03-01T00:00:00", "toDate": "2023-03-31T00:00:00", "income": { "name": "Income", "value": 0, "items": [] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 24.05, "items": [ { "accountId": "3384197", "name": "Advertising", "value": 0.21, "items": [] }, { "accountId": "3380421", "name": "Car & Truck Expenses", "value": 11, "items": [] }, { "accountId": "3361426", "name": "Meals & Entertainment", "value": 12.82, "items": [] }, { "accountId": "3379249", "name": "Supplies", "value": 0.02, "items": [] } ] }, "netOperatingProfit": -24.05, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": -24.04 } ], "reportBasis": "Cash", "currency": "GBP", "mostRecentAvailableMonth": "2023-04-01T00:00:00", "earliestAvailableMonth": "2021-05-01T00:00:00" } }, "KashFlow": { "value": { "reports": [ { "fromDate": "2022-09-01T00:00:00", "toDate": "2022-09-30T00:00:00", "income": { "name": "Income", "value": 0, "items": [] }, "costOfSales": { "name": "Cost Of Sales", "value": 0, "items": [] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 0, "items": [] }, "netOperatingProfit": 0, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 0 }, { "fromDate": "2022-08-01T00:00:00", "toDate": "2022-08-31T00:00:00", "income": { "name": "Income", "value": 0, "items": [] }, "costOfSales": { "name": "Cost Of Sales", "value": 0, "items": [] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 0, "items": [] }, "netOperatingProfit": 0, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 0 } ], "reportBasis": "Unknown", "currency": "GBP", "mostRecentAvailableMonth": "2022-09-01T00:00:00", "earliestAvailableMonth": "2020-10-01T00:00:00" } }, "MYOB AccountRight and Essentials": { "value": { "reports": [ { "fromDate": "2022-11-01T00:00:00", "toDate": "2022-11-30T00:00:00", "income": { "name": "Income", "value": 0, "items": [] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 0, "items": [] }, "netOperatingProfit": 0, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 0 }, { "fromDate": "2022-10-01T00:00:00", "toDate": "2022-10-31T00:00:00", "income": { "name": "Income", "value": 0, "items": [] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 0, "items": [] }, "netOperatingProfit": 0, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 0 } ], "reportBasis": "Accrual", "currency": "GBP", "mostRecentAvailableMonth": "2022-11-01T00:00:00", "earliestAvailableMonth": "2020-12-01T00:00:00" } }, "Oracle NetSuite": { "value": { "reports": [ { "fromDate": "2023-03-01T00:00:00", "toDate": "2023-03-31T00:00:00", "income": { "name": "Income", "value": 0, "items": [] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": -123.45, "items": [ { "accountId": "58", "name": "Expenses", "value": -123.45, "items": [] } ] }, "netOperatingProfit": 123.45, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 123.45 }, { "fromDate": "2023-01-01T00:00:00", "toDate": "2023-01-31T00:00:00", "income": { "name": "Income", "value": 11, "items": [ { "accountId": "108", "name": "Shipping and Handling", "value": 11, "items": [] } ] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 11, "expenses": { "name": "Expenses", "value": 11, "items": [ { "accountId": "58", "name": "Expenses", "value": 11, "items": [] } ] }, "netOperatingProfit": 0, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 0 } ], "reportBasis": "Accrual", "currency": "GBP", "mostRecentAvailableMonth": "2023-03-01T00:00:00", "earliestAvailableMonth": "2022-11-01T00:00:00" } }, "QuickBooks Desktop": { "value": { "reports": [ { "fromDate": "2023-04-01T00:00:00", "toDate": "2023-04-30T00:00:00", "income": { "name": "Income", "value": 7673.5, "items": [ { "accountId": "170000-933270541", "name": "40100 � Construction Income", "value": 7673.5, "items": [ { "accountId": "190000-933270541", "name": "40130 � Labor Income", "value": 840, "items": [] }, { "accountId": "1A0000-933270542", "name": "40140 � Materials Income", "value": 4103.5, "items": [] }, { "accountId": "1C0000-933270542", "name": "40150 � Subcontracted Labor Income", "value": 2730, "items": [] } ] } ] }, "costOfSales": { "name": "Cost of Goods Sold", "value": 1729.85, "items": [ { "accountId": "1E0000-933270542", "name": "50100 � Cost of Goods Sold", "value": 329.85, "items": [] }, { "accountId": "300000-933270542", "name": "54000 � Job Expenses", "value": 1400, "items": [ { "accountId": "340000-933270542", "name": "54500 � Subcontractors", "value": 1400, "items": [] } ] } ] }, "grossProfit": 5943.65, "expenses": { "name": "Expense", "value": 2417.29, "items": [ { "accountId": "1F0000-933270542", "name": "60100 � Automobile", "value": 1066.56, "items": [ { "accountId": "200000-933270542", "name": "60110 � Fuel", "value": 162, "items": [] }, { "accountId": "580000-1071498064", "name": "60120 � Insurance", "value": 712.56, "items": [] }, { "accountId": "210000-933270542", "name": "60130 � Repairs and Maintenance", "value": 192, "items": [] } ] }, { "accountId": "230000-933270542", "name": "60600 � Bank Service Charges", "value": 12.5, "items": [] }, { "accountId": "290000-933270542", "name": "62100 � Insurance", "value": 675, "items": [ { "accountId": "2A0000-933270542", "name": "62110 � Disability Insurance", "value": 50, "items": [] }, { "accountId": "2B0000-933270542", "name": "62120 � Liability Insurance", "value": 350, "items": [] }, { "accountId": "2C0000-933270542", "name": "62130 � Work Comp", "value": 275, "items": [] } ] }, { "accountId": "2D0000-933270542", "name": "62400 � Interest Expense", "value": 438.3, "items": [ { "accountId": "2F0000-933270542", "name": "62420 � Loan Interest", "value": 438.3, "items": [] } ] }, { "accountId": "480000-933270542", "name": "65100 � Utilities", "value": 224.93, "items": [ { "accountId": "490000-933270542", "name": "65110 � Gas and Electric", "value": 120.93, "items": [] }, { "accountId": "4A0000-933270542", "name": "65120 � Telephone", "value": 80, "items": [] }, { "accountId": "4B0000-933270542", "name": "65130 � Water", "value": 24, "items": [] } ] } ] }, "netOperatingProfit": 3526.36, "otherExpenses": { "name": "Other Expense", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 3526.36 }, { "fromDate": "2023-03-01T00:00:00", "toDate": "2023-03-31T00:00:00", "income": { "name": "Income", "value": 16500, "items": [ { "accountId": "170000-933270541", "name": "40100 � Construction Income", "value": 16500, "items": [ { "accountId": "1C0000-933270542", "name": "40150 � Subcontracted Labor Income", "value": 16500, "items": [] } ] } ] }, "costOfSales": { "name": "Cost of Goods Sold", "value": 7500, "items": [ { "accountId": "300000-933270542", "name": "54000 � Job Expenses", "value": 7500, "items": [ { "accountId": "340000-933270542", "name": "54500 � Subcontractors", "value": 7500, "items": [] } ] } ] }, "grossProfit": 9000, "expenses": { "name": "Expense", "value": 3159.99, "items": [ { "accountId": "1F0000-933270542", "name": "60100 � Automobile", "value": 359, "items": [ { "accountId": "200000-933270542", "name": "60110 � Fuel", "value": 127, "items": [] }, { "accountId": "210000-933270542", "name": "60130 � Repairs and Maintenance", "value": 232, "items": [] } ] }, { "accountId": "230000-933270542", "name": "60600 � Bank Service Charges", "value": 12.5, "items": [] }, { "accountId": "290000-933270542", "name": "62100 � Insurance", "value": 675, "items": [ { "accountId": "2A0000-933270542", "name": "62110 � Disability Insurance", "value": 50, "items": [] }, { "accountId": "2B0000-933270542", "name": "62120 � Liability Insurance", "value": 350, "items": [] }, { "accountId": "2C0000-933270542", "name": "62130 � Work Comp", "value": 275, "items": [] } ] }, { "accountId": "2D0000-933270542", "name": "62400 � Interest Expense", "value": 456.29, "items": [ { "accountId": "2F0000-933270542", "name": "62420 � Loan Interest", "value": 456.29, "items": [] } ] }, { "accountId": "3D0000-933270542", "name": "64200 � Repairs", "value": 1164, "items": [ { "accountId": "3F0000-933270542", "name": "64220 � Computer Repairs", "value": 714, "items": [] }, { "accountId": "400000-933270542", "name": "64230 � Equipment Repairs", "value": 450, "items": [] } ] }, { "accountId": "480000-933270542", "name": "65100 � Utilities", "value": 493.2, "items": [ { "accountId": "490000-933270542", "name": "65110 � Gas and Electric", "value": 389.2, "items": [] }, { "accountId": "4A0000-933270542", "name": "65120 � Telephone", "value": 80, "items": [] }, { "accountId": "4B0000-933270542", "name": "65130 � Water", "value": 24, "items": [] } ] } ] }, "netOperatingProfit": 5840.01, "otherExpenses": { "name": "Other Expense", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 93.42, "items": [ { "accountId": "4C0000-933270542", "name": "70200 � Interest Income", "value": 93.42, "items": [] } ] }, "netOtherIncome": 93.42, "netProfit": 5933.43 } ], "reportBasis": "Accrual", "currency": "GBP", "mostRecentAvailableMonth": "2023-04-01T00:00:00", "earliestAvailableMonth": "2021-05-01T00:00:00" } }, "QuickBooks Online Sandbox": { "value": { "reports": [ { "fromDate": "2023-04-01T00:00:00", "toDate": "2023-04-30T00:00:00", "income": { "name": "Income", "value": 35.7, "items": [ { "accountId": "68", "name": "Billable Expenses Income", "value": -15, "items": [] }, { "accountId": "44", "name": "Sales", "value": 130, "items": [] }, { "accountId": "66", "name": "Sales of Product Income", "value": 42.5, "items": [] }, { "accountId": "1", "name": "Services", "value": -131.8, "items": [] }, { "accountId": "149", "name": "Shipping Income", "value": 10, "items": [] } ] }, "costOfSales": { "name": "Cost of Sales", "value": -8.16, "items": [ { "accountId": "67", "name": "Cost of sales", "value": 33.51, "items": [] }, { "accountId": "69", "name": "Cost of Sales - billable expenses", "value": -41.67, "items": [] } ] }, "grossProfit": 43.86, "expenses": { "name": "Expenses", "value": -987, "items": [ { "accountId": "148", "name": "Billable Test", "value": -250, "items": [] }, { "accountId": "16", "name": "Computer and Internet Expenses", "value": -897, "items": [] }, { "accountId": "18", "name": "Depreciation Expense", "value": 100, "items": [] }, { "accountId": "19", "name": "Dues and Subscriptions", "value": -40, "items": [] }, { "accountId": "64", "name": "Purchases", "value": 100, "items": [] } ] }, "netOperatingProfit": 1030.86, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 1030.86 }, { "fromDate": "2023-03-01T00:00:00", "toDate": "2023-03-31T00:00:00", "income": { "name": "Income", "value": 1664.93, "items": [ { "accountId": "14", "name": "Commission Income", "value": 64, "items": [] }, { "accountId": "44", "name": "Sales", "value": 952.29, "items": [] }, { "accountId": "43", "name": "Sales Discounts", "value": 9.05, "items": [] }, { "accountId": "66", "name": "Sales of Product Income", "value": 223.52, "items": [] }, { "accountId": "1", "name": "Services", "value": 392.32, "items": [] }, { "accountId": "149", "name": "Shipping Income", "value": 23.75, "items": [] } ] }, "costOfSales": { "name": "Cost of Sales", "value": 2568.09, "items": [ { "accountId": "67", "name": "Cost of sales", "value": 27.09, "items": [] }, { "accountId": "69", "name": "Cost of Sales - billable expenses", "value": 41, "items": [] }, { "accountId": "10", "name": "Entertainment Booking Fees paid on behalf of clients", "value": 2500, "items": [] } ] }, "grossProfit": -903.16, "expenses": { "name": "Expenses", "value": 397.62, "items": [ { "accountId": "148", "name": "Billable Test", "value": -35.75, "items": [] }, { "accountId": "12", "name": "Business Licenses and Permits", "value": -8, "items": [] }, { "accountId": "16", "name": "Computer and Internet Expenses", "value": 42.46, "items": [] }, { "accountId": "20", "name": "Equipment rental", "value": -22.76, "items": [] }, { "accountId": "116", "name": "HM Revenue & Customs (VAT) Expense", "value": -25.2, "items": [] }, { "accountId": "24", "name": "Insurance Expense", "value": 5.32, "items": [] }, { "accountId": "23", "name": "Insurance Expense-Health Insurance", "value": -34, "items": [] }, { "accountId": "31", "name": "Marketing Expense", "value": -11.56, "items": [] }, { "accountId": "35", "name": "Office Supplies", "value": -12.89, "items": [] }, { "accountId": "64", "name": "Purchases", "value": 500, "items": [] } ] }, "netOperatingProfit": -1300.78, "otherExpenses": { "name": "Other Expenses", "value": 11.92, "items": [ { "accountId": "52", "name": "Exchange Gain or Loss", "value": 11.92, "items": [] } ] }, "otherIncome": { "name": "Other Income", "value": 29.41, "items": [ { "accountId": "21", "name": "Finance Charge Income", "value": -13.44, "items": [] }, { "accountId": "27", "name": "Insurance Proceeds Received", "value": 7.85, "items": [] }, { "accountId": "29", "name": "Interest income", "value": 15, "items": [] }, { "accountId": "39", "name": "Proceeds from Sale of Assets", "value": 20, "items": [] } ] }, "netOtherIncome": 17.49, "netProfit": -1283.29 } ], "reportBasis": "Accrual", "currency": "GBP", "mostRecentAvailableMonth": "2023-04-01T00:00:00", "earliestAvailableMonth": "2021-05-01T00:00:00" } }, "QuickBooks Online": { "value": { "reports": [ { "fromDate": "2023-01-01T00:00:00", "toDate": "2023-01-31T00:00:00", "income": { "name": "Income", "value": 0, "items": [] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 4300, "items": [ { "accountId": "68", "name": "303 HM Revenue & Customs (VAT) Expense", "value": 250, "items": [] }, { "accountId": "22", "name": "408 Travelling expenses", "value": 4050, "items": [] } ] }, "netOperatingProfit": -4300, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": -4300 }, { "fromDate": "2022-12-01T00:00:00", "toDate": "2022-12-31T00:00:00", "income": { "name": "Income", "value": 0, "items": [] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 10, "items": [ { "accountId": "16", "name": "292 Advertising", "value": 10, "items": [] } ] }, "netOperatingProfit": -10, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": -10 } ], "reportBasis": "Accrual", "currency": "GBP", "mostRecentAvailableMonth": "2023-01-01T00:00:00", "earliestAvailableMonth": "2021-02-01T00:00:00" } }, "Sage 200cloud": { "value": { "reports": [ { "fromDate": "2020-12-01T00:00:00Z", "toDate": "2020-12-31T00:00:00Z", "income": { "name": "Income", "value": 0, "items": [ { "name": "Total Sales", "value": 0, "items": [ { "accountId": "101", "name": "Product Sales", "value": 0, "items": [] }, { "accountId": "102", "name": "Export Sales", "value": 0, "items": [] }, { "accountId": "103", "name": "Sales of Assets", "value": 0, "items": [] }, { "accountId": "104", "name": "Credit Charges (Late Payments)", "value": 0, "items": [] }, { "accountId": "105", "name": "Other Sales", "value": 0, "items": [] } ] } ] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [ { "name": "Total Purchases", "value": 0, "items": [ { "accountId": "201", "name": "Purchases", "value": 0, "items": [] }, { "accountId": "202", "name": "Purchase Charges", "value": 0, "items": [] }, { "accountId": "203", "name": "Stock", "value": 0, "items": [] } ] }, { "name": "Total Direct Expenses", "value": 0, "items": [ { "accountId": "301", "name": "Labour", "value": 0, "items": [] }, { "accountId": "302", "name": "Commissions", "value": 0, "items": [] }, { "accountId": "303", "name": "Sales Promotion", "value": 0, "items": [] }, { "accountId": "304", "name": "Miscellaneous Expenses", "value": 0, "items": [] } ] } ] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 0, "items": [ { "name": "Total Overheads", "value": 0, "items": [ { "accountId": "401", "name": "Gross Wages", "value": 0, "items": [] }, { "accountId": "402", "name": "Rent and Rates", "value": 0, "items": [] }, { "accountId": "403", "name": "Heat, Light and Power", "value": 0, "items": [] }, { "accountId": "404", "name": "Motor Expenses", "value": 0, "items": [] }, { "accountId": "405", "name": "Travelling and Entertainment", "value": 0, "items": [] }, { "accountId": "406", "name": "Printing and Stationery", "value": 0, "items": [] }, { "accountId": "407", "name": "Professional Fees", "value": 0, "items": [] }, { "accountId": "408", "name": "Equipment Hire and Rental", "value": 0, "items": [] }, { "accountId": "409", "name": "Maintenance", "value": 0, "items": [] }, { "accountId": "410", "name": "Bank Charges and Interest", "value": 0, "items": [] }, { "accountId": "411", "name": "Depreciation", "value": 0, "items": [] }, { "accountId": "412", "name": "Bad Debts", "value": 0, "items": [] }, { "accountId": "413", "name": "General Expenses", "value": 0, "items": [] }, { "accountId": "414", "name": "Suspense & Mispostings", "value": 0, "items": [] } ] } ] }, "netOperatingProfit": 0, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [ { "accountId": "10,1001", "name": "Taxation", "value": 0, "items": [] } ] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 0 }, { "fromDate": "2020-11-01T00:00:00Z", "toDate": "2020-11-30T00:00:00Z", "income": { "name": "Income", "value": 0, "items": [ { "name": "Total Sales", "value": 0, "items": [ { "accountId": "101", "name": "Product Sales", "value": 0, "items": [] }, { "accountId": "102", "name": "Export Sales", "value": 0, "items": [] }, { "accountId": "103", "name": "Sales of Assets", "value": 0, "items": [] }, { "accountId": "104", "name": "Credit Charges (Late Payments)", "value": 0, "items": [] }, { "accountId": "105", "name": "Other Sales", "value": 0, "items": [] } ] } ] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [ { "name": "Total Purchases", "value": 0, "items": [ { "accountId": "201", "name": "Purchases", "value": 0, "items": [] }, { "accountId": "202", "name": "Purchase Charges", "value": 0, "items": [] }, { "accountId": "203", "name": "Stock", "value": 0, "items": [] } ] }, { "name": "Total Direct Expenses", "value": 0, "items": [ { "accountId": "301", "name": "Labour", "value": 0, "items": [] }, { "accountId": "302", "name": "Commissions", "value": 0, "items": [] }, { "accountId": "303", "name": "Sales Promotion", "value": 0, "items": [] }, { "accountId": "304", "name": "Miscellaneous Expenses", "value": 0, "items": [] } ] } ] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 0, "items": [ { "name": "Total Overheads", "value": 0, "items": [ { "accountId": "401", "name": "Gross Wages", "value": 0, "items": [] }, { "accountId": "402", "name": "Rent and Rates", "value": 0, "items": [] }, { "accountId": "403", "name": "Heat, Light and Power", "value": 0, "items": [] }, { "accountId": "404", "name": "Motor Expenses", "value": 0, "items": [] }, { "accountId": "405", "name": "Travelling and Entertainment", "value": 0, "items": [] }, { "accountId": "406", "name": "Printing and Stationery", "value": 0, "items": [] }, { "accountId": "407", "name": "Professional Fees", "value": 0, "items": [] }, { "accountId": "408", "name": "Equipment Hire and Rental", "value": 0, "items": [] }, { "accountId": "409", "name": "Maintenance", "value": 0, "items": [] }, { "accountId": "410", "name": "Bank Charges and Interest", "value": 0, "items": [] }, { "accountId": "411", "name": "Depreciation", "value": 0, "items": [] }, { "accountId": "412", "name": "Bad Debts", "value": 0, "items": [] }, { "accountId": "413", "name": "General Expenses", "value": 0, "items": [] }, { "accountId": "414", "name": "Suspense & Mispostings", "value": 0, "items": [] } ] } ] }, "netOperatingProfit": 0, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [ { "accountId": "10,1001", "name": "Taxation", "value": 0, "items": [] } ] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 0 } ], "reportBasis": "Accrual", "currency": "GBP", "mostRecentAvailableMonth": "2020-12-01T00:00:00", "earliestAvailableMonth": "2015-01-01T00:00:00" } }, "Sage 50 (UK)": { "value": { "reports": [ { "fromDate": "2023-03-01T00:00:00", "toDate": "2023-03-31T00:00:00", "income": { "name": "Income", "value": 0, "items": [] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 0, "items": [] }, "netOperatingProfit": 0, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 0 }, { "fromDate": "2023-02-01T00:00:00", "toDate": "2023-02-28T00:00:00", "income": { "name": "Income", "value": 0, "items": [] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 0, "items": [] }, "netOperatingProfit": 0, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 0 } ], "reportBasis": "Unknown", "currency": "GBP", "mostRecentAvailableMonth": "2023-03-01T00:00:00", "earliestAvailableMonth": "2021-04-01T00:00:00" } }, "Sage Business Cloud Accounting": { "value": { "reports": [ { "fromDate": "2022-10-01T00:00:00", "toDate": "2022-10-31T00:00:00", "income": { "name": "Income", "value": -7749, "items": [ { "accountId": "9a994b92267a11e797950a57719b2edb", "name": "4000 - Sales Type A", "value": -7740, "items": [] }, { "accountId": "9a994e06267a11e797950a57719b2edb", "name": "4009 - Sales Discounts", "value": -9, "items": [] } ] }, "costOfSales": { "name": "Cost of Sales", "value": 11602000, "items": [ { "accountId": "9a995955267a11e797950a57719b2edb", "name": "5000 - Cost of sales - goods", "value": 11602000, "items": [] } ] }, "grossProfit": -11609749, "expenses": { "name": "Expenses", "value": -1.83, "items": [ { "accountId": "9a99a91c267a11e797950a57719b2edb", "name": "8211 - Exchange rate gain/(loss)", "value": -1.83, "items": [] } ] }, "netOperatingProfit": -11609747.17, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": -11609747.17 }, { "fromDate": "2022-09-01T00:00:00", "toDate": "2022-09-30T00:00:00", "income": { "name": "Income", "value": 501, "items": [ { "accountId": "9a994b92267a11e797950a57719b2edb", "name": "4000 - Sales Type A", "value": 511, "items": [] }, { "accountId": "9a994e06267a11e797950a57719b2edb", "name": "4009 - Sales Discounts", "value": -10, "items": [] } ] }, "costOfSales": { "name": "Cost of Sales", "value": 13220073.7, "items": [ { "accountId": "9a995955267a11e797950a57719b2edb", "name": "5000 - Cost of sales - goods", "value": 13220073.7, "items": [] } ] }, "grossProfit": -13219572.7, "expenses": { "name": "Expenses", "value": 0, "items": [] }, "netOperatingProfit": -13219572.7, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": -148.34, "items": [ { "accountId": "9a995491267a11e797950a57719b2edb", "name": "4900 - Other income", "value": -148.34, "items": [] } ] }, "netOtherIncome": -148.34, "netProfit": -13219721.04 } ], "reportBasis": "Unknown", "currency": "GBP", "mostRecentAvailableMonth": "2022-10-01T00:00:00", "earliestAvailableMonth": "2020-11-01T00:00:00" } }, "Wave": { "value": { "reports": [ { "fromDate": "2022-11-01T00:00:00", "toDate": "2022-11-30T00:00:00", "income": { "name": "Income", "value": 7.01, "items": [ { "name": "Unrealized Gain on Foreign Exchange", "value": 7.01, "items": [] } ] }, "costOfSales": { "name": "Cost of Goods Sold", "value": 0, "items": [] }, "grossProfit": 7.01, "expenses": { "name": "Operating Expenses", "value": 555, "items": [ { "name": "Office Supplies", "value": 555, "items": [] } ] }, "netOperatingProfit": -547.99, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": -547.99 }, { "fromDate": "2022-10-01T00:00:00", "toDate": "2022-10-31T00:00:00", "income": { "name": "Income", "value": 8.36, "items": [ { "name": "Unrealized Gain on Foreign Exchange", "value": 8.36, "items": [] } ] }, "costOfSales": { "name": "Cost of Goods Sold", "value": 0, "items": [] }, "grossProfit": 8.36, "expenses": { "name": "Operating Expenses", "value": 0, "items": [] }, "netOperatingProfit": 8.36, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 8.36 } ], "reportBasis": "Accrual", "currency": "GBP", "mostRecentAvailableMonth": "2022-11-01T00:00:00", "earliestAvailableMonth": "2020-12-01T00:00:00" } }, "Xero": { "value": { "reports": [ { "fromDate": "2023-03-01T00:00:00", "toDate": "2023-03-31T00:00:00", "income": { "name": "Income", "value": 0, "items": [] }, "costOfSales": { "name": "Cost of Sales", "value": 0, "items": [] }, "grossProfit": 0, "expenses": { "name": "Expenses", "value": 0, "items": [] }, "netOperatingProfit": 0, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 0 }, { "fromDate": "2023-02-01T00:00:00", "toDate": "2023-02-28T00:00:00", "income": { "name": "Income", "value": 14496.51, "items": [ { "accountId": "c563b607-fb0e-4d06-9ddb-76fdeef20ae3", "name": "Sales", "value": 14496.51, "items": [] } ] }, "costOfSales": { "name": "Cost of Sales", "value": 700, "items": [ { "accountId": "127f3b99-8dc2-4b7e-854c-91ef9bd2757b", "name": "Purchases", "value": 700, "items": [] } ] }, "grossProfit": 13796.51, "expenses": { "name": "Expenses", "value": 2026.92, "items": [ { "accountId": "f96c9458-d724-47bf-8f74-a9d5726465ce", "name": "General Expenses", "value": 215.87, "items": [] }, { "accountId": "d50842c3-af67-4233-b8c9-df3180f5b7bd", "name": "Light, Power, Heating", "value": 103.43, "items": [] }, { "accountId": "0be1631e-cc7e-4c27-951f-308c3307c0fe", "name": "Motor Vehicle Expenses", "value": 342.79, "items": [] }, { "accountId": "a49cc958-968e-4b54-96d6-8853c036009e", "name": "Postage, Freight & Courier", "value": 94.19, "items": [] }, { "accountId": "cba6527d-f102-4538-b421-e483233e9d5a", "name": "Printing & Stationery", "value": 24.58, "items": [] }, { "accountId": "dae8e236-24bb-4a7a-9787-c5fd89385e03", "name": "Rent", "value": 984.38, "items": [] }, { "accountId": "a40f43e2-c7b0-4187-919a-04ccdc14a630", "name": "Subscriptions", "value": 14.9, "items": [] }, { "accountId": "f3c73c3d-9887-4377-b18b-0374ab62e4aa", "name": "Telephone & Internet", "value": 45.11, "items": [] }, { "accountId": "c7b73345-7f25-428a-bb97-7b20a1470a53", "name": "Travel - National", "value": 201.67, "items": [] } ] }, "netOperatingProfit": 11769.59, "otherExpenses": { "name": "Other Expenses", "value": 0, "items": [] }, "otherIncome": { "name": "Other Income", "value": 0, "items": [] }, "netOtherIncome": 0, "netProfit": 11769.59 } ], "reportBasis": "Accrual", "currency": "GBP", "mostRecentAvailableMonth": "2023-03-01T00:00:00", "earliestAvailableMonth": "2021-04-01T00:00:00" } }, "Zoho Books": { "value": { "reports": [ { "fromDate": "2022-10-01T00:00:00", "toDate": "2022-10-31T00:00:00", "income": { "name": "Operating Income", "value": 0, "items": [ { "accountId": "104957000000000394", "name": "Discount", "value": 0, "items": [] }, { "accountId": "104957000000000379", "name": "General Income", "value": 0, "items": [] }, { "accountId": "104957000000099070", "name": "General Income Child Test", "value": 0, "items": [] }, { "accountId": "104957000000000382", "name": "Interest Income", "value": 0, "items": [] }, { "accountId": "104957000000000385", "name": "Late Fee Income", "value": 0, "items": [] }, { "accountId": "104957000000000503", "name": "Other Charges", "value": 0, "items": [] }, { "accountId": "104957000000000376", "name": "Sales", "value": 0, "items": [] }, { "accountId": "104957000000000506", "name": "Shipping Charge", "value": 0, "items": [] } ] }, "costOfSales": { "name": "Cost of Goods Sold", "value": 0, "items": [ { "accountId": "104957000000000509", "name": "Cost of Goods Sold", "value": 0, "items": [] } ] }, "grossProfit": 0, "expenses": { "name": "Operating Expense", "value": 0, "items": [ { "accountId": "104957000000000391", "name": "Advertising And Marketing", "value": 0, "items": [] }, { "accountId": "104957000000000406", "name": "Air Travel Expense", "value": 0, "items": [] }, { "accountId": "104957000000000412", "name": "Automobile Expense", "value": 0, "items": [] }, { "accountId": "104957000000000427", "name": "Bad Debt", "value": 0, "items": [] }, { "accountId": "104957000000000397", "name": "Bank Fees and Charges", "value": 0, "items": [] }, { "accountId": "104957000000000442", "name": "Consultant Expense", "value": 0, "items": [] }, { "accountId": "104957000000000400", "name": "Credit Card Charges", "value": 0, "items": [] }, { "accountId": "104957000000000439", "name": "Depreciation Expense", "value": 0, "items": [] }, { "accountId": "104957000000243027", "name": "Fuel/Mileage Expenses", "value": 0, "items": [] }, { "accountId": "104957000000000415", "name": "IT and Internet Expenses", "value": 0, "items": [] }, { "accountId": "104957000000000421", "name": "Janitorial Expense", "value": 0, "items": [] }, { "accountId": "104957000000000454", "name": "Lodging", "value": 0, "items": [] }, { "accountId": "104957000000000436", "name": "Meals and Entertainment", "value": 0, "items": [] }, { "accountId": "104957000000000388", "name": "Office Supplies", "value": 0, "items": [] }, { "accountId": "104957000000000448", "name": "Other Expenses", "value": 0, "items": [] }, { "accountId": "104957000000000424", "name": "Postage", "value": 0, "items": [] }, { "accountId": "104957000000000430", "name": "Printing and Stationery", "value": 0, "items": [] }, { "accountId": "104957000000639102", "name": "Purchase Discounts", "value": 0, "items": [] }, { "accountId": "104957000000000418", "name": "Rent Expense", "value": 0, "items": [] }, { "accountId": "104957000000000445", "name": "Repairs and Maintenance", "value": 0, "items": [] }, { "accountId": "104957000000000433", "name": "Salaries and Employee Wages", "value": 0, "items": [] }, { "accountId": "104957000000000409", "name": "Telephone Expense", "value": 0, "items": [] }, { "accountId": "104957000000000463", "name": "Uncategorized", "value": 0, "items": [] } ] }, "netOperatingProfit": 0, "otherExpenses": { "name": "Non Operating Expense", "value": 0, "items": [ { "accountId": "104957000000000403", "name": "Exchange Gain or Loss", "value": 0, "items": [] }, { "accountId": "104957000000099003", "name": "Insurance Expenses (Test Other Expense)", "value": 0, "items": [] } ] }, "otherIncome": { "name": "Non Operating Income", "value": 0, "items": [ { "accountId": "104957000000054032", "name": "Flat Rate Profit", "value": 0, "items": [] }, { "accountId": "104957000000099009", "name": "Interest Earned (Test Other Income)", "value": 0, "items": [] } ] }, "netOtherIncome": 0, "netProfit": 0 }, { "fromDate": "2022-09-01T00:00:00", "toDate": "2022-09-30T00:00:00", "income": { "name": "Operating Income", "value": 69, "items": [ { "accountId": "104957000000000394", "name": "Discount", "value": 0, "items": [] }, { "accountId": "104957000000000379", "name": "General Income", "value": 0, "items": [] }, { "accountId": "104957000000099070", "name": "General Income Child Test", "value": 0, "items": [] }, { "accountId": "104957000000000382", "name": "Interest Income", "value": 0, "items": [] }, { "accountId": "104957000000000385", "name": "Late Fee Income", "value": 0, "items": [] }, { "accountId": "104957000000000503", "name": "Other Charges", "value": 0, "items": [] }, { "accountId": "104957000000000376", "name": "Sales", "value": 69, "items": [] }, { "accountId": "104957000000000506", "name": "Shipping Charge", "value": 0, "items": [] } ] }, "costOfSales": { "name": "Cost of Goods Sold", "value": 35, "items": [ { "accountId": "104957000000000509", "name": "Cost of Goods Sold", "value": 35, "items": [] } ] }, "grossProfit": 34, "expenses": { "name": "Operating Expense", "value": 69, "items": [ { "accountId": "104957000000000391", "name": "Advertising And Marketing", "value": 0, "items": [] }, { "accountId": "104957000000000406", "name": "Air Travel Expense", "value": 0, "items": [] }, { "accountId": "104957000000000412", "name": "Automobile Expense", "value": 0, "items": [] }, { "accountId": "104957000000000427", "name": "Bad Debt", "value": 69, "items": [] }, { "accountId": "104957000000000397", "name": "Bank Fees and Charges", "value": 0, "items": [] }, { "accountId": "104957000000000442", "name": "Consultant Expense", "value": 0, "items": [] }, { "accountId": "104957000000000400", "name": "Credit Card Charges", "value": 0, "items": [] }, { "accountId": "104957000000000439", "name": "Depreciation Expense", "value": 0, "items": [] }, { "accountId": "104957000000243027", "name": "Fuel/Mileage Expenses", "value": 0, "items": [] }, { "accountId": "104957000000000415", "name": "IT and Internet Expenses", "value": 0, "items": [] }, { "accountId": "104957000000000421", "name": "Janitorial Expense", "value": 0, "items": [] }, { "accountId": "104957000000000454", "name": "Lodging", "value": 0, "items": [] }, { "accountId": "104957000000000436", "name": "Meals and Entertainment", "value": 0, "items": [] }, { "accountId": "104957000000000388", "name": "Office Supplies", "value": 0, "items": [] }, { "accountId": "104957000000000448", "name": "Other Expenses", "value": 0, "items": [] }, { "accountId": "104957000000000424", "name": "Postage", "value": 0, "items": [] }, { "accountId": "104957000000000430", "name": "Printing and Stationery", "value": 0, "items": [] }, { "accountId": "104957000000639102", "name": "Purchase Discounts", "value": 0, "items": [] }, { "accountId": "104957000000000418", "name": "Rent Expense", "value": 0, "items": [] }, { "accountId": "104957000000000445", "name": "Repairs and Maintenance", "value": 0, "items": [] }, { "accountId": "104957000000000433", "name": "Salaries and Employee Wages", "value": 0, "items": [] }, { "accountId": "104957000000000409", "name": "Telephone Expense", "value": 0, "items": [] }, { "accountId": "104957000000000463", "name": "Uncategorized", "value": 0, "items": [] } ] }, "netOperatingProfit": -35, "otherExpenses": { "name": "Non Operating Expense", "value": 0, "items": [ { "accountId": "104957000000000403", "name": "Exchange Gain or Loss", "value": 0, "items": [] }, { "accountId": "104957000000099003", "name": "Insurance Expenses (Test Other Expense)", "value": 0, "items": [] } ] }, "otherIncome": { "name": "Non Operating Income", "value": 0, "items": [ { "accountId": "104957000000054032", "name": "Flat Rate Profit", "value": 0, "items": [] }, { "accountId": "104957000000099009", "name": "Interest Earned (Test Other Income)", "value": 0, "items": [] } ] }, "netOtherIncome": 0, "netProfit": -35 } ], "reportBasis": "Accrual", "currency": "GBP", "mostRecentAvailableMonth": "2022-10-01T00:00:00", "earliestAvailableMonth": "2020-11-01T00:00:00" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/data/financials/cashFlowStatement": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Reports" ], "summary": "Get cash flow statement", "description": "Gets the latest cash flow statement for a company.", "operationId": "get-cash-flow-statement", "x-speakeasy-name-override": "get-cash-flow-statement", "parameters": [ { "$ref": "#/components/parameters/periodLength" }, { "$ref": "#/components/parameters/periodsToCompare" }, { "$ref": "#/components/parameters/startMonth" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashFlowStatement" }, "examples": { "Clear Books": { "value": { "reports": [ { "fromDate": "2021-02-01T00:00:00", "toDate": "2021-02-28T00:00:00", "cashReceipts": { "accountId": "cashReceipts", "name": "Cash Receipts", "value": 18377.72, "items": [ { "accountId": "1b6266d1-1e44-46c5-8eb5-a8f98e03124e", "name": "Accounts Receivable", "value": 11417.63, "items": [] }, { "accountId": "72df89d2-512b-4455-af51-a6b563733842", "name": "Income", "value": 6960.09, "items": [] }, { "accountId": "68794a8f-b22d-4520-b97b-025b7cb10f94", "name": "Other Income", "value": 0, "items": [] } ] }, "cashPayments": { "accountId": "cashPayments", "name": "Cash Payments", "value": 12377.81, "items": [ { "accountId": "53bf27a7-7497-4c61-9887-dfaad5c6d80a", "name": "Accounts Payable", "value": 7479.21, "items": [] }, { "accountId": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Cost of Sales", "value": 700, "items": [] }, { "accountId": "e6f7e297-59d6-4bd5-9353-478ee9b39685", "name": "Expenses", "value": 4198.6, "items": [] }, { "accountId": "b5e801e8-8dbc-4390-ac99-3b0fff54a89f", "name": "Other Expenses", "value": 0, "items": [] } ] } }, { "fromDate": "2021-01-01T00:00:00", "toDate": "2021-01-31T00:00:00", "cashReceipts": { "accountId": "cashReceipts", "name": "Cash Receipts", "value": 14508.56, "items": [ { "accountId": "1b6266d1-1e44-46c5-8eb5-a8f98e03124e", "name": "Accounts Receivable", "value": 3055.53, "items": [] }, { "accountId": "72df89d2-512b-4455-af51-a6b563733842", "name": "Income", "value": 11453.03, "items": [] }, { "accountId": "68794a8f-b22d-4520-b97b-025b7cb10f94", "name": "Other Income", "value": 0, "items": [] } ] }, "cashPayments": { "accountId": "cashPayments", "name": "Cash Payments", "value": 18902.85, "items": [ { "accountId": "53bf27a7-7497-4c61-9887-dfaad5c6d80a", "name": "Accounts Payable", "value": 9673.66, "items": [] }, { "accountId": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Cost of Sales", "value": 1250, "items": [] }, { "accountId": "e6f7e297-59d6-4bd5-9353-478ee9b39685", "name": "Expenses", "value": 7979.19, "items": [] }, { "accountId": "b5e801e8-8dbc-4390-ac99-3b0fff54a89f", "name": "Other Expenses", "value": 0, "items": [] } ] } } ], "reportBasis": "Cash", "reportInput": "Direct", "currency": "GBP", "mostRecentAvailableMonth": "2021-02-28T00:00:00", "earliestAvailableMonth": "2019-03-01T00:00:00" } }, "FreshBooks": { "value": { "reports": [ { "fromDate": "2023-04-01T00:00:00", "toDate": "2023-04-30T00:00:00", "cashReceipts": { "accountId": "CashReceipts", "name": "CashReceipts", "value": 0, "items": [] }, "cashPayments": { "accountId": "CashPayments", "name": "CashPayments", "value": 0, "items": [] } }, { "fromDate": "2023-03-01T00:00:00", "toDate": "2023-03-31T00:00:00", "cashReceipts": { "accountId": "CashReceipts", "name": "CashReceipts", "value": 0, "items": [] }, "cashPayments": { "accountId": "CashPayments", "name": "CashPayments", "value": 0, "items": [] } } ], "reportBasis": "Cash", "reportInput": "Indirect", "currency": "GBP", "mostRecentAvailableMonth": "2023-04-30T00:00:00", "earliestAvailableMonth": "2021-05-01T00:00:00" } }, "QuickBooks Online Sandbox": { "value": { "reports": [ { "fromDate": "2023-04-01T00:00:00", "toDate": "2023-04-30T00:00:00", "cashReceipts": { "accountId": "cashReceipts", "name": "Cash Receipts", "value": 754.59, "items": [ { "accountId": "income", "name": "Income", "value": 729.59, "items": [] }, { "accountId": "accountsReceivable", "name": "Accounts Receivable", "value": 25, "items": [] } ] }, "cashPayments": { "accountId": "cashPayments", "name": "Cash Payments", "value": -987.94, "items": [ { "accountId": "costOfSales", "name": "Cost of Sales", "value": 24.06, "items": [] }, { "accountId": "expenses", "name": "Expenses", "value": -1012, "items": [] } ] } }, { "fromDate": "2023-03-01T00:00:00", "toDate": "2023-03-31T00:00:00", "cashReceipts": { "accountId": "cashReceipts", "name": "Cash Receipts", "value": 1776.25, "items": [ { "accountId": "income", "name": "Income", "value": 1652.12, "items": [] }, { "accountId": "accountsReceivable", "name": "Accounts Receivable", "value": 124.13, "items": [] } ] }, "cashPayments": { "accountId": "cashPayments", "name": "Cash Payments", "value": 2494.43, "items": [ { "accountId": "costOfSales", "name": "Cost of Sales", "value": 2562, "items": [] }, { "accountId": "accountsPayable", "name": "Accounts Payable", "value": 38.02, "items": [] }, { "accountId": "expenses", "name": "Expenses", "value": -105.59, "items": [] } ] } } ], "reportBasis": "Cash", "reportInput": "Direct", "currency": "GBP", "mostRecentAvailableMonth": "2023-04-30T00:00:00", "earliestAvailableMonth": "2021-05-01T00:00:00" } }, "QuickBooks Online": { "value": { "reports": [ { "fromDate": "2023-01-01T00:00:00", "toDate": "2023-01-31T00:00:00", "cashReceipts": { "accountId": "cashReceipts", "name": "Cash Receipts", "value": 0, "items": [] }, "cashPayments": { "accountId": "cashPayments", "name": "Cash Payments", "value": 4300, "items": [ { "accountId": "expenses", "name": "Expenses", "value": 4300, "items": [] } ] } }, { "fromDate": "2022-12-01T00:00:00", "toDate": "2022-12-31T00:00:00", "cashReceipts": { "accountId": "cashReceipts", "name": "Cash Receipts", "value": 0, "items": [] }, "cashPayments": { "accountId": "cashPayments", "name": "Cash Payments", "value": 10, "items": [ { "accountId": "expenses", "name": "Expenses", "value": 10, "items": [] } ] } } ], "reportBasis": "Cash", "reportInput": "Direct", "currency": "GBP", "mostRecentAvailableMonth": "2023-01-31T00:00:00", "earliestAvailableMonth": "2021-02-01T00:00:00" } }, "Xero": { "value": { "reports": [ { "fromDate": "2023-03-01T00:00:00", "toDate": "2023-03-31T23:59:59.9999999", "cashReceipts": { "accountId": "cashReceipt", "name": "Cash Receipts", "value": 0, "items": [] }, "cashPayments": { "accountId": "cashPayment", "name": "Cash Payments", "value": 0, "items": [] } }, { "fromDate": "2023-02-01T00:00:00", "toDate": "2023-02-28T23:59:59.9999999", "cashReceipts": { "accountId": "cashReceipt", "name": "Cash Receipts", "value": 0, "items": [] }, "cashPayments": { "accountId": "cashPayment", "name": "Cash Payments", "value": 0, "items": [] } } ], "reportBasis": "Cash", "reportInput": "Direct", "currency": "GBP", "mostRecentAvailableMonth": "2023-03-31T00:00:00", "earliestAvailableMonth": "2021-04-01T00:00:00" } }, "Zoho Books": { "value": { "reports": [ { "fromDate": "2022-10-01T00:00:00", "toDate": "2022-10-31T00:00:00", "cashReceipts": { "accountId": "receipts", "name": "Cash Receipts", "value": 0, "items": [ { "accountId": "income", "name": "Net Income", "value": 0, "items": [] }, { "accountId": "104957000000000352", "name": "Accounts Receivable", "value": 0, "items": [] }, { "accountId": "104957000000000358", "name": "Advance Tax", "value": 0, "items": [] }, { "accountId": "104957000000618001", "name": "Creadit Card - BA Company", "value": 0, "items": [] }, { "accountId": "104957000000183010", "name": "Credit Card", "value": 0, "items": [] }, { "accountId": "104957000000000460", "name": "Employee Reimbursements", "value": 0, "items": [] }, { "accountId": "104957000000033015", "name": "Input VAT", "value": 0, "items": [] }, { "accountId": "104957000000000511", "name": "Inventory Asset", "value": 0, "items": [] }, { "accountId": "104957000000033017", "name": "Output VAT", "value": 0, "items": [] }, { "accountId": "104957000000032010", "name": "Prepaid Expenses", "value": 0, "items": [] }, { "accountId": "104957000000006001", "name": "Tag Adjustments", "value": 0, "items": [] }, { "accountId": "104957000000085001", "name": "Test stock account", "value": 0, "items": [] }, { "accountId": "104957000000000501", "name": "Unearned Revenue", "value": 0, "items": [] } ] }, "cashPayments": { "accountId": "payments", "name": "Cash Payments", "value": 0, "items": [ { "accountId": "104957000000000361", "name": "Accounts Payable", "value": 0, "items": [] } ] } }, { "fromDate": "2022-09-01T00:00:00", "toDate": "2022-09-30T00:00:00", "cashReceipts": { "accountId": "receipts", "name": "Cash Receipts", "value": -5, "items": [ { "accountId": "income", "name": "Net Income", "value": -35, "items": [] }, { "accountId": "104957000000000352", "name": "Accounts Receivable", "value": 30, "items": [] }, { "accountId": "104957000000000358", "name": "Advance Tax", "value": 0, "items": [] }, { "accountId": "104957000000618001", "name": "Creadit Card - BA Company", "value": 0, "items": [] }, { "accountId": "104957000000183010", "name": "Credit Card", "value": 0, "items": [] }, { "accountId": "104957000000000460", "name": "Employee Reimbursements", "value": 0, "items": [] }, { "accountId": "104957000000000511", "name": "Inventory Asset", "value": 0, "items": [] }, { "accountId": "104957000000033017", "name": "Output VAT", "value": 0, "items": [] }, { "accountId": "104957000000032010", "name": "Prepaid Expenses", "value": 0, "items": [] }, { "accountId": "104957000000006001", "name": "Tag Adjustments", "value": 0, "items": [] }, { "accountId": "104957000000085001", "name": "Test stock account", "value": 0, "items": [] }, { "accountId": "104957000000000501", "name": "Unearned Revenue", "value": 0, "items": [] } ] }, "cashPayments": { "accountId": "payments", "name": "Cash Payments", "value": 7, "items": [ { "accountId": "104957000000000361", "name": "Accounts Payable", "value": 0, "items": [] }, { "accountId": "104957000000033015", "name": "Input VAT", "value": 7, "items": [] } ] } } ], "reportBasis": "Accrual", "reportInput": "Indirect", "currency": "GBP", "mostRecentAvailableMonth": "2022-10-31T00:00:00", "earliestAvailableMonth": "2019-11-01T00:00:00" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/data/info": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Company info" ], "summary": "Get company info", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDataset" }, "examples": { "Example 1": { "value": { "companyName": "Codat", "accountingPlatformRef": "1700060034_ETD", "companyLegalName": "Codat Ltd", "addresses": [ { "type": "Billing", "line1": "301 Ink Rooms", "line2": "28 Easton Street", "city": "London", "region": "England", "country": "United Kingdom", "postalCode": "WC1X 0BE" }, { "type": "Delivery", "line1": "28 Easton Street", "city": "London", "country": "UK", "postalCode": "WC1X 0BE" } ], "phoneNumbers": [ { "number": "02012 345678", "type": "Landline" }, { "number": "07123 456789", "type": "Mobile" }, { "number": "02012 345678", "type": "Fax" } ], "webLinks": [ { "type": "Website", "url": "https://www.codat.io/" }, { "type": "Social", "url": "https://www.linkedin.com/company/codat-limited/" } ], "registrationNumber": "5590111724", "taxNumber": "74111622555799035846", "financialYearStartDate": "2023-04-01T00:00:00", "baseCurrency": "GBP", "sourceUrls": { "Api": "https://api.codat.io" }, "createdDate": "2020-03-09T15:19:26" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "Gets the latest basic info for a company.", "operationId": "get-company-info" }, "post": { "tags": [ "Company info" ], "summary": "Refresh company info", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dataset" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "Initiates the process of synchronising basic info for a company", "operationId": "refresh-company-info", "x-speakeasy-name-override": "refresh" } }, "/companies/{companyId}/data/invoices": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Invoices" ], "summary": "List invoices", "description": "The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for a given company's connection.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n \n### Useful queries\n\n- Outstanding invoices - `query = amountDue > 0`\n- Invoices due after a certain date: `query = dueDate > 2021-01-28`\n\n[Read more about querying](https://docs.codat.io/using-the-api/querying).\n\n### Tips and traps\n\nTo access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache.\n", "operationId": "list-invoices", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "2518ca08-5e2a-4630-8cee-a6bcd1625660", "invoiceNumber": "TKj7oD38", "customerRef": { "id": "d65ac505-072c-49ec-be3c-3cb74228966d", "companyName": "Jensen Steuber" }, "salesOrderRefs": [], "issueDate": "2022-04-25T13:04:02", "dueDate": "2022-04-25T13:04:02", "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2023-01-28T14:41:02", "paidOnDate": "2022-04-25T13:04:02", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Heavy Duty Hinged Gully Grating x4.00", "unitAmount": 402.89, "quantity": 4, "subTotal": 1611.56, "taxAmount": 161.16, "totalAmount": 1772.72, "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "3abf0883-03f7-44c6-bc15-1372522d25e1", "name": "Heavy Duty Hinged Gully Grating" }, "trackingCategoryRefs": [ { "id": "costcode_9", "name": "PandaConstruction" } ], "isDirectIncome": true } ], "paymentAllocations": [ { "payment": { "id": "9407d5ee-893a-4547-bd89-bc7b795ee774", "note": "Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660", "reference": "2518ca08-5e2a-4630-8cee-a6bcd1625660", "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-04-25T13:04:02", "totalAmount": 1772.72 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-04-25T13:04:02", "totalAmount": -1772.72 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 1611.56, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 161.16, "totalAmount": 1772.72, "amountDue": 0, "discountPercentage": 0, "status": "Paid", "metadata": { "isDeleted": false } }, { "id": "ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1", "invoiceNumber": "4F6ONfFP", "customerRef": { "id": "a82042f1-a005-4ca5-bfd3-5bc237123aa5", "companyName": "Keara Leffler" }, "salesOrderRefs": [], "issueDate": "2022-04-25T13:04:02", "dueDate": "2022-04-25T13:04:02", "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2022-08-22T07:43:02", "paidOnDate": "2022-04-25T13:04:02", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Heavy Duty Hinged Gully Grating x8.28", "unitAmount": 402.89, "quantity": 8.28, "subTotal": 3335.93, "taxAmount": 333.59, "totalAmount": 3669.52, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "3abf0883-03f7-44c6-bc15-1372522d25e1", "name": "Heavy Duty Hinged Gully Grating" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "7ba4fc1b-e248-49ba-8bf8-0813d7f203a8", "note": "Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1", "reference": "ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1", "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-04-25T13:04:02", "totalAmount": 3669.52 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-04-25T13:04:02", "totalAmount": -3669.52 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 3335.93, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 333.59, "totalAmount": 3669.52, "amountDue": 0, "discountPercentage": 0, "status": "Paid", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 142, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "18c906bf-89d1-ea11-bbaa-000d3a2b9185", "invoiceNumber": "103001", "customerRef": { "id": "b61217b3-89d1-ea11-bbaa-000d3a2b9185", "companyName": "Trey Researches" }, "salesOrderRefs": [], "issueDate": "2019-01-15T00:00:00", "dueDate": "2019-01-15T00:00:00", "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2022-05-17T16:29:00Z", "paidOnDate": "2019-01-15T00:00:00", "currency": "GBP", "lineItems": [ { "description": "AMSTERDAM Lamp", "unitAmount": 35.6, "quantity": 3, "discountAmount": 0, "subTotal": 106.8, "taxAmount": 21.36, "totalAmount": 128.16, "accountRef": { "id": "181217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Income, Product Sales" }, "discountPercentage": 0, "taxRateRef": { "id": "63bc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for DOMESTIC / STANDARD", "effectiveTaxRate": 10 }, "itemRef": { "id": "ITEM-d41217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC", "name": "AMSTERDAM Lamp / General Business Posting Group: 'DOMESTIC' / VAT Business Posting Group: 'DOMESTIC'" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "e0299ced-89d1-ea11-bbaa-000d3a2b9185", "note": "Invoice 102001", "reference": "Document No: 103001", "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2019-01-15T00:00:00", "totalAmount": 128.16 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2019-01-15T00:00:00", "totalAmount": -128.16 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 106.8, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 21.36, "totalAmount": 128.16, "amountDue": 0, "discountPercentage": 0, "status": "Paid", "note": "", "metadata": { "isDeleted": false } }, { "id": "31e97827-bb18-ed11-90eb-000d3a8747a0", "invoiceNumber": "102287", "customerRef": { "id": "0ef95175-48c4-eb11-9f0a-0022481b4343", "companyName": "" }, "salesOrderRefs": [], "issueDate": "2019-01-15T00:00:00", "dueDate": "2019-01-15T00:00:00", "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2022-08-10T14:46:08Z", "currency": "USD", "lineItems": [], "paymentAllocations": [], "withholdingTax": [], "totalDiscount": 0, "subTotal": 0, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 0, "amountDue": 0, "discountPercentage": 0, "status": "Draft", "note": "", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 368, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "91dccc63-b1af-4363-bee0-2aec6bab1bef", "invoiceNumber": "19700002", "customerRef": { "id": "c3bf08a3-4d51-4859-acbb-5075f9484f87", "companyName": "Mr Abe" }, "salesOrderRefs": [], "issueDate": "2019-11-08T00:00:00Z", "dueDate": "2019-11-29T00:00:00Z", "modifiedDate": "2022-10-26T13:57:52Z", "sourceModifiedDate": "2019-11-08T11:56:22Z", "currency": "EUR", "currencyRate": 1, "lineItems": [ { "description": "Consultancy per uur - Consultancy per uur", "unitAmount": 75, "quantity": 8, "discountAmount": 0, "subTotal": 600, "taxAmount": 0, "totalAmount": 600, "accountRef": { "id": "2421e8a0-5355-4ec0-af11-021fe4f39fcd", "name": "Omzet binnenland hoog tarief" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "subTotal": 600, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 600, "amountDue": 599, "discountPercentage": 0, "status": "PartiallyPaid" }, { "id": "0078bc15-10a4-433d-86fa-b1bb235fc0ab", "invoiceNumber": "19700004", "customerRef": { "id": "46951dc4-a170-42ce-bb38-9a80b776404f", "companyName": "Cust 03" }, "salesOrderRefs": [], "issueDate": "2019-11-13T00:00:00Z", "dueDate": "2019-12-04T00:00:00Z", "modifiedDate": "2022-10-26T13:57:52Z", "sourceModifiedDate": "2019-11-13T11:47:51Z", "currency": "EUR", "currencyRate": 1, "lineItems": [ { "description": "Standaard artikel - Standaard artikel", "unitAmount": 25, "quantity": 1, "discountAmount": 0, "subTotal": 25, "taxAmount": 5.25, "totalAmount": 30.25, "accountRef": { "id": "2421e8a0-5355-4ec0-af11-021fe4f39fcd", "name": "Omzet binnenland hoog tarief" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "subTotal": 25, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 5.25, "totalAmount": 30.25, "amountDue": 30.25, "discountPercentage": 0, "status": "Submitted" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 5844, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "a05d1256-f253-46bd-aa13-c6f6a992aa47", "invoiceNumber": "17700002", "customerRef": { "id": "570321bb-8b0c-49f1-a1f5-6fb1d6d94a62", "companyName": "Some customer" }, "salesOrderRefs": [], "issueDate": "2017-08-02T00:00:00Z", "dueDate": "2017-09-01T00:00:00Z", "modifiedDate": "2022-10-26T13:39:08Z", "sourceModifiedDate": "2017-08-02T18:23:43Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "A bunch of stuff - A bunch of stuff", "unitAmount": 100, "quantity": 1000, "discountAmount": 0, "subTotal": 100000, "taxAmount": 0, "totalAmount": 100000, "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "subTotal": 100000, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 100000, "amountDue": 0, "discountPercentage": 0, "status": "Paid" }, { "id": "0981b5d1-a817-40be-a101-4848f7b1a258", "invoiceNumber": "17700004", "customerRef": { "id": "570321bb-8b0c-49f1-a1f5-6fb1d6d94a62", "companyName": "Some customer" }, "salesOrderRefs": [], "issueDate": "2017-08-03T00:00:00Z", "dueDate": "2017-09-02T00:00:00Z", "modifiedDate": "2022-10-26T13:39:08Z", "sourceModifiedDate": "2017-08-03T12:22:27Z", "paidOnDate": "2017-08-03T00:00:00Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "A bunch of stuff - A bunch of stuff", "unitAmount": 100, "quantity": 150, "discountAmount": 0, "subTotal": 15000, "taxAmount": 0, "totalAmount": 15000, "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "subTotal": 15000, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 15000, "amountDue": 0, "discountPercentage": 0, "status": "Paid" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 4214, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "50541736", "invoiceNumber": "2348", "customerRef": { "id": "10123537", "companyName": "_Test 1" }, "salesOrderRefs": [], "issueDate": "2016-12-30T00:00:00", "dueDate": "2016-12-30T00:00:00", "modifiedDate": "2023-04-25T14:19:19Z", "sourceModifiedDate": "2022-10-20T14:28:00Z", "paidOnDate": "2020-11-05T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "3.0 items with VatPercentage of 0.0", "unitAmount": 25.26, "quantity": 1, "discountAmount": 0, "subTotal": 25.26, "taxAmount": 0, "totalAmount": 25.26, "accountRef": { "id": "001", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "3 service charges with 0.0% vat", "unitAmount": 8.85, "quantity": 1, "discountAmount": 0, "subTotal": 8.85, "taxAmount": 0, "totalAmount": 8.85, "accountRef": { "id": "001", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Tax", "unitAmount": 0, "quantity": 1, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "262466203", "note": "E2E Test transaction 2 CREDIT �250.00 - Invoice receipt against 2348", "currency": "GBP", "paidOnDate": "2020-11-05T00:00:00", "totalAmount": 250 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -34.11 } } ], "withholdingTax": [], "subTotal": 34.11, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 34.11, "amountDue": 0, "status": "Paid", "metadata": { "isDeleted": false } }, { "id": "21974783", "invoiceNumber": "023", "customerRef": { "id": "6162023", "companyName": "Alderley plc" }, "salesOrderRefs": [], "issueDate": "2017-01-09T00:00:00", "dueDate": "2017-02-08T00:00:00", "modifiedDate": "2023-04-25T14:19:19Z", "sourceModifiedDate": "2023-02-06T15:31:38Z", "paidOnDate": "2023-02-06T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Laptop", "unitAmount": 500, "quantity": 22, "discountAmount": 0, "subTotal": 11000, "taxAmount": 0, "totalAmount": 11000, "accountRef": { "id": "001", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Tax", "unitAmount": 0, "quantity": 1, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "154350605", "note": "Test Push Transaction OTHER �123.46 - Invoice receipt against 023 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2018-08-26T00:00:00", "totalAmount": 123.46 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -2 } }, { "payment": { "id": "154350605", "note": "Test Push Transaction OTHER �123.46 - Invoice receipt against 023 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2018-08-26T00:00:00", "totalAmount": 123.46 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5 } }, { "payment": { "id": "214509356", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "214338075", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "214327399", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "214327371", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "214672049", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-22T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "214671769", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-22T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "214671495", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-22T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "214671482", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-22T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "214671308", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-22T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "216167014", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "215687795", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "216167064", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-12-02T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "256992092", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "256991833", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "256991177", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "256987893", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "256987069", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "256983353", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "256982947", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "256955690", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "256953648", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "216464177", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "216453277", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "216453273", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "216168092", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "216168080", "note": "�0.01 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2019-11-18T00:00:00", "totalAmount": 0.01 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "260537850", "note": "E2E Test transaction 19 DEBIT �250.00 - E2 E Test Transaction 19 - E2 E Test Transaction 19 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2020-10-23T00:00:00", "totalAmount": 235 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -225 } }, { "payment": { "id": "413909805", "note": "�1.00 - Invoice receipt against 023", "currency": "GBP", "paidOnDate": "2023-02-06T00:00:00", "totalAmount": 1 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -1 } } ], "withholdingTax": [], "subTotal": 11000, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 11000, "amountDue": 10766.74, "status": "PartiallyPaid", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1449, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "2596455", "invoiceNumber": "test-AL", "customerRef": { "id": "602174", "companyName": "ab1" }, "salesOrderRefs": [], "issueDate": "1987-10-01T00:00:00", "dueDate": "1987-10-01T00:00:00", "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2023-03-03T09:27:42", "paidOnDate": "2023-03-03T00:00:00", "currency": "USD", "lineItems": [ { "description": "Editing creative writing for a client", "unitAmount": 222.88, "quantity": 1, "discountAmount": 0, "subTotal": 222.88, "taxAmount": 0, "totalAmount": 222.88, "itemRef": { "id": "639579", "name": "Creative Writing Editorial" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "", "unitAmount": 0, "quantity": 1, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "2570292", "note": "", "currency": "USD", "paidOnDate": "2023-03-03T00:00:00", "totalAmount": 0.17 }, "allocation": { "currency": "USD", "currencyRate": 1, "totalAmount": -0.17 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 222.88, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 222.88, "amountDue": 222.71, "status": "Submitted", "note": "", "metadata": { "isDeleted": false } }, { "id": "2396753", "invoiceNumber": "0000062", "customerRef": { "id": "512927", "companyName": "Wood Turnerss" }, "salesOrderRefs": [], "issueDate": "2016-04-04T00:00:00", "dueDate": "2016-04-04T00:00:00", "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2021-02-24T07:34:31", "currency": "GBP", "lineItems": [], "paymentAllocations": [], "withholdingTax": [], "totalDiscount": 0, "subTotal": 0, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 0, "amountDue": 0, "status": "Submitted", "note": "", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 172, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices?page=2&pageSize=2" } } } }, "KashFlow": { "value": { "results": [ { "id": "143008521", "invoiceNumber": "40", "customerRef": { "id": "86832299", "companyName": "Mr French Person" }, "salesOrderRefs": [], "issueDate": "2005-12-15T00:00:00", "dueDate": "2006-01-12T00:00:00", "modifiedDate": "2022-09-30T10:29:15Z", "currency": "EUR", "currencyRate": 0.844737287, "lineItems": [ { "unitAmount": 0, "quantity": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "accountRef": { "id": "0" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "subTotal": 0, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 0, "amountDue": 0, "status": "Paid" }, { "id": "143008597", "invoiceNumber": "41", "customerRef": { "id": "86832299", "companyName": "Mr French Person" }, "salesOrderRefs": [], "issueDate": "2010-01-01T00:00:00", "dueDate": "2010-01-29T00:00:00", "modifiedDate": "2022-09-30T10:29:15Z", "paidOnDate": "2020-11-03T00:00:00", "currency": "EUR", "currencyRate": 0.844737287, "lineItems": [ { "unitAmount": 0, "quantity": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "accountRef": { "id": "0" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "146438947", "note": "", "currency": "EUR", "paidOnDate": "2020-11-03T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "EUR", "currencyRate": 1, "totalAmount": 0 } } ], "withholdingTax": [], "subTotal": 0, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 0, "amountDue": 0, "status": "Paid" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 37, "_links": { "current": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices" }, "next": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "416", "invoiceNumber": "INV01", "customerRef": { "id": "417", "companyName": "10 Breww Ltd" }, "salesOrderRefs": [], "issueDate": "2021-04-09T00:00:00", "dueDate": "2021-04-30T00:00:00", "modifiedDate": "2022-09-20T08:16:10Z", "sourceModifiedDate": "2021-08-25T15:55:36", "paidOnDate": "2021-04-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Non-Recurring Services - EC", "unitAmount": 100, "quantity": 1, "subTotal": 100, "totalAmount": 100, "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "28", "name": "Non-Recurring Services - EC" }, "trackingCategoryRefs": [ { "id": "location-1" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "428", "reference": "Payment #PYMT01", "accountRef": { "id": "122", "name": "Undeposited Funds" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-04-20T00:00:00", "totalAmount": 90 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10 } }, { "payment": { "id": "428", "reference": "Payment #PYMT01", "accountRef": { "id": "122", "name": "Undeposited Funds" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-04-20T00:00:00", "totalAmount": 90 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -90 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 100, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 100, "amountDue": 0, "status": "Paid" }, { "id": "8529", "invoiceNumber": "INV63", "customerRef": { "id": "417", "companyName": "10 Breww Ltd" }, "salesOrderRefs": [], "issueDate": "2021-04-09T00:00:00", "dueDate": "2021-04-30T00:00:00", "modifiedDate": "2022-09-20T08:16:10Z", "sourceModifiedDate": "2022-02-24T13:51:58", "paidOnDate": "2022-09-12T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Andy Test Item", "unitAmount": 2, "quantity": 3, "subTotal": 6, "totalAmount": 6, "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "143", "name": "Andy Test Item" }, "trackingCategoryRefs": [ { "id": "classification-2" }, { "id": "department-1" }, { "id": "location-1" } ], "isDirectIncome": false }, { "description": "Non-Recurring Services - EC", "unitAmount": 4, "quantity": 5, "subTotal": 20, "totalAmount": 20, "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "28", "name": "Non-Recurring Services - EC" }, "trackingCategoryRefs": [ { "id": "classification-2" }, { "id": "department-1" }, { "id": "location-1" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "17588", "note": "Payment Example - Invoice allocation", "reference": "Payment #PYMT90", "accountRef": { "id": "1", "name": "Cheque Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-06-01T00:00:00", "totalAmount": 10 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10 } }, { "payment": { "id": "17589", "note": "Example - Payment of an invoice", "reference": "Payment #PYMT91", "accountRef": { "id": "1", "name": "Cheque Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-06-01T00:00:00", "totalAmount": 20 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10 } }, { "payment": { "id": "24558", "note": "Test Push Payments - 1 test", "reference": "Payment #PYMT109", "accountRef": { "id": "1", "name": "Cheque Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-09-12T00:00:00", "totalAmount": 0.1 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.1 } }, { "payment": { "id": "24659", "note": "Test Push Payments - 1 test", "reference": "Payment #PYMT111", "accountRef": { "id": "1", "name": "Cheque Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-09-12T00:00:00", "totalAmount": 0.1 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.1 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 26, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 26, "amountDue": 5.8, "status": "PartiallyPaid" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 107, "_links": { "current": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices" }, "next": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "2453-1071526256", "invoiceNumber": "975", "customerRef": { "id": "420000-1071522044", "companyName": "Prentice, Adelaide" }, "salesOrderRefs": [], "issueDate": "2022-11-28T00:00:00", "dueDate": "2023-12-28T00:00:00", "modifiedDate": "2023-04-26T09:08:12Z", "sourceModifiedDate": "2023-12-16T05:06:11", "paidOnDate": "2023-01-15T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Foundation slab - prep and pouring", "unitAmount": 167.5, "quantity": 1, "subTotal": 167.5, "taxAmount": 0, "totalAmount": 167.5, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" }, "itemRef": { "id": "320000-1071525597", "name": "Concrete Slab" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isDirectIncome": false }, { "unitAmount": 0, "quantity": 1, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Rough lumber", "unitAmount": 48, "quantity": 1, "subTotal": 48, "taxAmount": 0, "totalAmount": 48, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "1C0000-933272656", "name": "Lumber:Rough" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isDirectIncome": false }, { "description": "Trim lumber", "unitAmount": 38, "quantity": 1, "subTotal": 38, "taxAmount": 0, "totalAmount": 38, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "1D0000-933272656", "name": "Lumber:Trim" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isDirectIncome": false }, { "description": "Window", "unitAmount": 25, "quantity": 2, "subTotal": 50, "taxAmount": 0, "totalAmount": 50, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "1F0000-933272656", "name": "Window" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isDirectIncome": false }, { "description": "Flooring", "unitAmount": 50, "quantity": 1, "subTotal": 50, "taxAmount": 0, "totalAmount": 50, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "310000-1071509547", "name": "Flooring" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isDirectIncome": false }, { "description": "Window", "unitAmount": 30, "quantity": 2, "subTotal": 60, "taxAmount": 0, "totalAmount": 60, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "1F0000-933272656", "name": "Window" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "6973-1197775625", "note": "Check - 80000-933270541", "reference": "983409", "accountRef": { "id": "80000-933270541", "name": "Undeposited Funds" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-01-15T00:00:00", "totalAmount": 431.95 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -431.95 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 413.5, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 18.45, "totalAmount": 431.95, "amountDue": 0, "discountPercentage": 0, "status": "Paid", "metadata": { "isDeleted": false } }, { "id": "469E-1071530054", "invoiceNumber": "978", "customerRef": { "id": "220000-933272658", "companyName": "Melton, Johnny" }, "salesOrderRefs": [], "issueDate": "2022-11-30T00:00:00", "dueDate": "2023-12-30T00:00:00", "modifiedDate": "2023-04-26T09:08:12Z", "sourceModifiedDate": "2023-12-16T05:06:09", "paidOnDate": "2023-01-10T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "See attached specification for details on work below.", "unitAmount": 0, "quantity": 1, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "unitAmount": 0, "quantity": 1, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "description": "Installation labor", "unitAmount": 45.5, "quantity": 1, "subTotal": 45.5, "taxAmount": 0, "totalAmount": 45.5, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" }, "itemRef": { "id": "20000-933272655", "name": "Installation" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "description": "Install drywall", "unitAmount": 1320, "quantity": 1, "subTotal": 1320, "taxAmount": 0, "totalAmount": 1320, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" }, "itemRef": { "id": "70000-933272656", "name": "Subs:Drywall" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "description": "Electrical work", "unitAmount": 1650, "quantity": 1, "subTotal": 1650, "taxAmount": 0, "totalAmount": 1650, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" }, "itemRef": { "id": "80000-933272656", "name": "Subs:Electrical" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "description": "Metal Work", "unitAmount": 660, "quantity": 1, "subTotal": 660, "taxAmount": 0, "totalAmount": 660, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" }, "itemRef": { "id": "A0000-933272656", "name": "Subs:Metal Wrk" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "description": "Install insulation", "unitAmount": 1100, "quantity": 1, "subTotal": 1100, "taxAmount": 0, "totalAmount": 1100, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" }, "itemRef": { "id": "90000-933272656", "name": "Subs:Insulating" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "description": "Plumbing", "unitAmount": 1650, "quantity": 1, "subTotal": 1650, "taxAmount": 0, "totalAmount": 1650, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" }, "itemRef": { "id": "C0000-933272656", "name": "Subs:Plumbing" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "description": "Painting", "unitAmount": 2420, "quantity": 1, "subTotal": 2420, "taxAmount": 0, "totalAmount": 2420, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" }, "itemRef": { "id": "B0000-933272656", "name": "Subs:Painting" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "description": "Install carpeting", "unitAmount": 3300, "quantity": 1, "subTotal": 3300, "taxAmount": 0, "totalAmount": 3300, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" }, "itemRef": { "id": "60000-933272656", "name": "Subs:Carpet" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "description": "Custom Bay Window", "unitAmount": 1925, "quantity": 1, "subTotal": 1925, "taxAmount": 0, "totalAmount": 1925, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "1F0000-933272656", "name": "Window" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "description": "Window", "unitAmount": 115.5, "quantity": 1, "subTotal": 115.5, "taxAmount": 0, "totalAmount": 115.5, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "1F0000-933272656", "name": "Window" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "description": "Equipment Rental", "unitAmount": 700, "quantity": 1, "subTotal": 700, "taxAmount": 0, "totalAmount": 700, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" }, "itemRef": { "id": "230000-933272656", "name": "Equip Rental" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false }, { "description": "10% retainage to be billed after job is complete and approved.", "unitAmount": -555.5, "quantity": 1, "subTotal": -555.5, "taxAmount": 0, "totalAmount": -555.5, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" }, "itemRef": { "id": "260000-933272656", "name": "Retainage 1" }, "trackingCategoryRefs": [ { "id": "40000-933272658", "name": "Remodel" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "6915-1197775450", "note": "Check - 80000-933270541", "reference": "19650", "accountRef": { "id": "80000-933270541", "name": "Undeposited Funds" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-01-10T00:00:00", "totalAmount": 14488.64 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -14488.64 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 14330.5, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 158.14, "totalAmount": 14488.64, "amountDue": 0, "discountPercentage": 0, "status": "Paid", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 113, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "16", "invoiceNumber": "1001", "customerRef": { "id": "3", "companyName": "Information Sharing Technology" }, "salesOrderRefs": [], "issueDate": "2019-02-18T00:00:00", "dueDate": "2019-03-20T00:00:00", "modifiedDate": "2023-01-18T11:03:02Z", "sourceModifiedDate": "2022-09-20T10:12:08Z", "paidOnDate": "2020-06-01T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Service", "unitAmount": 500, "quantity": 10, "subTotal": 5000, "taxAmount": 0, "totalAmount": 5000, "accountRef": { "id": "1", "name": "Sales" }, "itemRef": { "id": "1", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "500", "note": "Payments of type PrepaidPayment", "reference": "498254", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-20T00:00:00", "totalAmount": 37.77 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -37.77 } }, { "payment": { "id": "507", "note": "Payments of type PrepaidPayment", "reference": "505288", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-20T00:00:00", "totalAmount": 62.82 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -54.62 } }, { "payment": { "id": "499", "note": "Payments of type Cash", "reference": "498147", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-20T00:00:00", "totalAmount": 1017 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5.08 } }, { "payment": { "id": "491", "note": "Payments of type PrepaidPayment", "reference": "489239", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-18T00:00:00", "totalAmount": 48.74 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -48.74 } }, { "payment": { "id": "490", "note": "Payments of type Cash", "reference": "489120", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-18T00:00:00", "totalAmount": 1112.76 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7.74 } }, { "payment": { "id": "482", "note": "Payments of type PrepaidPayment", "reference": "480242", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-17T00:00:00", "totalAmount": 33.9 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -33.9 } }, { "payment": { "id": "481", "note": "Payments of type Cash", "reference": "480129", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-17T00:00:00", "totalAmount": 965.85 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10.21 } }, { "payment": { "id": "470", "note": "Payments of type PrepaidPayment", "reference": "468248", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-13T00:00:00", "totalAmount": 67.83 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -41.38 } }, { "payment": { "id": "463", "note": "Payments of type PrepaidPayment", "reference": "461243", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-13T00:00:00", "totalAmount": 7.47 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7.47 } }, { "payment": { "id": "462", "note": "Payments of type Cash", "reference": "461144", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-13T00:00:00", "totalAmount": 914.05 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -34.76 } }, { "payment": { "id": "456", "note": "Payments of type PrepaidPayment", "reference": "454252", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-11T00:00:00", "totalAmount": 70.44 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -33.72 } }, { "payment": { "id": "447", "note": "Payments of type PrepaidPayment", "reference": "445278", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-11T00:00:00", "totalAmount": 24.95 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -24.95 } }, { "payment": { "id": "446", "note": "Payments of type Cash", "reference": "44518", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-11T00:00:00", "totalAmount": 904.82 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -17.96 } }, { "payment": { "id": "438", "note": "Payments of type PrepaidPayment", "reference": "436234", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-10T00:00:00", "totalAmount": 6.03 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -6.03 } }, { "payment": { "id": "437", "note": "Payments of type Cash", "reference": "436168", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-10T00:00:00", "totalAmount": 760.05 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -31.48 } }, { "payment": { "id": "647", "note": "Payments of type PrepaidPayment", "reference": "645263", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-03-20T00:00:00", "totalAmount": 40.43 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "429", "note": "Payments of type PrepaidPayment", "reference": "427270", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-09T00:00:00", "totalAmount": 56.75 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -28.75 } }, { "payment": { "id": "420", "note": "Payments of type PrepaidPayment", "reference": "418258", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-08T00:00:00", "totalAmount": 8.92 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -8.92 } }, { "payment": { "id": "419", "note": "Payments of type Cash", "reference": "418157", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-08T00:00:00", "totalAmount": 407.2 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -2.55 } }, { "payment": { "id": "705", "note": "Payments of type PrepaidPayment", "reference": "703246", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-04-03T00:00:00", "totalAmount": 25 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -25 } }, { "payment": { "id": "411", "note": "Payments of type PrepaidPayment", "reference": "409292", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-07T00:00:00", "totalAmount": 6.22 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -6.22 } }, { "payment": { "id": "410", "note": "Payments of type Cash", "reference": "409145", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-07T00:00:00", "totalAmount": 725.48 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -33.79 } }, { "payment": { "id": "772", "note": "Payments of type PrepaidPayment", "reference": "770263", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-04-24T00:00:00", "totalAmount": 10.35 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "779", "note": "Payments of type PrepaidPayment", "reference": "777217", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-04-24T00:00:00", "totalAmount": 39.55 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "792", "note": "Payments of type PrepaidPayment", "reference": "790262", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-04-29T00:00:00", "totalAmount": 12.46 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "402", "note": "Payments of type PrepaidPayment", "reference": "400275", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-06T00:00:00", "totalAmount": 32.88 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -29.29 } }, { "payment": { "id": "393", "note": "Payments of type PrepaidPayment", "reference": "391247", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 16.73 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -16.73 } }, { "payment": { "id": "392", "note": "Payments of type Cash", "reference": "391115", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 1094.8 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -47.35 } }, { "payment": { "id": "386", "note": "Payments of type PrepaidPayment", "reference": "384213", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-04T00:00:00", "totalAmount": 9.99 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -9.99 } }, { "payment": { "id": "385", "note": "Payments of type Cash", "reference": "38418", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-04T00:00:00", "totalAmount": 858.41 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -13.4 } }, { "payment": { "id": "377", "note": "Payments of type PrepaidPayment", "reference": "375298", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-03T00:00:00", "totalAmount": 39.06 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -39.06 } }, { "payment": { "id": "376", "note": "Payments of type Cash", "reference": "375123", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-03T00:00:00", "totalAmount": 802.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -11.54 } }, { "payment": { "id": "368", "note": "Payments of type PrepaidPayment", "reference": "366288", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-02T00:00:00", "totalAmount": 12.15 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -12.15 } }, { "payment": { "id": "367", "note": "Payments of type Cash", "reference": "366195", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-02T00:00:00", "totalAmount": 827.2 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -25.4 } }, { "payment": { "id": "361", "note": "Payments of type PrepaidPayment", "reference": "359220", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-01T00:00:00", "totalAmount": 54.12 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -40.61 } }, { "payment": { "id": "349", "note": "Payments of type PrepaidPayment", "reference": "347216", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-31T00:00:00", "totalAmount": 25.32 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -25.32 } }, { "payment": { "id": "348", "note": "Payments of type Cash", "reference": "34710", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-31T00:00:00", "totalAmount": 949.74 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7.07 } }, { "payment": { "id": "342", "note": "Payments of type PrepaidPayment", "reference": "340292", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-30T00:00:00", "totalAmount": 26.59 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -26.59 } }, { "payment": { "id": "341", "note": "Payments of type Cash", "reference": "340128", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-30T00:00:00", "totalAmount": 859.44 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -29.21 } }, { "payment": { "id": "333", "note": "Payments of type PrepaidPayment", "reference": "331236", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-30T00:00:00", "totalAmount": 17.94 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -17.58 } }, { "payment": { "id": "322", "note": "Payments of type PrepaidPayment", "reference": "320256", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-29T00:00:00", "totalAmount": 14.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -14.33 } }, { "payment": { "id": "321", "note": "Payments of type Cash", "reference": "320186", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-29T00:00:00", "totalAmount": 798.79 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -27.08 } }, { "payment": { "id": "313", "note": "Payments of type PrepaidPayment", "reference": "311211", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-29T00:00:00", "totalAmount": 45.06 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -41.47 } }, { "payment": { "id": "304", "note": "Payments of type PrepaidPayment", "reference": "302284", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-28T00:00:00", "totalAmount": 17.04 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -17.04 } }, { "payment": { "id": "303", "note": "Payments of type Cash", "reference": "302128", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-28T00:00:00", "totalAmount": 837.68 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -6.66 } }, { "payment": { "id": "297", "note": "Payments of type PrepaidPayment", "reference": "295264", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-27T00:00:00", "totalAmount": 14.92 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -14.92 } }, { "payment": { "id": "296", "note": "Payments of type Cash", "reference": "295176", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-27T00:00:00", "totalAmount": 687.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -4.18 } }, { "payment": { "id": "288", "note": "Payments of type PrepaidPayment", "reference": "286250", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-26T00:00:00", "totalAmount": 12.73 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -12.73 } }, { "payment": { "id": "287", "note": "Payments of type Cash", "reference": "286188", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-26T00:00:00", "totalAmount": 539.55 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -6.97 } }, { "payment": { "id": "279", "note": "Payments of type PrepaidPayment", "reference": "277281", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-25T00:00:00", "totalAmount": 30.58 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -30.58 } }, { "payment": { "id": "278", "note": "Payments of type Cash", "reference": "277153", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-25T00:00:00", "totalAmount": 1063.48 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -37.08 } }, { "payment": { "id": "270", "note": "Payments of type PrepaidPayment", "reference": "268269", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-24T00:00:00", "totalAmount": 11.69 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -11.69 } }, { "payment": { "id": "269", "note": "Payments of type Cash", "reference": "268154", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-24T00:00:00", "totalAmount": 968.21 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -48.58 } }, { "payment": { "id": "263", "note": "Payments of type PrepaidPayment", "reference": "261215", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-24T00:00:00", "totalAmount": 7.24 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7.24 } }, { "payment": { "id": "262", "note": "Payments of type Cash", "reference": "261162", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-24T00:00:00", "totalAmount": 425.69 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -15.02 } }, { "payment": { "id": "256", "note": "Payments of type PrepaidPayment", "reference": "254258", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-23T00:00:00", "totalAmount": 37.68 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -16.6 } }, { "payment": { "id": "249", "note": "Payments of type PrepaidPayment", "reference": "247245", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-23T00:00:00", "totalAmount": 22.03 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10.84 } }, { "payment": { "id": "240", "note": "Payments of type PrepaidPayment", "reference": "238213", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-23T00:00:00", "totalAmount": 47.7 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -31.98 } }, { "payment": { "id": "231", "note": "Payments of type Prepaid", "reference": "229276", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-23T00:00:00", "totalAmount": 38.7 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -30.52 } }, { "payment": { "id": "218", "note": "Payments of type Prepaid", "reference": "216237", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-22T00:00:00", "totalAmount": 19.67 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -19.67 } }, { "payment": { "id": "217", "note": "Payments of type Cash", "reference": "216161", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-22T00:00:00", "totalAmount": 565.24 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -1.66 } }, { "payment": { "id": "209", "note": "Payments of type Prepaid", "reference": "207254", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-21T00:00:00", "totalAmount": 27.62 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -27.62 } }, { "payment": { "id": "208", "note": "Payments of type Cash", "reference": "207189", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-21T00:00:00", "totalAmount": 914.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7.86 } }, { "payment": { "id": "200", "note": "Payments of type Prepaid", "reference": "198234", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-20T00:00:00", "totalAmount": 18.35 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -18.35 } }, { "payment": { "id": "199", "note": "Payments of type Cash", "reference": "198128", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-20T00:00:00", "totalAmount": 1209.15 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -20.22 } }, { "payment": { "id": "191", "note": "Payments of type Prepaid", "reference": "18922", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-17T00:00:00", "totalAmount": 16.44 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -16.44 } }, { "payment": { "id": "190", "note": "Payments of type Cash", "reference": "189174", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-17T00:00:00", "totalAmount": 607.48 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -13.34 } }, { "payment": { "id": "182", "note": "Payments of type Prepaid", "reference": "180274", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-17T00:00:00", "totalAmount": 47.91 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -47.91 } }, { "payment": { "id": "181", "note": "Payments of type Cash", "reference": "180197", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-17T00:00:00", "totalAmount": 1087.13 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10.04 } }, { "payment": { "id": "173", "note": "Payments of type Prepaid", "reference": "171213", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-15T00:00:00", "totalAmount": 35.36 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -26.29 } }, { "payment": { "id": "166", "note": "Payments of type Prepaid", "reference": "164260", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-15T00:00:00", "totalAmount": 39.98 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -39.98 } }, { "payment": { "id": "165", "note": "Payments of type Cash", "reference": "164142", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-15T00:00:00", "totalAmount": 913.09 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -18.99 } }, { "payment": { "id": "157", "note": "Payments of type Prepaid", "reference": "155266", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-15T00:00:00", "totalAmount": 14.32 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -4.87 } }, { "payment": { "id": "150", "note": "Payments of type Prepaid", "reference": "148217", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-13T00:00:00", "totalAmount": 11.57 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -11.57 } }, { "payment": { "id": "149", "note": "Payments of type Cash", "reference": "148151", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-13T00:00:00", "totalAmount": 643.97 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -22.26 } }, { "payment": { "id": "141", "note": "Payments of type Prepaid", "reference": "139288", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-13T00:00:00", "totalAmount": 27.88 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -27.88 } }, { "payment": { "id": "140", "note": "Payments of type Cash", "reference": "139163", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-13T00:00:00", "totalAmount": 1078.72 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -13.71 } }, { "payment": { "id": "132", "note": "Payments of type Prepaid", "reference": "13022", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-10T00:00:00", "totalAmount": 47.38 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -42.36 } }, { "payment": { "id": "123", "note": "Payments of type Prepaid", "reference": "121293", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-10T00:00:00", "totalAmount": 34.45 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -34.45 } }, { "payment": { "id": "122", "note": "Payments of type Cash", "reference": "121197", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-10T00:00:00", "totalAmount": 771.61 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -16.31 } }, { "payment": { "id": "116", "note": "Payments of type Prepaid", "reference": "114213", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-10T00:00:00", "totalAmount": 65.77 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -23.86 } }, { "payment": { "id": "521", "note": "Payments of type PrepaidPayment", "reference": "519243", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-20T00:00:00", "totalAmount": 14.74 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "843", "note": "Payments of type PrepaidPayment", "reference": "841264", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-05-07T00:00:00", "totalAmount": 25.64 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "850", "note": "Payments of type PrepaidPayment", "reference": "848254", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-05-14T00:00:00", "totalAmount": 53.68 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "877", "note": "Payments of type PrepaidPayment", "reference": "875210", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-06-01T00:00:00", "totalAmount": 12.7 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 5000, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 5000, "amountDue": 3296.44, "status": "PartiallyPaid", "note": "Invoice for service" }, { "id": "17", "invoiceNumber": "1002", "customerRef": { "id": "2", "companyName": "Software Coperation" }, "salesOrderRefs": [], "issueDate": "2019-02-18T00:00:00", "dueDate": "2019-03-20T00:00:00", "modifiedDate": "2023-01-18T11:03:02Z", "sourceModifiedDate": "2019-02-21T17:51:49Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "IT Support", "unitAmount": 80, "quantity": 40, "subTotal": 3200, "taxAmount": 0, "totalAmount": 3200, "accountRef": { "id": "1", "name": "Sales" }, "itemRef": { "id": "2", "name": "Hours" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "totalDiscount": 0, "subTotal": 3200, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 3200, "amountDue": 3200, "status": "Submitted" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1326, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "30", "invoiceNumber": "1002", "customerRef": { "id": "59", "companyName": "Ecker Holiday event" }, "salesOrderRefs": [], "issueDate": "2016-01-06T00:00:00", "dueDate": "2016-02-05T00:00:00", "modifiedDate": "2023-04-26T09:36:12Z", "sourceModifiedDate": "2023-01-25T13:49:52Z", "paidOnDate": "2016-02-12T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Holiday party - gold level test v1", "unitAmount": 2000, "quantity": 1, "subTotal": 2000, "taxAmount": 400, "totalAmount": 2400, "accountRef": { "id": "44", "name": "Sales" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 }, "itemRef": { "id": "7", "name": "Gold party" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Venue rental", "unitAmount": 10000, "quantity": 1, "subTotal": 10000, "taxAmount": 2000, "totalAmount": 12000, "accountRef": { "id": "68", "name": "Billable Expenses Income" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 }, "itemRef": { "id": "20", "name": "Venue Rental" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "promotional items -- misc engraved items", "unitAmount": 13.5, "quantity": 75, "subTotal": 1012.5, "taxAmount": 202.5, "totalAmount": 1215, "accountRef": { "id": "68", "name": "Billable Expenses Income" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 }, "itemRef": { "id": "12", "name": "Misc" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "31", "note": "", "accountRef": { "id": "81", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2016-02-12T00:00:00", "totalAmount": 15615 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -15615 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 13012.5, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 2602.5, "totalAmount": 15615, "amountDue": 0, "status": "Paid", "metadata": { "isDeleted": false } }, { "id": "3793", "invoiceNumber": "276e29c1", "customerRef": { "id": "59", "companyName": "Ecker Holiday event" }, "salesOrderRefs": [], "issueDate": "2016-01-06T00:00:00", "dueDate": "2016-02-05T00:00:00", "modifiedDate": "2023-04-26T09:36:12Z", "sourceModifiedDate": "2022-08-22T13:04:50Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Holiday party - gold level test v1", "unitAmount": 2000, "quantity": 1, "subTotal": 2000, "taxAmount": 400, "totalAmount": 2400, "accountRef": { "id": "44", "name": "Sales" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 }, "itemRef": { "id": "7", "name": "Gold party" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Venue rental", "unitAmount": 10000, "quantity": 1, "subTotal": 10000, "taxAmount": 2000, "totalAmount": 12000, "accountRef": { "id": "68", "name": "Billable Expenses Income" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 }, "itemRef": { "id": "20", "name": "Venue Rental" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "promotional items -- misc engraved items", "unitAmount": 13.5, "quantity": 75, "subTotal": 1012.5, "taxAmount": 202.5, "totalAmount": 1215, "accountRef": { "id": "68", "name": "Billable Expenses Income" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 }, "itemRef": { "id": "12", "name": "Misc" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "totalDiscount": 0, "subTotal": 13012.5, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 2602.5, "totalAmount": 15615, "amountDue": 15615, "status": "Submitted", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1077, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "82322", "invoiceNumber": "0000000110", "customerRef": { "id": "A1D001", "companyName": "A1 Design Services" }, "salesOrderRefs": [], "issueDate": "2020-07-13T00:00:00Z", "dueDate": "2020-08-12T00:00:00Z", "modifiedDate": "2022-10-14T09:36:12Z", "sourceModifiedDate": "2020-07-13T11:06:40Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Tax Summary - Standard rate", "unitAmount": 0, "quantity": 0, "discountAmount": 0.22, "subTotal": 0, "taxAmount": 8.67, "totalAmount": 8.67, "taxRateRef": { "id": "1729", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Goods Summary", "unitAmount": 0, "quantity": 0, "discountAmount": 1.08, "subTotal": 43.34, "taxAmount": 0, "totalAmount": 43.34, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "totalDiscount": 1.3, "subTotal": 43.34, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 8.67, "totalAmount": 52.01, "amountDue": 52.01, "discountPercentage": 2.49, "status": "Submitted", "note": "0000000114" }, { "id": "83515", "invoiceNumber": "0000000111", "customerRef": { "id": "BRO001", "companyName": "Bronson Inc" }, "salesOrderRefs": [], "issueDate": "2020-07-15T00:00:00Z", "dueDate": "2020-08-29T00:00:00Z", "modifiedDate": "2022-10-14T09:36:12Z", "sourceModifiedDate": "2020-07-15T10:45:56Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Tax Summary - Zero rated", "unitAmount": 0, "quantity": 0, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "taxRateRef": { "id": "1728", "name": "Zero rated", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Goods Summary", "unitAmount": 0, "quantity": 0, "discountAmount": 3.13, "subTotal": 125, "taxAmount": 0, "totalAmount": 125, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "totalDiscount": 3.13, "subTotal": 125, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 125, "amountDue": 125, "discountPercentage": 2.5, "status": "Submitted", "note": "0000000111" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 409, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "INV-1", "invoiceNumber": "1", "customerRef": { "id": "A1D001", "companyName": "A1 Design Services" }, "salesOrderRefs": [], "issueDate": "2021-01-02T00:00:00", "modifiedDate": "2023-03-30T14:42:42Z", "sourceModifiedDate": "2022-11-25T09:43:54", "paidOnDate": "2022-01-29T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "AT Mini Tower Case", "unitAmount": 14.25, "quantity": 1, "discountAmount": 0, "subTotal": 14.25, "taxAmount": 2.43, "totalAmount": 16.68, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Whiteboard - Drywipe (900 x 1200)", "unitAmount": 19, "quantity": 4, "discountAmount": 0, "subTotal": 76, "taxAmount": 12.97, "totalAmount": 88.97, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "A4 Ledger Book - 5 Column", "unitAmount": 7.59, "quantity": 8, "discountAmount": 0, "subTotal": 60.72, "taxAmount": 10.36, "totalAmount": 71.08, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Shorthand Notebook - 80 Sheets", "unitAmount": 4.27, "quantity": 20, "discountAmount": 0, "subTotal": 85.4, "taxAmount": 14.57, "totalAmount": 99.97, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Calculator - Desktop", "unitAmount": 9.5, "quantity": 1, "discountAmount": 0, "subTotal": 9.5, "taxAmount": 1.62, "totalAmount": 11.12, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Calculator - Desktop (Printing)", "unitAmount": 16.15, "quantity": 1, "discountAmount": 0, "subTotal": 16.15, "taxAmount": 2.76, "totalAmount": 18.91, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Calculator - Printing Rolls", "unitAmount": 5.7, "quantity": 15, "discountAmount": 0, "subTotal": 85.5, "taxAmount": 14.59, "totalAmount": 100.09, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Correction Fluid - White", "unitAmount": 2.37, "quantity": 7, "discountAmount": 0, "subTotal": 16.59, "taxAmount": 2.83, "totalAmount": 19.42, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Envelope - White (110 x 220) Plain", "unitAmount": 8.54, "quantity": 20, "discountAmount": 0, "subTotal": 170.8, "taxAmount": 29.14, "totalAmount": 199.94, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Flip Chart - A1 Pad", "unitAmount": 15.2, "quantity": 10, "discountAmount": 0, "subTotal": 152, "taxAmount": 25.94, "totalAmount": 177.94, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Laminator Pouches - A4", "unitAmount": 11.4, "quantity": 5, "discountAmount": 0, "subTotal": 57, "taxAmount": 9.73, "totalAmount": 66.73, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Mouse Mat - (241 x 203) Blue", "unitAmount": 1.42, "quantity": 5, "discountAmount": 0, "subTotal": 7.1, "taxAmount": 1.21, "totalAmount": 8.31, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Copy Paper - Economy Grade", "unitAmount": 2.46, "quantity": 80, "discountAmount": 0, "subTotal": 196.8, "taxAmount": 33.58, "totalAmount": 230.38, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Coloured Paper - Pastel Blue", "unitAmount": 3.61, "quantity": 5, "discountAmount": 0, "subTotal": 18.05, "taxAmount": 3.08, "totalAmount": 21.13, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Ball Point Pen - Black", "unitAmount": 1.9, "quantity": 8, "discountAmount": 0, "subTotal": 15.2, "taxAmount": 2.59, "totalAmount": 17.79, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Pencil - HB", "unitAmount": 2.37, "quantity": 3, "discountAmount": 0, "subTotal": 7.11, "taxAmount": 1.21, "totalAmount": 8.32, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Remember-Me Sticky Notes (Recycled)", "unitAmount": 3.32, "quantity": 6, "discountAmount": 0, "subTotal": 19.92, "taxAmount": 3.4, "totalAmount": 23.32, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Scissors - Economy", "unitAmount": 2.85, "quantity": 1, "discountAmount": 0, "subTotal": 2.85, "taxAmount": 0.49, "totalAmount": 3.34, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Adhesive Tape - Brown (50mm x 66m)", "unitAmount": 2.66, "quantity": 5, "discountAmount": 0, "subTotal": 13.3, "taxAmount": 2.27, "totalAmount": 15.57, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "JP010 Jet Printer Cartridge", "unitAmount": 17.1, "quantity": 5, "discountAmount": 0, "subTotal": 85.5, "taxAmount": 14.59, "totalAmount": 100.09, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Letter Trays - 3 pack (Red)", "unitAmount": 6.65, "quantity": 2, "discountAmount": 0, "subTotal": 13.3, "taxAmount": 2.27, "totalAmount": 15.57, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -100.09 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -66.73 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -117.5 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -177.94 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -230.38 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -17.79 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -71.08 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -88.97 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -15.57 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -3.34 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -199.94 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -100.09 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -16.68 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -18.91 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -23.32 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -99.97 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -21.13 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -15.57 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -19.42 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -8.31 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -11.12 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -8.32 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 1223.04, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 209.13, "totalAmount": 1432.17, "amountDue": 0, "status": "Paid", "note": "", "metadata": { "isDeleted": false } }, { "id": "INV-9", "invoiceNumber": "9", "customerRef": { "id": "KIN001", "companyName": "Kinghorn & French" }, "salesOrderRefs": [], "issueDate": "2021-01-04T00:00:00", "modifiedDate": "2023-03-30T14:42:42Z", "sourceModifiedDate": "2022-11-25T09:43:54", "paidOnDate": "2022-01-29T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "PC Combo Pack 4", "unitAmount": 765, "quantity": 5, "discountAmount": 765, "subTotal": 3060, "taxAmount": 522.11, "totalAmount": 3582.11, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 20, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "PC Combo Pack 5", "unitAmount": 1080, "quantity": 4, "discountAmount": 864, "subTotal": 3456, "taxAmount": 589.68, "totalAmount": 4045.68, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 20, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "PC Combo Pack 6", "unitAmount": 1350, "quantity": 2, "discountAmount": 540, "subTotal": 2160, "taxAmount": 368.55, "totalAmount": 2528.55, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 20, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "FX030 Multifunctional Fax", "unitAmount": 414, "quantity": 2, "discountAmount": 165.6, "subTotal": 662.4, "taxAmount": 113.02, "totalAmount": 775.42, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 20, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Copy Paper - Premium Grade", "unitAmount": 3.06, "quantity": 100, "discountAmount": 61.2, "subTotal": 244.8, "taxAmount": 41.77, "totalAmount": 286.57, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 20, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "271", "note": "Sales receipt 271 linked to sales invoice inv-9.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 11123.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -276.57 } }, { "payment": { "id": "271", "note": "Sales receipt 271 linked to sales invoice inv-9.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 11123.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -765.42 } }, { "payment": { "id": "271", "note": "Sales receipt 271 linked to sales invoice inv-9.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 11123.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -4035.68 } }, { "payment": { "id": "271", "note": "Sales receipt 271 linked to sales invoice inv-9.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 11123.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -2518.55 } }, { "payment": { "id": "271", "note": "Sales receipt 271 linked to sales invoice inv-9.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 11123.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -3527.11 } }, { "payment": { "id": "272", "note": "Sales discount 272 linked to sales invoice inv-9.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10 } }, { "payment": { "id": "272", "note": "Sales discount 272 linked to sales invoice inv-9.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10 } }, { "payment": { "id": "272", "note": "Sales discount 272 linked to sales invoice inv-9.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10 } }, { "payment": { "id": "272", "note": "Sales discount 272 linked to sales invoice inv-9.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10 } }, { "payment": { "id": "272", "note": "Sales discount 272 linked to sales invoice inv-9.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10 } }, { "payment": { "id": "9", "note": "Sales credit tx-9 linked to sales invoice inv-9.", "accountRef": { "id": "" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-12-31T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -45 } } ], "withholdingTax": [], "totalDiscount": 2395.8, "subTotal": 9583.2, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 1635.13, "totalAmount": 11218.33, "amountDue": 0, "status": "Paid", "note": "", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 86, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "b039b0a733de11e797950a57719b2edb", "invoiceNumber": "SI-1", "customerRef": { "id": "f4ff85ba33dd11e797950a57719b2edb", "companyName": "Widgets Limited" }, "salesOrderRefs": [], "issueDate": "2017-05-08T00:00:00", "dueDate": "2017-06-07T00:00:00", "modifiedDate": "2022-10-24T15:03:37Z", "sourceModifiedDate": "2021-07-23T13:42:59Z", "paidOnDate": "2021-07-23T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Consulting services", "unitAmount": 900, "quantity": 8, "discountAmount": 0, "subTotal": 7200, "taxAmount": 1440, "totalAmount": 8640, "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" }, "discountPercentage": 0, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 }, "itemRef": { "id": "a87b922b33de11e797950a57719b2edb", "name": "Consulting services" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "e1c2bd659a6111e8bad90617b3da4b8a", "note": "Sales credit note", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-08-07T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -1000 } }, { "payment": { "id": "e1c2bd659a6111e8bad90617b3da4b8a", "note": "Sales credit note", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-08-07T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -1000 } }, { "payment": { "id": "579388a0215911e8b45c025132dab352", "note": "Customer receipt using credit/debit card", "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-01-02T00:00:00", "totalAmount": 1400 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -1400 } }, { "payment": { "id": "52237e4e215911e8b45c025132dab352", "note": "Customer receipt using credit/debit card", "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-01-02T00:00:00", "totalAmount": 4000 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -4000 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 7200, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 1440, "totalAmount": 8640, "amountDue": 1240, "status": "PartiallyPaid" }, { "id": "6420b3f8209611e8b45c025132dab352", "invoiceNumber": "SI-2", "customerRef": { "id": "f4ff85ba33dd11e797950a57719b2edb", "companyName": "Widgets Limited" }, "salesOrderRefs": [], "issueDate": "2018-03-05T00:00:00", "dueDate": "2018-04-04T00:00:00", "modifiedDate": "2022-10-24T15:03:37Z", "sourceModifiedDate": "2018-03-05T16:58:39Z", "paidOnDate": "2018-03-05T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Consulting services", "unitAmount": 900, "quantity": 5, "discountAmount": 0, "subTotal": 4500, "taxAmount": 900, "totalAmount": 5400, "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" }, "discountPercentage": 0, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 }, "itemRef": { "id": "a87b922b33de11e797950a57719b2edb", "name": "Consulting services" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "73a0490d209611e8b45c025132dab352", "note": "Customer receipt using cash - PAYMENT-CASH-001", "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-03-05T00:00:00", "totalAmount": 5400 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5400 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 4500, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 900, "totalAmount": 5400, "amountDue": 0, "status": "Paid" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 10759, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "2916", "invoiceNumber": "IN0480", "customerRef": { "id": "12", "companyName": "MK Manufacturing" }, "salesOrderRefs": [], "issueDate": "2021-04-22T00:00:00", "dueDate": "2021-05-22T00:00:00", "modifiedDate": "2023-04-04T16:31:54Z", "sourceModifiedDate": "2021-04-22T11:01:11Z", "paidOnDate": "2021-04-22T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "unitAmount": 100, "quantity": 1, "subTotal": 100, "taxAmount": 20, "totalAmount": 120, "accountRef": { "id": "176", "name": "Revenue - Services" }, "taxRateRef": { "id": "105", "name": "UK Sale Services Standard Rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "CUSTOMER-12", "name": "MK Manufacturing" }, { "id": "DEPARTMENT-2", "name": "Services" }, { "id": "LOCATION-11", "name": "Codat Test Entity" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "2918", "note": "", "accountRef": { "id": "353", "name": "Current Account" }, "currency": "GBP", "paidOnDate": "2021-04-22T00:00:00", "totalAmount": 120 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -120 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 100, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 20, "totalAmount": 120, "amountDue": 0, "status": "Paid", "metadata": { "isDeleted": false } }, { "id": "18827", "invoiceNumber": "IN1515", "customerRef": { "id": "6", "companyName": "AG Insurance" }, "salesOrderRefs": [], "issueDate": "2022-09-28T00:00:00", "dueDate": "2022-10-28T00:00:00", "modifiedDate": "2023-04-04T16:31:54Z", "sourceModifiedDate": "2022-10-05T11:02:22Z", "currency": "USD", "currencyRate": 0.9294, "lineItems": [ { "description": "test desc Test05102022-1", "unitAmount": 180, "quantity": 1, "subTotal": 180, "taxAmount": 0, "totalAmount": 180, "accountRef": { "id": "2", "name": "Accounts Receivable" }, "taxRateRef": { "id": "58", "name": "EC Sale Goods Standard Rate", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [ { "id": "CUSTOMER-6", "name": "AG Insurance" }, { "id": "DEPARTMENT-1", "name": "Sales" }, { "id": "LOCATION-11", "name": "Codat Test Entity" } ], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "totalDiscount": 0, "subTotal": 180, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 180, "amountDue": 180, "status": "Submitted", "note": "test desc Test05102022-1", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/invoices" } } } }, "Wave": { "value": { "results": [ { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6NzgyNDQ4OTg1Nzc1MzE5MTYw", "invoiceNumber": "1", "customerRef": { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4", "companyName": "ABC Textiles" }, "salesOrderRefs": [], "issueDate": "2019-10-17T00:00:00", "dueDate": "2019-10-17T00:00:00", "modifiedDate": "2022-11-16T18:15:23Z", "sourceModifiedDate": "2019-12-05T23:20:36Z", "paidOnDate": "2019-12-05T23:20:36Z", "currency": "USD", "currencyRate": 0.784736781, "lineItems": [ { "description": "", "unitAmount": 10, "quantity": 5, "subTotal": 50, "taxAmount": 2.5, "totalAmount": 52.5, "accountRef": { "id": "QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2", "name": "Sales" }, "itemRef": { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjcyNTI=", "name": "Golf balls" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "subTotal": 50, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 2.5, "totalAmount": 52.5, "amountDue": 0, "status": "Paid" }, { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6ODgzOTc4MDA2NDIxMzUwODIx", "invoiceNumber": "2", "customerRef": { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM2OTkxOTYw", "companyName": "NIC Cookies" }, "salesOrderRefs": [], "issueDate": "2020-03-05T00:00:00", "dueDate": "2020-03-05T00:00:00", "modifiedDate": "2022-11-16T18:15:23Z", "sourceModifiedDate": "2020-03-30T14:10:21Z", "paidOnDate": "2020-03-30T14:10:21Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Decorated cookies", "unitAmount": 4, "quantity": 50, "subTotal": 200, "taxAmount": 40, "totalAmount": 240, "accountRef": { "id": "QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2", "name": "Sales" }, "itemRef": { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6NDEzNzEwOTU=", "name": "Cookies" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "subTotal": 200, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 40, "totalAmount": 240, "amountDue": 0, "status": "Paid" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 19, "_links": { "current": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices" }, "next": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "321bfed3-2da2-4969-9358-4de97821181b", "invoiceNumber": "INV-001-0", "customerRef": { "id": "afd4093b-c655-4847-8ee2-10a4f2c3eae3", "companyName": "Maddox Publishing Group" }, "salesOrderRefs": [], "issueDate": "2021-12-20T00:00:00", "dueDate": "2022-01-17T00:00:00", "modifiedDate": "2023-03-15T20:38:11Z", "sourceModifiedDate": "2021-01-02T20:34:51", "paidOnDate": "2022-02-17T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Project management - onsite daily rate - your CRM integration project", "unitAmount": 583.3333333333, "quantity": 6, "discountAmount": 0, "subTotal": 3500, "taxAmount": 700, "totalAmount": 4200, "accountRef": { "id": "a969500a-377c-4cea-8f2b-a4e385607fd0", "name": "Other Revenue" }, "discountPercentage": 0, "taxRateRef": { "id": "OUTPUT2", "name": "20% (VAT on Income)", "effectiveTaxRate": 20 }, "itemRef": { "id": "aa1c5f84-4453-42fa-9c92-69d4085607c9", "name": "Project management - daily rate" }, "trackingCategoryRefs": [ { "id": "34b9b859-07a9-451a-b4d3-effc9946634a", "name": "North" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "65b746c8-9a5d-4a95-8096-d2316fcff592", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-17T00:00:00", "totalAmount": 4200 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -4200 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 3500, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 700, "totalAmount": 4200, "amountDue": 0, "status": "Paid", "metadata": { "isDeleted": false } }, { "id": "4b6d0c8f-10fa-42cd-a6e5-53b175e90005", "invoiceNumber": "INV-0001", "customerRef": { "id": "a871a956-05b5-4e2a-9419-7aeb478ca647", "companyName": "Ridgeway University" }, "salesOrderRefs": [], "issueDate": "2022-02-07T00:00:00", "dueDate": "2022-02-17T00:00:00", "modifiedDate": "2023-03-15T20:38:11Z", "sourceModifiedDate": "2021-01-02T22:51:43", "paidOnDate": "2022-02-17T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Retainer for consulting work", "unitAmount": 416.67, "quantity": 1, "discountAmount": 0, "subTotal": 416.67, "taxAmount": 83.33, "totalAmount": 500, "accountRef": { "id": "c563b607-fb0e-4d06-9ddb-76fdeef20ae3", "name": "Sales" }, "discountPercentage": 0, "taxRateRef": { "id": "OUTPUT2", "name": "20% (VAT on Income)", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "8c481b70-b5d7-4de4-a7f7-9e161be2c472", "reference": "", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-17T00:00:00", "totalAmount": 500 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -500 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 416.67, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 83.33, "totalAmount": 500, "amountDue": 0, "status": "Paid", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 44, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/invoices" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/invoices?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000038034", "invoiceNumber": "INV-102", "customerRef": { "id": "104957000000037097", "companyName": "Test Company" }, "salesOrderRefs": [], "issueDate": "2020-02-06T10:54:03", "dueDate": "2020-02-17T00:00:00", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2020-05-19T15:36:26", "paidOnDate": "2020-05-19T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [], "paymentAllocations": [ { "payment": { "id": "104957000000129048", "note": "", "reference": "9", "accountRef": { "id": "104957000000000349", "name": "Petty Cash" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-04-29T00:00:00", "totalAmount": 9000 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -9000 } }, { "payment": { "id": "104957000000137017", "note": "", "reference": "11", "accountRef": { "id": "104957000000060010", "name": "Abdi Test" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-05-19T00:00:00", "totalAmount": 9000 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -1 } } ], "withholdingTax": [], "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 9001, "amountDue": 0, "status": "Paid" }, { "id": "104957000000038052", "invoiceNumber": "INV-104", "customerRef": { "id": "104957000000037097", "companyName": "Test Company" }, "salesOrderRefs": [], "issueDate": "2020-02-06T10:54:04", "dueDate": "2020-02-17T00:00:00", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2020-02-17T14:21:05", "paidOnDate": "2020-02-06T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [], "paymentAllocations": [ { "payment": { "id": "104957000000070175", "note": "Cheque deposit", "reference": "4", "accountRef": { "id": "104957000000060010", "name": "Abdi Test" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-06T00:00:00", "totalAmount": 9001 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -9001 } } ], "withholdingTax": [], "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 9001, "amountDue": 0, "status": "Paid" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 48, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/data/invoices/{invoiceId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Invoices" ], "parameters": [ { "$ref": "#/components/parameters/invoiceId" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": { "Clear Books": { "value": { "id": "2518ca08-5e2a-4630-8cee-a6bcd1625660", "invoiceNumber": "TKj7oD38", "customerRef": { "id": "d65ac505-072c-49ec-be3c-3cb74228966d", "companyName": "Jensen Steuber" }, "salesOrderRefs": [], "issueDate": "2022-04-25T13:04:02", "dueDate": "2022-04-25T13:04:02", "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2023-01-28T14:41:02", "paidOnDate": "2022-04-25T13:04:02", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Heavy Duty Hinged Gully Grating x4.00", "unitAmount": 402.89, "quantity": 4, "subTotal": 1611.56, "taxAmount": 161.16, "totalAmount": 1772.72, "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "itemRef": { "id": "3abf0883-03f7-44c6-bc15-1372522d25e1", "name": "Heavy Duty Hinged Gully Grating" }, "trackingCategoryRefs": [ { "id": "costcode_9", "name": "PandaConstruction" } ], "isDirectIncome": true } ], "paymentAllocations": [ { "payment": { "id": "9407d5ee-893a-4547-bd89-bc7b795ee774", "note": "Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660", "reference": "2518ca08-5e2a-4630-8cee-a6bcd1625660", "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-04-25T13:04:02", "totalAmount": 1772.72 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2022-04-25T13:04:02", "totalAmount": -1772.72 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 1611.56, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 161.16, "totalAmount": 1772.72, "amountDue": 0, "discountPercentage": 0, "status": "Paid", "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "18c906bf-89d1-ea11-bbaa-000d3a2b9185", "invoiceNumber": "103001", "customerRef": { "id": "b61217b3-89d1-ea11-bbaa-000d3a2b9185", "companyName": "Trey Researches" }, "salesOrderRefs": [], "issueDate": "2019-01-15T00:00:00", "dueDate": "2019-01-15T00:00:00", "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2022-05-17T16:29:00Z", "paidOnDate": "2019-01-15T00:00:00", "currency": "GBP", "lineItems": [ { "description": "AMSTERDAM Lamp", "unitAmount": 35.6, "quantity": 3, "discountAmount": 0, "subTotal": 106.8, "taxAmount": 21.36, "totalAmount": 128.16, "accountRef": { "id": "181217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Income, Product Sales" }, "discountPercentage": 0, "taxRateRef": { "id": "63bc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for DOMESTIC / STANDARD", "effectiveTaxRate": 10 }, "itemRef": { "id": "ITEM-d41217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC", "name": "AMSTERDAM Lamp / General Business Posting Group: 'DOMESTIC' / VAT Business Posting Group: 'DOMESTIC'" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "e0299ced-89d1-ea11-bbaa-000d3a2b9185", "note": "Invoice 102001", "reference": "Document No: 103001", "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2019-01-15T00:00:00", "totalAmount": 128.16 }, "allocation": { "currency": "GBP", "currencyRate": 1, "allocatedOnDate": "2019-01-15T00:00:00", "totalAmount": -128.16 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 106.8, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 21.36, "totalAmount": 128.16, "amountDue": 0, "discountPercentage": 0, "status": "Paid", "note": "", "metadata": { "isDeleted": false } } }, "Exact (Netherlands)": { "value": { "id": "91dccc63-b1af-4363-bee0-2aec6bab1bef", "invoiceNumber": "19700002", "customerRef": { "id": "c3bf08a3-4d51-4859-acbb-5075f9484f87", "companyName": "Mr Abe" }, "salesOrderRefs": [], "issueDate": "2019-11-08T00:00:00Z", "dueDate": "2019-11-29T00:00:00Z", "modifiedDate": "2022-10-26T13:57:52Z", "sourceModifiedDate": "2019-11-08T11:56:22Z", "currency": "EUR", "currencyRate": 1, "lineItems": [ { "description": "Consultancy per uur - Consultancy per uur", "unitAmount": 75, "quantity": 8, "discountAmount": 0, "subTotal": 600, "taxAmount": 0, "totalAmount": 600, "accountRef": { "id": "2421e8a0-5355-4ec0-af11-021fe4f39fcd", "name": "Omzet binnenland hoog tarief" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "subTotal": 600, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 600, "amountDue": 599, "discountPercentage": 0, "status": "PartiallyPaid" } }, "Exact (UK)": { "value": { "id": "a05d1256-f253-46bd-aa13-c6f6a992aa47", "invoiceNumber": "17700002", "customerRef": { "id": "570321bb-8b0c-49f1-a1f5-6fb1d6d94a62", "companyName": "Some customer" }, "salesOrderRefs": [], "issueDate": "2017-08-02T00:00:00Z", "dueDate": "2017-09-01T00:00:00Z", "modifiedDate": "2022-10-26T13:39:08Z", "sourceModifiedDate": "2017-08-02T18:23:43Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "A bunch of stuff - A bunch of stuff", "unitAmount": 100, "quantity": 1000, "discountAmount": 0, "subTotal": 100000, "taxAmount": 0, "totalAmount": 100000, "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "subTotal": 100000, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 100000, "amountDue": 0, "discountPercentage": 0, "status": "Paid" } }, "FreeAgent": { "value": { "id": "50541736", "invoiceNumber": "2348", "customerRef": { "id": "10123537", "companyName": "_Test 1" }, "salesOrderRefs": [], "issueDate": "2016-12-30T00:00:00", "dueDate": "2016-12-30T00:00:00", "modifiedDate": "2023-04-25T14:19:19Z", "sourceModifiedDate": "2022-10-20T14:28:00Z", "paidOnDate": "2020-11-05T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "3.0 items with VatPercentage of 0.0", "unitAmount": 25.26, "quantity": 1, "discountAmount": 0, "subTotal": 25.26, "taxAmount": 0, "totalAmount": 25.26, "accountRef": { "id": "001", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "3 service charges with 0.0% vat", "unitAmount": 8.85, "quantity": 1, "discountAmount": 0, "subTotal": 8.85, "taxAmount": 0, "totalAmount": 8.85, "accountRef": { "id": "001", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Tax", "unitAmount": 0, "quantity": 1, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "262466203", "note": "E2E Test transaction 2 CREDIT �250.00 - Invoice receipt against 2348", "currency": "GBP", "paidOnDate": "2020-11-05T00:00:00", "totalAmount": 250 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -34.11 } } ], "withholdingTax": [], "subTotal": 34.11, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 34.11, "amountDue": 0, "status": "Paid", "metadata": { "isDeleted": false } } }, "FreshBooks": { "value": { "id": "2596455", "invoiceNumber": "test-AL", "customerRef": { "id": "602174", "companyName": "ab1" }, "salesOrderRefs": [], "issueDate": "1987-10-01T00:00:00", "dueDate": "1987-10-01T00:00:00", "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2023-03-03T09:27:42", "paidOnDate": "2023-03-03T00:00:00", "currency": "USD", "lineItems": [ { "description": "Editing creative writing for a client", "unitAmount": 222.88, "quantity": 1, "discountAmount": 0, "subTotal": 222.88, "taxAmount": 0, "totalAmount": 222.88, "itemRef": { "id": "639579", "name": "Creative Writing Editorial" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "", "unitAmount": 0, "quantity": 1, "discountAmount": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "2570292", "note": "", "currency": "USD", "paidOnDate": "2023-03-03T00:00:00", "totalAmount": 0.17 }, "allocation": { "currency": "USD", "currencyRate": 1, "totalAmount": -0.17 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 222.88, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 222.88, "amountDue": 222.71, "status": "Submitted", "note": "", "metadata": { "isDeleted": false } } }, "KashFlow": { "value": { "id": "143008521", "invoiceNumber": "40", "customerRef": { "id": "86832299", "companyName": "Mr French Person" }, "salesOrderRefs": [], "issueDate": "2005-12-15T00:00:00", "dueDate": "2006-01-12T00:00:00", "modifiedDate": "2022-09-30T10:29:15Z", "currency": "EUR", "currencyRate": 0.844737287, "lineItems": [ { "unitAmount": 0, "quantity": 0, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "accountRef": { "id": "0" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "subTotal": 0, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 0, "amountDue": 0, "status": "Paid" } }, "Oracle NetSuite": { "value": { "id": "416", "invoiceNumber": "INV01", "customerRef": { "id": "417", "companyName": "10 Breww Ltd" }, "salesOrderRefs": [], "issueDate": "2021-04-09T00:00:00", "dueDate": "2021-04-30T00:00:00", "modifiedDate": "2022-09-20T08:16:10Z", "sourceModifiedDate": "2021-08-25T15:55:36", "paidOnDate": "2021-04-20T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Non-Recurring Services - EC", "unitAmount": 100, "quantity": 1, "subTotal": 100, "totalAmount": 100, "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "28", "name": "Non-Recurring Services - EC" }, "trackingCategoryRefs": [ { "id": "location-1" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "428", "reference": "Payment #PYMT01", "accountRef": { "id": "122", "name": "Undeposited Funds" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-04-20T00:00:00", "totalAmount": 90 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -90 } }, { "payment": { "id": "428", "reference": "Payment #PYMT01", "accountRef": { "id": "122", "name": "Undeposited Funds" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2021-04-20T00:00:00", "totalAmount": 90 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 100, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 100, "amountDue": 0, "status": "Paid" } }, "QuickBooks Desktop": { "value": { "id": "2453-1071526256", "invoiceNumber": "975", "customerRef": { "id": "420000-1071522044", "companyName": "Prentice, Adelaide" }, "salesOrderRefs": [], "issueDate": "2022-11-28T00:00:00", "dueDate": "2023-12-28T00:00:00", "modifiedDate": "2023-04-26T09:08:12Z", "sourceModifiedDate": "2023-12-16T05:06:11", "paidOnDate": "2023-01-15T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Foundation slab - prep and pouring", "unitAmount": 167.5, "quantity": 1, "subTotal": 167.5, "taxAmount": 0, "totalAmount": 167.5, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" }, "itemRef": { "id": "320000-1071525597", "name": "Concrete Slab" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isDirectIncome": false }, { "unitAmount": 0, "quantity": 1, "subTotal": 0, "taxAmount": 0, "totalAmount": 0, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Rough lumber", "unitAmount": 48, "quantity": 1, "subTotal": 48, "taxAmount": 0, "totalAmount": 48, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "1C0000-933272656", "name": "Lumber:Rough" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isDirectIncome": false }, { "description": "Trim lumber", "unitAmount": 38, "quantity": 1, "subTotal": 38, "taxAmount": 0, "totalAmount": 38, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "1D0000-933272656", "name": "Lumber:Trim" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isDirectIncome": false }, { "description": "Window", "unitAmount": 25, "quantity": 2, "subTotal": 50, "taxAmount": 0, "totalAmount": 50, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "1F0000-933272656", "name": "Window" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isDirectIncome": false }, { "description": "Flooring", "unitAmount": 50, "quantity": 1, "subTotal": 50, "taxAmount": 0, "totalAmount": 50, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "310000-1071509547", "name": "Flooring" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isDirectIncome": false }, { "description": "Window", "unitAmount": 30, "quantity": 2, "subTotal": 60, "taxAmount": 0, "totalAmount": 60, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" }, "itemRef": { "id": "1F0000-933272656", "name": "Window" }, "trackingCategoryRefs": [ { "id": "10000-933272658", "name": "New Construction" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "6973-1197775625", "note": "Check - 80000-933270541", "reference": "983409", "accountRef": { "id": "80000-933270541", "name": "Undeposited Funds" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2023-01-15T00:00:00", "totalAmount": 431.95 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -431.95 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 413.5, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 18.45, "totalAmount": 431.95, "amountDue": 0, "discountPercentage": 0, "status": "Paid", "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "16", "invoiceNumber": "1001", "customerRef": { "id": "3", "companyName": "Information Sharing Technology" }, "salesOrderRefs": [], "issueDate": "2019-02-18T00:00:00", "dueDate": "2019-03-20T00:00:00", "modifiedDate": "2023-01-18T11:03:02Z", "sourceModifiedDate": "2022-09-20T10:12:08Z", "paidOnDate": "2020-06-01T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Service", "unitAmount": 500, "quantity": 10, "subTotal": 5000, "taxAmount": 0, "totalAmount": 5000, "accountRef": { "id": "1", "name": "Sales" }, "itemRef": { "id": "1", "name": "Sales" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "116", "note": "Payments of type Prepaid", "reference": "114213", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-10T00:00:00", "totalAmount": 65.77 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -23.86 } }, { "payment": { "id": "122", "note": "Payments of type Cash", "reference": "121197", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-10T00:00:00", "totalAmount": 771.61 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -16.31 } }, { "payment": { "id": "123", "note": "Payments of type Prepaid", "reference": "121293", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-10T00:00:00", "totalAmount": 34.45 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -34.45 } }, { "payment": { "id": "132", "note": "Payments of type Prepaid", "reference": "13022", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-10T00:00:00", "totalAmount": 47.38 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -42.36 } }, { "payment": { "id": "140", "note": "Payments of type Cash", "reference": "139163", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-13T00:00:00", "totalAmount": 1078.72 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -13.71 } }, { "payment": { "id": "141", "note": "Payments of type Prepaid", "reference": "139288", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-13T00:00:00", "totalAmount": 27.88 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -27.88 } }, { "payment": { "id": "149", "note": "Payments of type Cash", "reference": "148151", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-13T00:00:00", "totalAmount": 643.97 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -22.26 } }, { "payment": { "id": "150", "note": "Payments of type Prepaid", "reference": "148217", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-13T00:00:00", "totalAmount": 11.57 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -11.57 } }, { "payment": { "id": "157", "note": "Payments of type Prepaid", "reference": "155266", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-15T00:00:00", "totalAmount": 14.32 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -4.87 } }, { "payment": { "id": "165", "note": "Payments of type Cash", "reference": "164142", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-15T00:00:00", "totalAmount": 913.09 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -18.99 } }, { "payment": { "id": "166", "note": "Payments of type Prepaid", "reference": "164260", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-15T00:00:00", "totalAmount": 39.98 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -39.98 } }, { "payment": { "id": "173", "note": "Payments of type Prepaid", "reference": "171213", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-15T00:00:00", "totalAmount": 35.36 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -26.29 } }, { "payment": { "id": "181", "note": "Payments of type Cash", "reference": "180197", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-17T00:00:00", "totalAmount": 1087.13 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10.04 } }, { "payment": { "id": "182", "note": "Payments of type Prepaid", "reference": "180274", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-17T00:00:00", "totalAmount": 47.91 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -47.91 } }, { "payment": { "id": "190", "note": "Payments of type Cash", "reference": "189174", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-17T00:00:00", "totalAmount": 607.48 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -13.34 } }, { "payment": { "id": "191", "note": "Payments of type Prepaid", "reference": "18922", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-17T00:00:00", "totalAmount": 16.44 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -16.44 } }, { "payment": { "id": "199", "note": "Payments of type Cash", "reference": "198128", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-20T00:00:00", "totalAmount": 1209.15 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -20.22 } }, { "payment": { "id": "200", "note": "Payments of type Prepaid", "reference": "198234", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-20T00:00:00", "totalAmount": 18.35 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -18.35 } }, { "payment": { "id": "208", "note": "Payments of type Cash", "reference": "207189", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-21T00:00:00", "totalAmount": 914.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7.86 } }, { "payment": { "id": "209", "note": "Payments of type Prepaid", "reference": "207254", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-21T00:00:00", "totalAmount": 27.62 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -27.62 } }, { "payment": { "id": "217", "note": "Payments of type Cash", "reference": "216161", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-22T00:00:00", "totalAmount": 565.24 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -1.66 } }, { "payment": { "id": "218", "note": "Payments of type Prepaid", "reference": "216237", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-22T00:00:00", "totalAmount": 19.67 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -19.67 } }, { "payment": { "id": "231", "note": "Payments of type Prepaid", "reference": "229276", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-23T00:00:00", "totalAmount": 38.7 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -30.52 } }, { "payment": { "id": "240", "note": "Payments of type PrepaidPayment", "reference": "238213", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-23T00:00:00", "totalAmount": 47.7 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -31.98 } }, { "payment": { "id": "249", "note": "Payments of type PrepaidPayment", "reference": "247245", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-23T00:00:00", "totalAmount": 22.03 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10.84 } }, { "payment": { "id": "256", "note": "Payments of type PrepaidPayment", "reference": "254258", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-23T00:00:00", "totalAmount": 37.68 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -16.6 } }, { "payment": { "id": "262", "note": "Payments of type Cash", "reference": "261162", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-24T00:00:00", "totalAmount": 425.69 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -15.02 } }, { "payment": { "id": "263", "note": "Payments of type PrepaidPayment", "reference": "261215", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-24T00:00:00", "totalAmount": 7.24 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7.24 } }, { "payment": { "id": "269", "note": "Payments of type Cash", "reference": "268154", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-24T00:00:00", "totalAmount": 968.21 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -48.58 } }, { "payment": { "id": "270", "note": "Payments of type PrepaidPayment", "reference": "268269", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-24T00:00:00", "totalAmount": 11.69 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -11.69 } }, { "payment": { "id": "278", "note": "Payments of type Cash", "reference": "277153", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-25T00:00:00", "totalAmount": 1063.48 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -37.08 } }, { "payment": { "id": "279", "note": "Payments of type PrepaidPayment", "reference": "277281", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-25T00:00:00", "totalAmount": 30.58 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -30.58 } }, { "payment": { "id": "287", "note": "Payments of type Cash", "reference": "286188", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-26T00:00:00", "totalAmount": 539.55 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -6.97 } }, { "payment": { "id": "288", "note": "Payments of type PrepaidPayment", "reference": "286250", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-26T00:00:00", "totalAmount": 12.73 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -12.73 } }, { "payment": { "id": "296", "note": "Payments of type Cash", "reference": "295176", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-27T00:00:00", "totalAmount": 687.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -4.18 } }, { "payment": { "id": "297", "note": "Payments of type PrepaidPayment", "reference": "295264", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-27T00:00:00", "totalAmount": 14.92 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -14.92 } }, { "payment": { "id": "303", "note": "Payments of type Cash", "reference": "302128", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-28T00:00:00", "totalAmount": 837.68 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -6.66 } }, { "payment": { "id": "304", "note": "Payments of type PrepaidPayment", "reference": "302284", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-28T00:00:00", "totalAmount": 17.04 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -17.04 } }, { "payment": { "id": "313", "note": "Payments of type PrepaidPayment", "reference": "311211", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-29T00:00:00", "totalAmount": 45.06 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -41.47 } }, { "payment": { "id": "321", "note": "Payments of type Cash", "reference": "320186", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-29T00:00:00", "totalAmount": 798.79 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -27.08 } }, { "payment": { "id": "322", "note": "Payments of type PrepaidPayment", "reference": "320256", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-29T00:00:00", "totalAmount": 14.33 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -14.33 } }, { "payment": { "id": "333", "note": "Payments of type PrepaidPayment", "reference": "331236", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-30T00:00:00", "totalAmount": 17.94 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -17.58 } }, { "payment": { "id": "341", "note": "Payments of type Cash", "reference": "340128", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-30T00:00:00", "totalAmount": 859.44 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -29.21 } }, { "payment": { "id": "342", "note": "Payments of type PrepaidPayment", "reference": "340292", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-30T00:00:00", "totalAmount": 26.59 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -26.59 } }, { "payment": { "id": "348", "note": "Payments of type Cash", "reference": "34710", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-31T00:00:00", "totalAmount": 949.74 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7.07 } }, { "payment": { "id": "349", "note": "Payments of type PrepaidPayment", "reference": "347216", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-01-31T00:00:00", "totalAmount": 25.32 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -25.32 } }, { "payment": { "id": "361", "note": "Payments of type PrepaidPayment", "reference": "359220", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-01T00:00:00", "totalAmount": 54.12 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -40.61 } }, { "payment": { "id": "367", "note": "Payments of type Cash", "reference": "366195", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-02T00:00:00", "totalAmount": 827.2 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -25.4 } }, { "payment": { "id": "368", "note": "Payments of type PrepaidPayment", "reference": "366288", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-02T00:00:00", "totalAmount": 12.15 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -12.15 } }, { "payment": { "id": "376", "note": "Payments of type Cash", "reference": "375123", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-03T00:00:00", "totalAmount": 802.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -11.54 } }, { "payment": { "id": "377", "note": "Payments of type PrepaidPayment", "reference": "375298", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-03T00:00:00", "totalAmount": 39.06 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -39.06 } }, { "payment": { "id": "385", "note": "Payments of type Cash", "reference": "38418", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-04T00:00:00", "totalAmount": 858.41 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -13.4 } }, { "payment": { "id": "386", "note": "Payments of type PrepaidPayment", "reference": "384213", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-04T00:00:00", "totalAmount": 9.99 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -9.99 } }, { "payment": { "id": "392", "note": "Payments of type Cash", "reference": "391115", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 1094.8 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -47.35 } }, { "payment": { "id": "393", "note": "Payments of type PrepaidPayment", "reference": "391247", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-05T00:00:00", "totalAmount": 16.73 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -16.73 } }, { "payment": { "id": "402", "note": "Payments of type PrepaidPayment", "reference": "400275", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-06T00:00:00", "totalAmount": 32.88 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -29.29 } }, { "payment": { "id": "410", "note": "Payments of type Cash", "reference": "409145", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-07T00:00:00", "totalAmount": 725.48 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -33.79 } }, { "payment": { "id": "411", "note": "Payments of type PrepaidPayment", "reference": "409292", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-07T00:00:00", "totalAmount": 6.22 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -6.22 } }, { "payment": { "id": "419", "note": "Payments of type Cash", "reference": "418157", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-08T00:00:00", "totalAmount": 407.2 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -2.55 } }, { "payment": { "id": "420", "note": "Payments of type PrepaidPayment", "reference": "418258", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-08T00:00:00", "totalAmount": 8.92 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -8.92 } }, { "payment": { "id": "429", "note": "Payments of type PrepaidPayment", "reference": "427270", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-09T00:00:00", "totalAmount": 56.75 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -28.75 } }, { "payment": { "id": "437", "note": "Payments of type Cash", "reference": "436168", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-10T00:00:00", "totalAmount": 760.05 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -31.48 } }, { "payment": { "id": "438", "note": "Payments of type PrepaidPayment", "reference": "436234", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-10T00:00:00", "totalAmount": 6.03 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -6.03 } }, { "payment": { "id": "446", "note": "Payments of type Cash", "reference": "44518", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-11T00:00:00", "totalAmount": 904.82 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -17.96 } }, { "payment": { "id": "447", "note": "Payments of type PrepaidPayment", "reference": "445278", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-11T00:00:00", "totalAmount": 24.95 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -24.95 } }, { "payment": { "id": "456", "note": "Payments of type PrepaidPayment", "reference": "454252", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-11T00:00:00", "totalAmount": 70.44 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -33.72 } }, { "payment": { "id": "462", "note": "Payments of type Cash", "reference": "461144", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-13T00:00:00", "totalAmount": 914.05 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -34.76 } }, { "payment": { "id": "463", "note": "Payments of type PrepaidPayment", "reference": "461243", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-13T00:00:00", "totalAmount": 7.47 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7.47 } }, { "payment": { "id": "470", "note": "Payments of type PrepaidPayment", "reference": "468248", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-13T00:00:00", "totalAmount": 67.83 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -41.38 } }, { "payment": { "id": "481", "note": "Payments of type Cash", "reference": "480129", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-17T00:00:00", "totalAmount": 965.85 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -10.21 } }, { "payment": { "id": "482", "note": "Payments of type PrepaidPayment", "reference": "480242", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-17T00:00:00", "totalAmount": 33.9 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -33.9 } }, { "payment": { "id": "490", "note": "Payments of type Cash", "reference": "489120", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-18T00:00:00", "totalAmount": 1112.76 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -7.74 } }, { "payment": { "id": "491", "note": "Payments of type PrepaidPayment", "reference": "489239", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-18T00:00:00", "totalAmount": 48.74 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -48.74 } }, { "payment": { "id": "499", "note": "Payments of type Cash", "reference": "498147", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-20T00:00:00", "totalAmount": 1017 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -5.08 } }, { "payment": { "id": "500", "note": "Payments of type PrepaidPayment", "reference": "498254", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-20T00:00:00", "totalAmount": 37.77 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -37.77 } }, { "payment": { "id": "507", "note": "Payments of type PrepaidPayment", "reference": "505288", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-20T00:00:00", "totalAmount": 62.82 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -54.62 } }, { "payment": { "id": "521", "note": "Payments of type PrepaidPayment", "reference": "519243", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-02-20T00:00:00", "totalAmount": 14.74 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "647", "note": "Payments of type PrepaidPayment", "reference": "645263", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-03-20T00:00:00", "totalAmount": 40.43 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "705", "note": "Payments of type PrepaidPayment", "reference": "703246", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-04-03T00:00:00", "totalAmount": 25 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -25 } }, { "payment": { "id": "772", "note": "Payments of type PrepaidPayment", "reference": "770263", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-04-24T00:00:00", "totalAmount": 10.35 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "779", "note": "Payments of type PrepaidPayment", "reference": "777217", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-04-24T00:00:00", "totalAmount": 39.55 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "792", "note": "Payments of type PrepaidPayment", "reference": "790262", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-04-29T00:00:00", "totalAmount": 12.46 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "843", "note": "Payments of type PrepaidPayment", "reference": "841264", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-05-07T00:00:00", "totalAmount": 25.64 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "850", "note": "Payments of type PrepaidPayment", "reference": "848254", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-05-14T00:00:00", "totalAmount": 53.68 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } }, { "payment": { "id": "877", "note": "Payments of type PrepaidPayment", "reference": "875210", "accountRef": { "id": "60", "name": "Money (oney)" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-06-01T00:00:00", "totalAmount": 12.7 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -0.01 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 5000, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 5000, "amountDue": 3296.44, "status": "PartiallyPaid", "note": "Invoice for service" } }, "QuickBooks Online Sandbox": { "value": { "id": "30", "invoiceNumber": "1002", "customerRef": { "id": "59", "companyName": "Ecker Holiday event" }, "salesOrderRefs": [], "issueDate": "2016-01-06T00:00:00", "dueDate": "2016-02-05T00:00:00", "modifiedDate": "2023-04-26T09:36:12Z", "sourceModifiedDate": "2023-01-25T13:49:52Z", "paidOnDate": "2016-02-12T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Holiday party - gold level test v1", "unitAmount": 2000, "quantity": 1, "subTotal": 2000, "taxAmount": 400, "totalAmount": 2400, "accountRef": { "id": "44", "name": "Sales" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 }, "itemRef": { "id": "7", "name": "Gold party" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Venue rental", "unitAmount": 10000, "quantity": 1, "subTotal": 10000, "taxAmount": 2000, "totalAmount": 12000, "accountRef": { "id": "68", "name": "Billable Expenses Income" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 }, "itemRef": { "id": "20", "name": "Venue Rental" }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "promotional items -- misc engraved items", "unitAmount": 13.5, "quantity": 75, "subTotal": 1012.5, "taxAmount": 202.5, "totalAmount": 1215, "accountRef": { "id": "68", "name": "Billable Expenses Income" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 }, "itemRef": { "id": "12", "name": "Misc" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "31", "note": "", "accountRef": { "id": "81", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2016-02-12T00:00:00", "totalAmount": 15615 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -15615 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 13012.5, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 2602.5, "totalAmount": 15615, "amountDue": 0, "status": "Paid", "metadata": { "isDeleted": false } } }, "Sage 200cloud": { "value": { "id": "82322", "invoiceNumber": "0000000110", "customerRef": { "id": "A1D001", "companyName": "A1 Design Services" }, "salesOrderRefs": [], "issueDate": "2020-07-13T00:00:00Z", "dueDate": "2020-08-12T00:00:00Z", "modifiedDate": "2022-10-14T09:36:12Z", "sourceModifiedDate": "2020-07-13T11:06:40Z", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Tax Summary - Standard rate", "unitAmount": 0, "quantity": 0, "discountAmount": 0.22, "subTotal": 0, "taxAmount": 8.67, "totalAmount": 8.67, "taxRateRef": { "id": "1729", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [], "isDirectIncome": false }, { "description": "Goods Summary", "unitAmount": 0, "quantity": 0, "discountAmount": 1.08, "subTotal": 43.34, "taxAmount": 0, "totalAmount": 43.34, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "totalDiscount": 1.3, "subTotal": 43.34, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 8.67, "totalAmount": 52.01, "amountDue": 52.01, "discountPercentage": 2.49, "status": "Submitted", "note": "0000000114" } }, "Sage 50 (UK)": { "value": { "id": "INV-1", "invoiceNumber": "1", "customerRef": { "id": "A1D001", "companyName": "A1 Design Services" }, "salesOrderRefs": [], "issueDate": "2021-01-02T00:00:00", "modifiedDate": "2023-03-30T14:42:42Z", "sourceModifiedDate": "2022-11-25T09:43:54", "paidOnDate": "2022-01-29T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "AT Mini Tower Case", "unitAmount": 14.25, "quantity": 1, "discountAmount": 0, "subTotal": 14.25, "taxAmount": 2.43, "totalAmount": 16.68, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Whiteboard - Drywipe (900 x 1200)", "unitAmount": 19, "quantity": 4, "discountAmount": 0, "subTotal": 76, "taxAmount": 12.97, "totalAmount": 88.97, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "A4 Ledger Book - 5 Column", "unitAmount": 7.59, "quantity": 8, "discountAmount": 0, "subTotal": 60.72, "taxAmount": 10.36, "totalAmount": 71.08, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Shorthand Notebook - 80 Sheets", "unitAmount": 4.27, "quantity": 20, "discountAmount": 0, "subTotal": 85.4, "taxAmount": 14.57, "totalAmount": 99.97, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Calculator - Desktop", "unitAmount": 9.5, "quantity": 1, "discountAmount": 0, "subTotal": 9.5, "taxAmount": 1.62, "totalAmount": 11.12, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Calculator - Desktop (Printing)", "unitAmount": 16.15, "quantity": 1, "discountAmount": 0, "subTotal": 16.15, "taxAmount": 2.76, "totalAmount": 18.91, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Calculator - Printing Rolls", "unitAmount": 5.7, "quantity": 15, "discountAmount": 0, "subTotal": 85.5, "taxAmount": 14.59, "totalAmount": 100.09, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Correction Fluid - White", "unitAmount": 2.37, "quantity": 7, "discountAmount": 0, "subTotal": 16.59, "taxAmount": 2.83, "totalAmount": 19.42, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Envelope - White (110 x 220) Plain", "unitAmount": 8.54, "quantity": 20, "discountAmount": 0, "subTotal": 170.8, "taxAmount": 29.14, "totalAmount": 199.94, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Flip Chart - A1 Pad", "unitAmount": 15.2, "quantity": 10, "discountAmount": 0, "subTotal": 152, "taxAmount": 25.94, "totalAmount": 177.94, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Laminator Pouches - A4", "unitAmount": 11.4, "quantity": 5, "discountAmount": 0, "subTotal": 57, "taxAmount": 9.73, "totalAmount": 66.73, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Mouse Mat - (241 x 203) Blue", "unitAmount": 1.42, "quantity": 5, "discountAmount": 0, "subTotal": 7.1, "taxAmount": 1.21, "totalAmount": 8.31, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Copy Paper - Economy Grade", "unitAmount": 2.46, "quantity": 80, "discountAmount": 0, "subTotal": 196.8, "taxAmount": 33.58, "totalAmount": 230.38, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Coloured Paper - Pastel Blue", "unitAmount": 3.61, "quantity": 5, "discountAmount": 0, "subTotal": 18.05, "taxAmount": 3.08, "totalAmount": 21.13, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Ball Point Pen - Black", "unitAmount": 1.9, "quantity": 8, "discountAmount": 0, "subTotal": 15.2, "taxAmount": 2.59, "totalAmount": 17.79, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Pencil - HB", "unitAmount": 2.37, "quantity": 3, "discountAmount": 0, "subTotal": 7.11, "taxAmount": 1.21, "totalAmount": 8.32, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Remember-Me Sticky Notes (Recycled)", "unitAmount": 3.32, "quantity": 6, "discountAmount": 0, "subTotal": 19.92, "taxAmount": 3.4, "totalAmount": 23.32, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Scissors - Economy", "unitAmount": 2.85, "quantity": 1, "discountAmount": 0, "subTotal": 2.85, "taxAmount": 0.49, "totalAmount": 3.34, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Adhesive Tape - Brown (50mm x 66m)", "unitAmount": 2.66, "quantity": 5, "discountAmount": 0, "subTotal": 13.3, "taxAmount": 2.27, "totalAmount": 15.57, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "JP010 Jet Printer Cartridge", "unitAmount": 17.1, "quantity": 5, "discountAmount": 0, "subTotal": 85.5, "taxAmount": 14.59, "totalAmount": 100.09, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false }, { "description": "Letter Trays - 3 pack (Red)", "unitAmount": 6.65, "quantity": 2, "discountAmount": 0, "subTotal": 13.3, "taxAmount": 2.27, "totalAmount": 15.57, "accountRef": { "id": "4000", "name": "Sales North" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -8.32 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -11.12 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -8.31 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -19.42 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -15.57 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -21.13 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -99.97 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -23.32 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -18.91 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -16.68 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -100.09 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -199.94 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -3.34 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -15.57 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -100.09 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -66.73 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -117.5 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -177.94 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -230.38 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -17.79 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -71.08 } }, { "payment": { "id": "265", "note": "Sales receipt 265 linked to sales invoice inv-1.", "accountRef": { "id": "1200", "name": "Bank Current Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-01-29T00:00:00", "totalAmount": 1432.17 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -88.97 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 1223.04, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 209.13, "totalAmount": 1432.17, "amountDue": 0, "status": "Paid", "note": "", "metadata": { "isDeleted": false } } }, "Sage Business Cloud Accounting": { "value": { "id": "b039b0a733de11e797950a57719b2edb", "invoiceNumber": "SI-1", "customerRef": { "id": "f4ff85ba33dd11e797950a57719b2edb", "companyName": "Widgets Limited" }, "salesOrderRefs": [], "issueDate": "2017-05-08T00:00:00", "dueDate": "2017-06-07T00:00:00", "modifiedDate": "2022-10-24T15:03:37Z", "sourceModifiedDate": "2021-07-23T13:42:59Z", "paidOnDate": "2021-07-23T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Consulting services", "unitAmount": 900, "quantity": 8, "discountAmount": 0, "subTotal": 7200, "taxAmount": 1440, "totalAmount": 8640, "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" }, "discountPercentage": 0, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 }, "itemRef": { "id": "a87b922b33de11e797950a57719b2edb", "name": "Consulting services" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "52237e4e215911e8b45c025132dab352", "note": "Customer receipt using credit/debit card", "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-01-02T00:00:00", "totalAmount": 4000 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -4000 } }, { "payment": { "id": "579388a0215911e8b45c025132dab352", "note": "Customer receipt using credit/debit card", "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-01-02T00:00:00", "totalAmount": 1400 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -1400 } }, { "payment": { "id": "e1c2bd659a6111e8bad90617b3da4b8a", "note": "Sales credit note", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-08-07T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -1000 } }, { "payment": { "id": "e1c2bd659a6111e8bad90617b3da4b8a", "note": "Sales credit note", "currency": "GBP", "currencyRate": 1, "paidOnDate": "2018-08-07T00:00:00", "totalAmount": 0 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -1000 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 7200, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 1440, "totalAmount": 8640, "amountDue": 1240, "status": "PartiallyPaid" } }, "Sage Intacct": { "value": { "id": "2916", "invoiceNumber": "IN0480", "customerRef": { "id": "12", "companyName": "MK Manufacturing" }, "salesOrderRefs": [], "issueDate": "2021-04-22T00:00:00", "dueDate": "2021-05-22T00:00:00", "modifiedDate": "2023-04-04T16:31:54Z", "sourceModifiedDate": "2021-04-22T11:01:11Z", "paidOnDate": "2021-04-22T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "unitAmount": 100, "quantity": 1, "subTotal": 100, "taxAmount": 20, "totalAmount": 120, "accountRef": { "id": "176", "name": "Revenue - Services" }, "taxRateRef": { "id": "105", "name": "UK Sale Services Standard Rate", "effectiveTaxRate": 20 }, "trackingCategoryRefs": [ { "id": "CUSTOMER-12", "name": "MK Manufacturing" }, { "id": "DEPARTMENT-2", "name": "Services" }, { "id": "LOCATION-11", "name": "Codat Test Entity" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "2918", "note": "", "accountRef": { "id": "353", "name": "Current Account" }, "currency": "GBP", "paidOnDate": "2021-04-22T00:00:00", "totalAmount": 120 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -120 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 100, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 20, "totalAmount": 120, "amountDue": 0, "status": "Paid", "metadata": { "isDeleted": false } } }, "Wave": { "value": { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6NzgyNDQ4OTg1Nzc1MzE5MTYw", "invoiceNumber": "1", "customerRef": { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4", "companyName": "ABC Textiles" }, "salesOrderRefs": [], "issueDate": "2019-10-17T00:00:00", "dueDate": "2019-10-17T00:00:00", "modifiedDate": "2022-11-16T18:15:23Z", "sourceModifiedDate": "2019-12-05T23:20:36Z", "paidOnDate": "2019-12-05T23:20:36Z", "currency": "USD", "currencyRate": 0.784736781, "lineItems": [ { "description": "", "unitAmount": 10, "quantity": 5, "subTotal": 50, "taxAmount": 2.5, "totalAmount": 52.5, "accountRef": { "id": "QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2", "name": "Sales" }, "itemRef": { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjcyNTI=", "name": "Golf balls" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "subTotal": 50, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 2.5, "totalAmount": 52.5, "amountDue": 0, "status": "Paid" } }, "Xero": { "value": { "id": "321bfed3-2da2-4969-9358-4de97821181b", "invoiceNumber": "INV-001-0", "customerRef": { "id": "afd4093b-c655-4847-8ee2-10a4f2c3eae3", "companyName": "Maddox Publishing Group" }, "salesOrderRefs": [], "issueDate": "2021-12-20T00:00:00", "dueDate": "2022-01-17T00:00:00", "modifiedDate": "2023-03-15T20:38:11Z", "sourceModifiedDate": "2021-01-02T20:34:51", "paidOnDate": "2022-02-17T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Project management - onsite daily rate - your CRM integration project", "unitAmount": 583.3333333333, "quantity": 6, "discountAmount": 0, "subTotal": 3500, "taxAmount": 700, "totalAmount": 4200, "accountRef": { "id": "a969500a-377c-4cea-8f2b-a4e385607fd0", "name": "Other Revenue" }, "discountPercentage": 0, "taxRateRef": { "id": "OUTPUT2", "name": "20% (VAT on Income)", "effectiveTaxRate": 20 }, "itemRef": { "id": "aa1c5f84-4453-42fa-9c92-69d4085607c9", "name": "Project management - daily rate" }, "trackingCategoryRefs": [ { "id": "34b9b859-07a9-451a-b4d3-effc9946634a", "name": "North" } ], "isDirectIncome": false } ], "paymentAllocations": [ { "payment": { "id": "65b746c8-9a5d-4a95-8096-d2316fcff592", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2022-02-17T00:00:00", "totalAmount": 4200 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -4200 } } ], "withholdingTax": [], "totalDiscount": 0, "subTotal": 3500, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 700, "totalAmount": 4200, "amountDue": 0, "status": "Paid", "metadata": { "isDeleted": false } } }, "Zoho Books": { "value": { "id": "104957000000038034", "invoiceNumber": "INV-102", "customerRef": { "id": "104957000000037097", "companyName": "Test Company" }, "salesOrderRefs": [], "issueDate": "2020-02-06T10:54:03", "dueDate": "2020-02-17T00:00:00", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2020-05-19T15:36:26", "paidOnDate": "2020-05-19T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [], "paymentAllocations": [ { "payment": { "id": "104957000000129048", "note": "", "reference": "9", "accountRef": { "id": "104957000000000349", "name": "Petty Cash" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-04-29T00:00:00", "totalAmount": 9000 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -9000 } }, { "payment": { "id": "104957000000137017", "note": "", "reference": "11", "accountRef": { "id": "104957000000060010", "name": "Abdi Test" }, "currency": "GBP", "currencyRate": 1, "paidOnDate": "2020-05-19T00:00:00", "totalAmount": 9000 }, "allocation": { "currency": "GBP", "currencyRate": 1, "totalAmount": -1 } } ], "withholdingTax": [], "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 9001, "amountDue": 0, "status": "Paid" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get invoice", "description": "The *Get invoice* endpoint returns a single invoice for a given invoiceId.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting a specific invoice.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n\n### Tips and traps\n\nTo access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache.\n", "operationId": "get-invoice" } }, "/companies/{companyId}/data/invoices/{invoiceId}/pdf": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Invoices" ], "parameters": [ { "$ref": "#/components/parameters/invoiceId" } ], "responses": { "200": { "description": "Success", "content": { "application/pdf": { "schema": { "title": "Data", "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get invoice as PDF", "description": "Download invoice as a pdf.", "operationId": "download-invoice-pdf", "x-speakeasy-name-override": "download-pdf" } }, "/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "tags": [ "Invoices" ], "parameters": [ { "$ref": "#/components/parameters/invoiceId" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentsDataset" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "List invoice attachments", "description": "The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support listing invoice attachments.\n", "operationId": "list-invoice-attachments" } }, "/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "tags": [ "Invoices" ], "parameters": [ { "$ref": "#/components/parameters/invoiceId" }, { "$ref": "#/components/parameters/attachmentId" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get invoice attachment", "description": "The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting an invoice attachment.\n", "operationId": "get-invoice-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}/download": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "tags": [ "Invoices" ], "parameters": [ { "$ref": "#/components/parameters/invoiceId" }, { "$ref": "#/components/parameters/attachmentId" } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "title": "Data", "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Download invoice attachment", "description": "The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support downloading an invoice attachment.\n", "operationId": "download-invoice-attachment" } }, "/companies/{companyId}/connections/{connectionId}/options/invoices": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create/update invoice model", "tags": [ "Invoices" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "FreeAgent": { "value": { "type": "Object", "displayName": "Invoice", "description": "An invoice is an itemised record of goods sold or services rendered to a customer", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the invoice has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The issuing date of the invoice", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the invoice is due to be paid by", "required": false, "validation": { "warnings": [], "information": [ { "field": "DueDate", "details": "If not specified, payment terms will default to 0 days (due on receipt)" } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the invoice", "options": [ { "value": "AED", "type": "String", "displayName": "AED", "required": false }, { "value": "AMD", "type": "String", "displayName": "AMD", "required": false }, { "value": "AOA", "type": "String", "displayName": "AOA", "required": false }, { "value": "ARS", "type": "String", "displayName": "ARS", "required": false }, { "value": "AUD", "type": "String", "displayName": "AUD", "required": false }, { "value": "AWG", "type": "String", "displayName": "AWG", "required": false }, { "value": "AZN", "type": "String", "displayName": "AZN", "required": false }, { "value": "BBD", "type": "String", "displayName": "BBD", "required": false }, { "value": "BDT", "type": "String", "displayName": "BDT", "required": false }, { "value": "BGN", "type": "String", "displayName": "BGN", "required": false }, { "value": "BRL", "type": "String", "displayName": "BRL", "required": false }, { "value": "BWP", "type": "String", "displayName": "BWP", "required": false }, { "value": "CAD", "type": "String", "displayName": "CAD", "required": false }, { "value": "CHF", "type": "String", "displayName": "CHF", "required": false }, { "value": "CLP", "type": "String", "displayName": "CLP", "required": false }, { "value": "CNY", "type": "String", "displayName": "CNY", "required": false }, { "value": "COP", "type": "String", "displayName": "COP", "required": false }, { "value": "CRC", "type": "String", "displayName": "CRC", "required": false }, { "value": "CUC", "type": "String", "displayName": "CUC", "required": false }, { "value": "CUP", "type": "String", "displayName": "CUP", "required": false }, { "value": "CZK", "type": "String", "displayName": "CZK", "required": false }, { "value": "DKK", "type": "String", "displayName": "DKK", "required": false }, { "value": "DOP", "type": "String", "displayName": "DOP", "required": false }, { "value": "EGP", "type": "String", "displayName": "EGP", "required": false }, { "value": "EUR", "type": "String", "displayName": "EUR", "required": false }, { "value": "FJD", "type": "String", "displayName": "FJD", "required": false }, { "value": "GBP", "type": "String", "displayName": "GBP", "required": false }, { "value": "GEL", "type": "String", "displayName": "GEL", "required": false }, { "value": "GHS", "type": "String", "displayName": "GHS", "required": false }, { "value": "GTQ", "type": "String", "displayName": "GTQ", "required": false }, { "value": "GYD", "type": "String", "displayName": "GYD", "required": false }, { "value": "HKD", "type": "String", "displayName": "HKD", "required": false }, { "value": "HNL", "type": "String", "displayName": "HNL", "required": false }, { "value": "HRK", "type": "String", "displayName": "HRK", "required": false }, { "value": "HUF", "type": "String", "displayName": "HUF", "required": false }, { "value": "IDR", "type": "String", "displayName": "IDR", "required": false }, { "value": "ILS", "type": "String", "displayName": "ILS", "required": false }, { "value": "INR", "type": "String", "displayName": "INR", "required": false }, { "value": "ISK", "type": "String", "displayName": "ISK", "required": false }, { "value": "JMD", "type": "String", "displayName": "JMD", "required": false }, { "value": "JPY", "type": "String", "displayName": "JPY", "required": false }, { "value": "KES", "type": "String", "displayName": "KES", "required": false }, { "value": "KRW", "type": "String", "displayName": "KRW", "required": false }, { "value": "KWD", "type": "String", "displayName": "KWD", "required": false }, { "value": "KYD", "type": "String", "displayName": "KYD", "required": false }, { "value": "KZT", "type": "String", "displayName": "KZT", "required": false }, { "value": "LAK", "type": "String", "displayName": "LAK", "required": false }, { "value": "LBP", "type": "String", "displayName": "LBP", "required": false }, { "value": "LKR", "type": "String", "displayName": "LKR", "required": false }, { "value": "LTL", "type": "String", "displayName": "LTL", "required": false }, { "value": "LVL", "type": "String", "displayName": "LVL", "required": false }, { "value": "MAD", "type": "String", "displayName": "MAD", "required": false }, { "value": "MDL", "type": "String", "displayName": "MDL", "required": false }, { "value": "MGA", "type": "String", "displayName": "MGA", "required": false }, { "value": "MUR", "type": "String", "displayName": "MUR", "required": false }, { "value": "MVR", "type": "String", "displayName": "MVR", "required": false }, { "value": "MWK", "type": "String", "displayName": "MWK", "required": false }, { "value": "MXN", "type": "String", "displayName": "MXN", "required": false }, { "value": "MYR", "type": "String", "displayName": "MYR", "required": false }, { "value": "MZN", "type": "String", "displayName": "MZN", "required": false }, { "value": "NAD", "type": "String", "displayName": "NAD", "required": false }, { "value": "NGN", "type": "String", "displayName": "NGN", "required": false }, { "value": "NOK", "type": "String", "displayName": "NOK", "required": false }, { "value": "NPR", "type": "String", "displayName": "NPR", "required": false }, { "value": "NZD", "type": "String", "displayName": "NZD", "required": false }, { "value": "OMR", "type": "String", "displayName": "OMR", "required": false }, { "value": "PEN", "type": "String", "displayName": "PEN", "required": false }, { "value": "PHP", "type": "String", "displayName": "PHP", "required": false }, { "value": "PKR", "type": "String", "displayName": "PKR", "required": false }, { "value": "PLN", "type": "String", "displayName": "PLN", "required": false }, { "value": "QAR", "type": "String", "displayName": "QAR", "required": false }, { "value": "RON", "type": "String", "displayName": "RON", "required": false }, { "value": "RSD", "type": "String", "displayName": "RSD", "required": false }, { "value": "RUB", "type": "String", "displayName": "RUB", "required": false }, { "value": "RWF", "type": "String", "displayName": "RWF", "required": false }, { "value": "SAR", "type": "String", "displayName": "SAR", "required": false }, { "value": "SCR", "type": "String", "displayName": "SCR", "required": false }, { "value": "SEK", "type": "String", "displayName": "SEK", "required": false }, { "value": "SGD", "type": "String", "displayName": "SGD", "required": false }, { "value": "THB", "type": "String", "displayName": "THB", "required": false }, { "value": "TND", "type": "String", "displayName": "TND", "required": false }, { "value": "TRY", "type": "String", "displayName": "TRY", "required": false }, { "value": "TTD", "type": "String", "displayName": "TTD", "required": false }, { "value": "TWD", "type": "String", "displayName": "TWD", "required": false }, { "value": "TZS", "type": "String", "displayName": "TZS", "required": false }, { "value": "UAH", "type": "String", "displayName": "UAH", "required": false }, { "value": "UGX", "type": "String", "displayName": "UGX", "required": false }, { "value": "USD", "type": "String", "displayName": "USD", "required": false }, { "value": "UYU", "type": "String", "displayName": "UYU", "required": false }, { "value": "VEF", "type": "String", "displayName": "VEF", "required": false }, { "value": "VND", "type": "String", "displayName": "VND", "required": false }, { "value": "VUV", "type": "String", "displayName": "VUV", "required": false }, { "value": "XAF", "type": "String", "displayName": "XAF", "required": false }, { "value": "XCD", "type": "String", "displayName": "XCD", "required": false }, { "value": "XOF", "type": "String", "displayName": "XOF", "required": false }, { "value": "ZAR", "type": "String", "displayName": "ZAR", "required": false }, { "value": "ZMK", "type": "String", "displayName": "ZMK", "required": false } ], "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "If not specified, defaults to the company's native currency" } ] } }, "status": { "type": "String", "displayName": "Invoice Status", "description": "The current state of the invoice", "options": [ { "value": "Draft", "type": "String", "displayName": "Draft", "required": false }, { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the invoice", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": false }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "The FreeAgent income category" } ] } } }, "required": false } }, "required": true } }, "required": true } }, "FreshBooks": { "value": { "type": "Object", "displayName": "Invoice", "description": "An invoice is an itemised record of goods sold or services rendered to a customer", "properties": { "invoiceNumber": { "type": "String", "displayName": "Invoice Number", "description": "User friendly reference identifier for the invoice", "required": false }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the invoice has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must be valid Customer Id" } ], "information": [] } } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The issuing date of the invoice", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the invoice is due to be paid by", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the invoice", "required": false }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": false }, "status": { "type": "String", "displayName": "Invoice Status", "description": "The current state of the invoice", "options": [ { "value": "Draft", "type": "Array", "displayName": "Draft", "required": false }, { "value": "Submitted", "type": "Array", "displayName": "Open", "required": false } ], "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the invoice", "required": false }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the invoice", "properties": { "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "required": false } }, "required": false } }, "required": true } }, "MYOB AccountRight and Essentials": { "value": { "type": "Object", "displayName": "Invoice", "description": "An invoice is an itemised record of goods sold or services rendered to a customer", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the invoice, inclusive of tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must be greater than zero." } ], "information": [ { "field": "TotalAmount", "details": "Must be provided." } ] } }, "invoiceNumber": { "type": "String", "displayName": "Invoice Number", "description": "User friendly reference identifier for the invoice", "required": false, "validation": { "warnings": [], "information": [ { "field": "InvoiceNumber", "details": "Must not be greater than 8 characters long." } ] } }, "totalDiscount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given invoice currency, of any discounts applied", "required": false, "validation": { "warnings": [], "information": [ { "field": "TotalDiscount", "details": "Precision must be maximum of two decimal places." } ] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the invoice excluding any taxes", "required": false, "validation": { "warnings": [], "information": [ { "field": "SubTotal", "details": "Precision must be maximum of two decimal places." } ] } }, "additionalTaxAmount": { "type": "Number", "displayName": "Additional Tax Amount", "description": "Tax added to the total tax of the lines", "required": false, "validation": { "warnings": [], "information": [ { "field": "AdditionalTaxAmount", "details": "Precision must be maximum of two decimal places." } ] } }, "totalTaxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the invoice", "required": false, "validation": { "warnings": [], "information": [ { "field": "TotalTaxAmount", "details": "Precision must be maximum of two decimal places." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the invoice", "options": [ { "value": "AUD", "type": "String", "displayName": "Australian Dollar", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Must be provided." } ] } }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The issuing date of the invoice", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must not be before the due date." } ] } }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the invoice is due to be paid by", "required": true, "validation": { "warnings": [], "information": [ { "field": "DueDate", "details": "Must be provided." } ] } }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the invoice has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [], "information": [ { "field": "CustomerRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "CustomerRef", "details": "Must be provided." } ] } }, "amountDue": { "type": "Number", "displayName": "Amount Due", "description": "The amount outstanding on the invoice", "required": false, "validation": { "warnings": [], "information": [ { "field": "AmountDue", "details": "Precision must be maximum of two decimal places." }, { "field": "AmountDue", "details": "Must be at least zero and no more than that the total amount." } ] } }, "status": { "type": "String", "displayName": "Invoice Status", "description": "The current state of the invoice", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the invoice", "properties": { "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.AccountRef", "details": "Must be provided." } ] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [], "information": [ { "field": "ItemRef.Id", "details": "Must be provided." } ] } } }, "required": false }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [], "information": [ { "field": "TaxRateRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxRateRef", "details": "Must be provided." } ] } }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.Description", "details": "Must not be greater than 225 characters long." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TotalAmount", "details": "Precision must be maximum of two decimal places." }, { "field": "LineItems.TotalAmount", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Precision must be maximum of two decimal places." }, { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false, "validation": { "warnings": [ { "field": "LineItems.SubTotal", "details": "Precision must be maximum of two decimal places." } ], "information": [] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxAmount", "details": "Precision must be maximum of two decimal places." } ], "information": [] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must be provided." } ] } } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "Invoice", "description": "An invoice is an itemised record of goods sold or services rendered to a customer", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the invoice has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The issuing date of the invoice", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the invoice is due to be paid by", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the invoice", "required": false }, "status": { "type": "String", "displayName": "Invoice Status", "description": "The current state of the invoice", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the invoice", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": false, "validation": { "warnings": [ { "field": "LineItems.UnitAmount", "details": "Must not be provided for 'Discount' type items" } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Quantity", "details": "Must not be provided for 'Discount' type items" } ], "information": [] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false, "validation": { "warnings": [ { "field": "LineItems.SubTotal", "details": "Must be provided if and only if item does not have type 'Discount'" } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": false } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxRateRef", "details": "Must be provided if item does not have type 'Discount'" } ], "information": [] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [], "information": [ { "field": "TrackingCategoryRefs.Id", "details": "A single location tracking category must be present on all LineItems. Optionally, a single classification tracking category may be present on all LineItems. Also optionally, a single department tracking category may be present on all LineItems." } ] } } }, "required": true } }, "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the invoice", "required": false } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Invoice", "description": "An invoice is an itemised record of goods sold or services rendered to a customer", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the invoice has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must match the ID of an existing customer." } ], "information": [] } } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The issuing date of the invoice", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the invoice is due to be paid by", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the invoice, inclusive of tax", "required": false, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must match the sum of total amounts in the line items." } ], "information": [] } }, "totalTaxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the invoice", "required": true, "validation": { "warnings": [ { "field": "TotalTaxAmount", "details": "Must match the sum of tax amounts in the line items." } ], "information": [] } }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the invoice excluding any taxes", "required": false, "validation": { "warnings": [ { "field": "SubTotal", "details": "Must match the sum of sub totals in the line items." } ], "information": [] } }, "invoiceNumber": { "type": "String", "displayName": "Invoice Number", "description": "User friendly reference identifier for the invoice", "required": false, "validation": { "warnings": [ { "field": "InvoiceNumber", "details": "Max length of 11 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the invoice", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "Must be a three letter ISO code that matches the currency of the customer" }, { "field": "Currency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "Currency", "details": "If not set, will default to the default currency of the customer" } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the invoice", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Max length of 4000 characters." } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the invoice and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1." }, { "field": "CurrencyRate", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ] } }, "status": { "type": "String", "displayName": "Invoice Status", "description": "The current state of the invoice", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the invoice", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Max length of 4000 characters." } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [ { "field": "ItemRef.ItemRef", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "For US versions of QuickBooks Desktop, this must be a Tax Code" }, { "field": "TaxRateRef.Id", "details": "For US versions of QuickBooks Desktop, this can only be set when Sales Tax is enabled; must be either 'Tax' or 'Non'" } ], "information": [] } } }, "required": false }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.Id", "details": "Must match the ID of an existing tracking category." } ], "information": [] } } }, "required": false }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given invoice currency, of any discounts applied", "required": false, "validation": { "warnings": [ { "field": "LineItems.DiscountAmount", "details": "Can only be set if the line items itemRef refers to an item of type discount" } ], "information": [] } }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": false, "validation": { "warnings": [ { "field": "LineItems.DiscountPercentage", "details": "Can only be set if the line items itemRef refers to an item of type discount" } ], "information": [] } } }, "required": true } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Invoice", "description": "An invoice is an itemised record of goods sold or services rendered to a customer", "properties": { "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the invoice is due to be paid by", "required": true, "validation": { "warnings": [], "information": [ { "field": "DueDate", "details": "Must be provided." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the invoice", "required": true, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Must be provided." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the invoice and the base currency of the company", "required": false, "validation": { "warnings": [ { "field": "CurrencyRate", "details": "Must not be less than 0." } ], "information": [ { "field": "CurrencyRate", "details": "Required if Currency is not the base currency." } ] } }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the invoice has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must match the ID of an existing customer." } ], "information": [ { "field": "CustomerRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the invoice", "required": false }, "status": { "type": "String", "displayName": "Invoice Status", "description": "The current state of the invoice", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "QuickBooks Online only supports \"Submitted\" as a status for new invoices." } ] } }, "totalDiscount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given invoice currency, of any discounts applied", "required": false }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": false, "validation": { "warnings": [ { "field": "DiscountPercentage", "details": "If provided must be a number between 0 and 100." } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the invoice", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Maximum character length should not be longer than 4000." } ], "information": [ { "field": "LineItems.Description", "details": "Must be provided." } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [ { "field": "ItemRef.Id", "details": "When set to SHIPPING_ITEM_ID, the item will represent shipping." }, { "field": "ItemRef.Id", "details": "If not provided, will use the default item set for the company." } ] } } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.Id", "details": "A tracking category of type CLASS can only be provided if ClassTrackingPerTxnLine is enabled for the QBO company." }, { "field": "TrackingCategoryRefs.Id", "details": "Only one tracking category of type CLASS can be provided per item." }, { "field": "TrackingCategoryRefs.Id", "details": "A tracking category of type DEPARTMENT should be declared at the top level item (first line item)." }, { "field": "TrackingCategoryRefs.Id", "details": "A tracking category of type DEPARTMENT can only be provided if TrackDepartments is enabled for the QBO company." }, { "field": "TrackingCategoryRefs.Id", "details": "Only one tracking category of type DEPARTMENT can be provided per invoice." }, { "field": "TrackingCategoryRefs.Id", "details": "Must match the ID of an existing tracking category and be of type DEPARTMENT or CLASS." } ], "information": [] } } }, "required": false }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax code." } ], "information": [ { "field": "TaxRateRef.Id", "details": "If an organisation has Automated Sales Tax enabled for US locales, then 'TAX' (Automated Sales Tax), 'NON' (no tax) or a custom tax rate can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) will not be accepted and a different tax rate must be used." }, { "field": "TaxRateRef.Id", "details": "Must be provided." } ] } } }, "required": true } }, "required": true }, "totalTaxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the invoice", "required": false, "validation": { "warnings": [], "information": [ { "field": "TotalTaxAmount", "details": "Tax will not be overridden if TotalTaxAmount is 0." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Automated Sales Tax is disabled for this company." } ] } } }, "Sage 50 (UK)": { "value": { "type": "Object", "displayName": "Invoice", "description": "An invoice is an itemised record of goods sold or services rendered to a customer", "properties": { "customerRef": { "type": "Object", "displayName": "Customer", "description": "Customer to be invoiced.", "properties": { "id": { "type": "String", "displayName": "Customer Id", "description": "Identifier of the customer.", "required": true, "validation": { "warnings": [ { "field": "customerRef.id", "details": "Must match the ID of an existing customer and have a max length of 8 characters." } ], "information": [] } } }, "required": true }, "note": { "type": "String", "displayName": "Note", "description": "To be used for any additional information associated with the invoice.", "required": false, "validation": { "warnings": [ { "field": "note", "details": "Maximum 60 characters" } ], "information": [] } }, "invoiceNumber": { "type": "String", "displayName": "Invoice Number", "description": "The reference number for this invoice", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency in which the invoice is issued in.", "required": true, "validation": { "warnings": [ { "field": "currency", "details": "This must match the customer's default currency." } ], "information": [] } }, "status": { "type": "String", "displayName": "Status", "description": "The status of the invoice", "options": [ { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": false, "validation": { "warnings": [], "information": [ { "field": "status", "details": "If this is not set, it will default to 'Submitted'." } ] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "Line items of the invoice.", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Identifier for the account.", "properties": { "id": { "type": "String", "displayName": "Account Id", "description": "Identifier of the account.", "required": true, "validation": { "warnings": [ { "field": "accountRef.id", "details": "Must match the ID of an existing account. The account must also not be a bank account" } ], "information": [] } } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Tax rate reference of a invoice line item.", "properties": { "id": { "type": "String", "displayName": "Tax Rate Id", "description": "ID of the tax rate.", "required": true, "validation": { "warnings": [ { "field": "taxRateRef.id", "details": "Must match the ID of an existing tax rate." } ], "information": [] } } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Categories", "description": "Tracking categories for the line item", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "Prefixed identifier for tracking category e.g. project_{x}, department_{x}", "required": true, "validation": { "warnings": [ { "field": "trackingCategoryRefs.id", "details": "Projects assigned with project_{x} must exist in Sage50" }, { "field": "trackingCategoryRefs.id", "details": "Departments assigned with department_{x} must exist in Sage50" } ], "information": [] } } }, "required": false } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company." } ] } } }, "Sage Business Cloud Accounting": { "value": { "type": "Object", "displayName": "Invoice", "description": "An invoice is an itemised record of goods sold or services rendered to a customer", "properties": { "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The issuing date of the invoice", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must be provided." } ] } }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the invoice has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must match the ID of an existing customer." } ], "information": [ { "field": "CustomerRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the invoice", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "If supplied, must match the currency of the customer." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the invoice and the base currency of the company", "required": false }, "note": { "type": "String", "displayName": "Note", "description": "Note about the invoice", "required": false }, "status": { "type": "String", "displayName": "Invoice Status", "description": "The current state of the invoice", "options": [ { "value": "Draft", "type": "String", "displayName": "Draft", "required": false }, { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": false }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the invoice", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Should not be longer than 2000 characters." } ], "information": [ { "field": "LineItems.Description", "details": "Must be provided." } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TotalAmount", "details": "If supplied, must match the total of the line including tax." } ] } }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxAmount", "details": "Must be provided." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax rate." } ], "information": [ { "field": "TaxRateRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must be provided." } ] } } }, "required": true } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "Invoice", "description": "An invoice is an itemised record of goods sold or services rendered to a customer", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the invoice has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The issuing date of the invoice", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the invoice is due to be paid by", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the invoice", "required": false }, "status": { "type": "String", "displayName": "Invoice Status", "description": "The current state of the invoice", "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "Must be either Draftor Submitted." } ] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the invoice", "properties": { "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [], "information": [ { "field": "ItemRef.Id", "details": "Must be set for all line items when creating a sales invoice otherwise this field must be empty." } ] } } }, "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be greater than zero." } ] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [], "information": [ { "field": "TrackingCategoryRefs.Id", "details": "Is optional when creating an invoice." }, { "field": "TrackingCategoryRefs.Id", "details": "When creating a sales invoice WAREHOUSE must be supplied." }, { "field": "TrackingCategoryRefs.Id", "details": "When creating a sales invoice the ITEM category id must match the ItemRef.Id." }, { "field": "TrackingCategoryRefs.Id", "details": "Available tracking categories DEPARTMENT, LOCATION, CLASS, ITEM, PROJECT, WAREHOUSE, TASK, CONTRACT, CUSTOMER, SUPPLIER." }, { "field": "TrackingCategoryRefs.Id", "details": "Must take the form 'TrackingCategoryName-XYZ' e.g. to track an item with id 123 the id must be ITEM-123" } ] } } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Must not be set when creating a sales invoice." }, { "field": "AccountRef.Id", "details": "Must be set when creating an invoice." } ] } } }, "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be greater than 0 for a sales invoice." }, { "field": "LineItems.Quantity", "details": "Must be set to 1 for an invoice." } ] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [], "information": [ { "field": "TaxRateRef.Id", "details": "Must not be set for a sales invoice." }, { "field": "TaxRateRef.Id", "details": "Must be set for an invoice." } ] } } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must contain at least one line item." } ] } } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Invoice", "description": "An invoice is an itemised record of goods sold or services rendered to a customer", "properties": { "invoiceNumber": { "type": "String", "displayName": "Invoice Number", "description": "User friendly reference identifier for the invoice", "required": true }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the invoice has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true }, "companyName": { "type": "String", "displayName": "Name", "description": "The name of the customer referenced by the identifier", "required": true } }, "required": true }, "salesOrderRefs": { "type": "Array", "displayName": "Sales Order References", "description": "References to related Sales Orders", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The issuing date of the invoice", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the invoice is due to be paid by", "required": true }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date that the invoice was fully paid", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the invoice", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the invoice and the base currency of the company", "required": true }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the invoice", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given invoice currency, of any discounts applied", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The amount of the line, inclusive of discounts but exclusive of tax", "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": true }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": true } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the item referenced by the identifier", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": true } }, "required": true }, "tracking": { "type": "Object", "displayName": "Accounts Receivable Tracking", "description": "A collection of items this line item is being tracked against", "properties": { "categoryRefs": { "type": "Array", "displayName": "Category References", "description": "A collection of categories this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": true } }, "required": true }, "projectRef": { "type": "Object", "displayName": "Project Reference", "description": "Reference to the project this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the Project", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the Project referenced by the identifier", "required": true } }, "required": true }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer this line item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true }, "companyName": { "type": "String", "displayName": "Name", "description": "The name of the customer referenced by the identifier", "required": true } }, "required": true }, "isBilledTo": { "type": "String", "displayName": "Is Billed To", "description": "The type of item this line item is billed to.", "required": true }, "isRebilledTo": { "type": "String", "displayName": "Is Rebilled To", "description": "The type of item this line item is billed to", "required": true } }, "required": true }, "isDirectIncome": { "type": "Boolean", "displayName": "Is Direct Income", "description": "True if this invoice is also mapped as a direct income", "required": true } }, "required": true }, "paymentAllocations": { "type": "Array", "displayName": "Payment Allocations", "description": "A collection of payments allocated to the invoice", "properties": { "payment": { "type": "Object", "displayName": "Payment", "description": "The payment to be allocated", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the allocated payment", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the allocated payment", "required": true }, "reference": { "type": "String", "displayName": "Reference", "description": "Reference associated with the allocated payment", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account associated with the allocated payment", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the payment", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the base company", "required": true }, "paidOnDate": { "type": "DateTime", "displayName": "Paid On Date", "description": "The date the payment was paid", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been paid", "required": true } }, "required": true }, "allocation": { "type": "Object", "displayName": "Allocation", "description": "The allocation information", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transaction", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the allocated payment and the currency of the transaction", "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount that has been allocated", "required": true } }, "required": true } }, "required": true }, "withholdingTax": { "type": "Array", "displayName": "Withholding Tax", "description": "A collection of tax deductions", "properties": { "name": { "type": "String", "displayName": "Name", "description": "Name of the deduction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "Deduction amount", "required": true } }, "required": true }, "totalDiscount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given invoice currency, of any discounts applied", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total Amount", "description": "The total amount of the invoice excluding any taxes", "required": true }, "additionalTaxAmount": { "type": "Number", "displayName": "Additional Tax Amount", "description": "Tax added to the total tax of the lines", "required": true }, "additionalTaxPercentage": { "type": "Number", "displayName": "Additional Tax Percentage", "description": "The percentage of the additional tax to the TotalAmount", "required": true }, "totalTaxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The total amount of tax on the invoice", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The amount of the invoice, inclusive of tax", "required": true }, "amountDue": { "type": "Number", "displayName": "Amount Due", "description": "The amount outstanding on the invoice", "required": true }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": true }, "status": { "type": "String", "displayName": "Invoice Status", "description": "The current state of the invoice", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Note about the invoice", "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Invoice", "description": "An invoice is an itemised record of goods sold or services rendered to a customer", "properties": { "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The issuing date of the invoice", "required": true, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "Must be provided." } ] } }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the invoice is due to be paid by", "required": true, "validation": { "warnings": [], "information": [ { "field": "DueDate", "details": "Must be provided." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the invoice", "required": false }, "invoiceNumber": { "type": "String", "displayName": "Invoice Number", "description": "User friendly reference identifier for the invoice", "required": false, "validation": { "warnings": [], "information": [ { "field": "InvoiceNumber", "details": "Must not exceed 255 charaters long." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the invoice and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "If no rate is specified, the Xero day rate will be applied.", "ref": "https://central.xero.com/s/#CurrencySettings$Rates" } ] } }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the invoice has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must be a valid GUID." }, { "field": "CustomerRef.Id", "details": "Must match the ID of an existing customer." } ], "information": [ { "field": "CustomerRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "CustomerRef", "details": "Must be provided." } ] } }, "status": { "type": "String", "displayName": "Invoice Status", "description": "The current state of the invoice", "options": [ { "value": "Draft", "type": "String", "displayName": "Draft", "required": false }, { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "Must be provided." } ] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the invoice", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Description", "details": "Must not be longer than 4000 characters long." } ] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.Quantity", "details": "Must be provided." } ] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.UnitAmount", "details": "Must be provided." } ] } }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "The percentage rate of any discount that has been applied", "required": false }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "The amount of tax for the line", "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.TaxAmount", "details": "Must be provided." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a valid GUID." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems.AccountRef", "details": "Must be provided." } ] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [], "information": [ { "field": "TrackingCategoryRefs.Id", "details": "Must not be a parent tracking category." }, { "field": "TrackingCategoryRefs.Id", "details": "Must be provided." } ] } } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "LineItems.TrackingCategoryRefs", "details": "Tracking categories must not have the same parent tracking category." }, { "field": "LineItems.TrackingCategoryRefs", "details": "Maximum of 2 Tracking Categories." } ] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must be a valid GUID." }, { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax rate." } ], "information": [] } } }, "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must be a valid GUID." }, { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "LineItems", "details": "Must be provided." } ] } } }, "required": true } }, "Zoho Books": { "value": { "type": "Object", "displayName": "Invoice", "description": "An invoice is an itemised record of goods sold or services rendered to a customer", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the invoice has been sent to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true } }, "required": true }, "invoiceNumber": { "type": "String", "displayName": "Invoice Number", "description": "User friendly reference identifier for the invoice", "required": false }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "The issuing date of the invoice", "required": true }, "dueDate": { "type": "DateTime", "displayName": "Due Date", "description": "The date the invoice is due to be paid by", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the invoice", "required": true, "validation": { "warnings": [ { "field": "Currency", "details": "Must match the customer's currency" } ], "information": [] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the invoice and the base currency of the company", "required": false, "validation": { "warnings": [ { "field": "CurrencyRate", "details": "Must be greater than or equal to 0" } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "Note about the invoice", "required": false }, "totalDiscount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given invoice currency, of any discounts applied", "required": false, "validation": { "warnings": [ { "field": "TotalDiscount", "details": "If DiscountAmount is set for at least one Line Item, TotalDiscount must be the sum of Discount Amounts over all line items. Otherwise invoice level discount will be applied" } ], "information": [] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "A collection of lines that detail items related to the invoice", "properties": { "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "The price of each unit of goods or services", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "The number of units of goods or services purchased", "required": true, "validation": { "warnings": [ { "field": "LineItems.Quantity", "details": "Must be greater than or equal to 0" } ], "information": [] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or service type, or inventory item, the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.ItemRef", "details": "Must be provided if Description is not set" } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "Friendly name of the goods or services purchased", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Must be provided if ItemRef is not set" } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true } }, "required": false }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "The value, in the given invoice currency, of any discounts applied", "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.AccountRef", "details": "Must be of type 'Income' or 'Other Income'" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "LineItems", "details": "The sum of subtotals over all the line items must be greater than or equal to 0" }, { "field": "LineItems", "details": "Must not be empty" } ], "information": [] } }, "status": { "type": "String", "displayName": "Invoice Status", "description": "The current state of the invoice", "options": [ { "value": "Draft", "type": "String", "displayName": "Draft", "required": false }, { "value": "Submitted", "type": "String", "displayName": "Submitted", "required": false }, { "value": "Void", "type": "String", "displayName": "Void", "required": false } ], "required": true } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-update-invoices-model", "description": "The *Get create/update invoice model* endpoint returns the expected data for the request payload when creating and updating an [invoice](https://docs.codat.io/accounting-api#/schemas/Invoice) for a given company and integration.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support creating and updating an invoice.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/invoices": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Invoices" ], "summary": "Create invoice", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": { "QuickBooks Desktop": { "value": { "invoiceNumber": "18/04 15.26", "note": "invoice push 20230418 15.26", "customerRef": { "id": "80000002-1674552702", "companyName": "Test Customer 1" }, "salesOrderRefs": [], "issueDate": "2023-04-18T11:09:01.438Z", "dueDate": "2023-05-24T11:09:01.438Z", "modifiedDate": "2023-02-14T11:09:01.438Z", "sourceModifiedDate": "2023-02-14T11:09:01.438Z", "paidOnDate": "2023-02-10T11:09:01.438Z", "currency": "USD", "currencyRate": 1, "lineItems": [ { "description": "lineItems.description 1", "unitAmount": 15, "quantity": 2, "discountAmount": 0, "subTotal": 30, "taxAmount": 0, "totalAmount": 30, "accountRef": { "id": "80000006-1671793811", "name": "Consulting Income" }, "discountPercentage": 0, "taxRateRef": { "id": "80000002-1671793802", "name": "Non (TAX CODE)", "effectiveTaxRate": 0 }, "itemRef": { "id": "80000004-1675280003", "name": "test income item 1" }, "trackingCategoryRefs": [ { "id": "80000004-1674554660", "name": "Class 3" } ] } ], "paymentAllocations": [ { "payment": { "id": "80000004-1789341990", "note": "string", "reference": "string", "accountRef": { "id": "string", "name": "string" }, "currency": "USD", "currencyRate": 1, "paidOnDate": "2023-02-14T11:09:01.438Z", "totalAmount": 725 }, "allocation": { "currency": "USD", "currencyRate": 1, "allocatedOnDate": "2023-02-14T11:09:01.438Z", "totalAmount": 725 } } ], "withholdingTax": [ { "name": "string", "amount": 0 } ], "totalDiscount": 0, "subTotal": 30, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 30, "amountDue": 87326532, "discountPercentage": 0, "status": "Submitted" } }, "Sage 50 (UK)": { "value": { "invoiceNumber": "22/03 11.36", "customerRef": { "id": "CUST1", "companyName": "string" }, "salesOrderRefs": [ { "id": "SO001", "dataType": "salesOrders" } ], "issueDate": "2022-03-22T12:58:21.273Z", "dueDate": "2023-05-04T12:58:21.273Z", "paidOnDate": "2022-12-05T12:58:21.273Z", "currency": "GBP", "currencyRate": 40, "lineItems": [ { "description": "desc 1", "unitAmount": 13, "quantity": 2, "discountAmount": 0, "subTotal": 26, "taxAmount": 5.2, "totalAmount": 31.2, "accountRef": { "id": "4000", "name": "string" }, "discountPercentage": 0, "taxRateRef": { "id": "1", "name": "string", "effectiveTaxRate": 0 }, "itemRef": { "id": "string", "name": "string" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "string" }, { "id": "project_PROJ_TEST1", "name": "string" } ], "tracking": { "categoryRefs": [ { "id": "D44" } ], "projectRef": { "id": "project_PROJ_TEST1" }, "customerRef": { "id": "cust_d12oe2jd4Ds" }, "isBilledTo": "Unknown", "isRebilledTo": "Unknown" }, "isDirectIncome": true } ], "paymentAllocations": [ { "payment": { "id": "pay_d21230s", "note": "string", "reference": "REF12402", "accountRef": { "id": "ad339_D22kd" }, "paidOnDate": "2022-12-05T12:58:21.273Z", "totalAmount": 0 }, "allocation": { "allocatedOnDate": "2022-12-05T12:58:21.273Z", "totalAmount": 0 } } ], "withholdingTax": [ { "name": "string", "amount": 0 } ], "totalDiscount": 0, "subTotal": null, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 0, "amountDue": 0, "discountPercentage": 0, "status": "Submitted", "note": "note", "metadata": { "isDeleted": true } } }, "Sage Intacct": { "value": { "invoiceNumber": "IN9923", "note": "note 10.50 invoice", "customerRef": { "id": "1291", "companyName": "Stanley Test" }, "salesOrderRefs": [ { "id": "104045", "dataType": "salesOrders" } ], "issueDate": "2022-04-06T12:58:21.273Z", "dueDate": "2023-05-04T12:58:21.273Z", "paidOnDate": "2022-12-05T12:58:21.273Z", "currency": "GBP", "currencyRate": 40, "lineItems": [ { "description": "desc line 1", "unitAmount": 400, "quantity": 1, "discountAmount": 0, "subTotal": 400, "taxAmount": 300, "totalAmount": 999, "accountRef": { "id": "273", "name": "Transactor Clearing" }, "discountPercentage": 0, "taxRateRef": { "id": "99", "name": "UK Sale Goods Standard Rate", "effectiveTaxRate": 0 }, "trackingCategoryRefs": [ { "id": "LOCATION-8", "name": "United Kingdom" } ] } ], "paymentAllocations": [], "withholdingTax": [ { "name": "string", "amount": 0 } ], "totalDiscount": 0, "subTotal": null, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "totalAmount": 0, "amountDue": 0, "discountPercentage": 0, "status": "Submitted", "metadata": { "isDeleted": true } } }, "QuickBooks Online": { "value": { "customerRef": { "id": "69" }, "salesOrderRefs": [], "issueDate": "2023-04-02T00:00:00", "dueDate": "2023-04-02T00:00:00", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Any random item", "unitAmount": 10, "quantity": 10, "subTotal": 100, "taxAmount": 0, "totalAmount": 100, "accountRef": { "id": "136", "name": "Services" }, "taxRateRef": { "id": "24_Invoices" }, "itemRef": { "id": "27" }, "trackingCategoryRefs": [], "isDirectIncome": false } ], "paymentAllocations": [], "withholdingTax": [], "totalDiscount": 0, "additionalTaxAmount": 0, "additionalTaxPercentage": 0, "totalTaxAmount": 0, "amountDue": 100, "totalAmount": 100, "status": "Submitted" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceResponse" } }, "examples": {} } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create invoice* endpoint creates a new [invoice](https://docs.codat.io/accounting-api#/schemas/Invoice) for a given company's connection.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update invoice model](https://docs.codat.io/accounting-api#/operations/get-create-update-invoices-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support creating an account.\n", "operationId": "create-invoice" } }, "/companies/{companyId}/connections/{connectionId}/push/invoices/{invoiceId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "put": { "tags": [ "Invoices" ], "summary": "Update invoice", "operationId": "update-invoice", "parameters": [ { "$ref": "#/components/parameters/invoiceId" }, { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/forceUpdate" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" }, "examples": {} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Update invoice* endpoint updates an existing [invoice](https://docs.codat.io/accounting-api#/schemas/Invoice) for a given company's connection.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update invoice model](https://docs.codat.io/accounting-api#/operations/get-create-update-invoices-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support creating an account.\n" }, "delete": { "summary": "Delete invoice", "operationId": "delete-invoice", "parameters": [ { "$ref": "#/components/parameters/invoiceId" }, { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOperationSummary" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Delete invoice* endpoint allows you to delete a specified invoice from an accounting software.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\n### Process\n1. Pass the `{invoiceId}` to the *Delete invoice* endpoint and store the `pushOperationKey` returned.\n2. Check the status of the delete operation by checking the status of push operation either via\n 1. [Push operation webhook](https://docs.codat.io/introduction/webhooks/core-rules-types#push-operation-status-has-changed) (advised),\n 2. [Push operation status endpoint](https://docs.codat.io/codat-api#/operations/get-push-operation).\n\n A `Success` status indicates that the invoice object was deleted from the accounting software.\n3. (Optional) Check that the invoice was deleted from the accounting software.\n\n### Effect on related objects\n\nBe aware that deleting an invoice from an accounting software might cause related objects to be modified. For example, if you delete a paid invoice from QuickBooks Online, the invoice is deleted but the payment against that invoice is not. The payment is converted to a payment on account.\n\n## Integration specifics\nIntegrations that support soft delete do not permanently delete the object in the accounting software.\n\n| Integration | Soft Deleted | \n|-------------|--------------|\n| QuickBooks Online | Yes | \n\n> **Supported Integrations**\n> \n> This functionality is currently only supported for our QuickBooks Online integration. Check out our [public roadmap](https://portal.productboard.com/codat/7-public-product-roadmap/tabs/46-accounting-api) to see what we're building next, and to submit ideas for new features.\n> We're increasing support for object deletion across various accounting software and data types. You can check our [Accounting API Public Product Roadmap](https://portal.productboard.com/codat/7-public-product-roadmap/tabs/46-accounting-api) for the latest status.", "tags": [ "Invoices" ] } }, "/companies/{companyId}/connections/{connectionId}/push/invoices/{invoiceId}/attachment": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Invoices" ], "parameters": [ { "$ref": "#/components/parameters/invoiceId" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AttachmentUpload" } } } }, "responses": { "200": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Upload invoice attachment", "description": "The *Upload invoice attachment* endpoint uploads an attachment and assigns it against a specific `invoiceId`.\n\n[Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\n**Integration-specific behaviour**\n\nFor more details on supported file types by integration see [Attachments](https://docs.codat.io/accounting-api#/schemas/Attachment).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support uploading an invoice attachment.\n", "operationId": "upload-invoice-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/itemReceipts": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "tags": [ "Item receipts" ], "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemReceipts" }, "examples": { "Oracle NetSuite": { "value": { "results": [ { "id": "7" } ], "supplierRef": { "id": "724", "supplierName": "Vendor A.A.A" }, "purchaseOrderRefs": [], "receivedDate": "2021-03-26T00:00:00", "note": "Item Receipt for 1 line items, totaling 12393.71", "reference": "Item Receipt for 1 line items, totaling 12393.71", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "lineNumber": "1", "description": "Grease Trap", "unitAmount": 1251.89, "quantity": 9, "unitOfMeasure": "Meter", "subTotal": 11267.01, "totalAmount": 12393.71, "accountRef": { "id": "716", "name": "Inventory In Transit" }, "itemRef": { "id": "53" }, "purchaseOrderLineRef": { "id": "123", "dataType": "purchaseOrders", "lineNumber": "1" }, "tracking": { "recordRefs": [ { "id": "23", "dataType": "customers" } ] } } ], "status": "Received", "subTotal": 11267.01, "totalAmount": 12393.71, "modifiedDate": "2023-01-30T14:47:34Z", "sourceModifiedDate": "2022-07-05T13:38:10", "pageNumber": 1, "pageSize": 2, "totalResults": 1, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/itemReceipts?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/itemReceipts" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "List item receipts", "description": "The *List item receipts* endpoint returns a list of [item receipts](https://docs.codat.io/accounting-api#/schemas/ItemReceipt) for a given company's connection.\n\n[Item Receipt](https://docs.codat.io/accounting-api#/schemas/ItemReceipt) represent the receipt of items into a SMBs inventory.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-item-receipts" } }, "/companies/{companyId}/connections/{connectionId}/data/itemReceipts/{itemReceiptId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/itemReceiptId" } ], "get": { "tags": [ "Item receipts" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemReceipt" }, "examples": { "Oracle NetSuite": { "value": { "id": "7", "supplierRef": { "id": "724", "supplierName": "Vendor A.A.A" }, "purchaseOrderRefs": [], "receivedDate": "2021-03-26T00:00:00", "note": "Item Receipt for 1 line items, totaling 12393.71", "reference": "Item Receipt for 1 line items, totaling 12393.71", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "lineNumber": "1", "description": "Grease Trap", "unitAmount": 1251.89, "quantity": 9, "unitOfMeasure": "Meter", "subTotal": 11267.01, "totalAmount": 12393.71, "accountRef": { "id": "716", "name": "Inventory In Transit" }, "itemRef": { "id": "53" }, "purchaseOrderLineRef": { "id": "123", "dataType": "purchaseOrders", "lineNumber": "1" }, "tracking": { "recordRefs": [ { "id": "23", "dataType": "customers" } ] } } ], "status": "Received", "subTotal": 11267.01, "totalAmount": 12393.71, "modifiedDate": "2023-01-30T14:47:34Z", "sourceModifiedDate": "2022-07-05T13:38:10" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get item receipt", "description": "The *Get item receipt* endpoint returns a single item receipt for a given itemReceiptId.\n\n[Item receipts](https://docs.codat.io/accounting-api#/schemas/ItemReceipt) represent the receipt of items into a SMBs inventory.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=itemReceipts) for integrations that support getting a specific item receipt.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-item-receipt" } }, "/companies/{companyId}/data/items": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Items" ], "summary": "List items", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "00491160-6ee5-4d76-9f34-998f00687481", "name": "Aluminium Silt Bucket", "code": "300", "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2022-01-30T11:23:00", "itemStatus": "Active", "type": "Service", "isBillItem": true, "billItem": { "description": "Underground - Drain Yard Gully", "unitPrice": 148.88, "accountRef": { "id": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Purchases" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 } }, "isInvoiceItem": true, "invoiceItem": { "description": "Underground - Drain Yard Gully", "unitPrice": 171.21, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 } }, "metadata": { "isDeleted": false } }, { "id": "01b25f66-7ece-4e41-9e28-6198dc4d0b85", "name": "1,150 Litre Grease Trap", "code": "156", "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2023-01-10T17:11:00", "itemStatus": "Active", "type": "Inventory", "isBillItem": true, "billItem": { "description": "Grease Trap", "unitPrice": 3611.59, "accountRef": { "id": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Purchases" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 } }, "isInvoiceItem": true, "invoiceItem": { "description": "Grease Trap", "unitPrice": 4153.33, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 } }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 12, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/items" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/items?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "FA-cff078bf-430b-ec11-86bc-0022481a4971", "name": "FA01", "code": "FA000100", "modifiedDate": "2023-03-27T14:21:25Z", "itemStatus": "Active", "type": "Unknown", "isBillItem": true, "billItem": { "accountRef": { "id": "6c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Equipment" } }, "isInvoiceItem": true, "invoiceItem": { "accountRef": { "id": "6c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Equipment" } }, "metadata": { "isDeleted": false } }, { "id": "ITEM-0046c0e1-d8a1-eb11-8ce6-000d3a870973--", "name": "/ General Business Posting Group: '' / VAT Business Posting Group: ''", "code": "1001", "modifiedDate": "2023-03-27T14:21:25Z", "sourceModifiedDate": "2021-04-20T13:04:05Z", "itemStatus": "Active", "type": "Unknown", "isBillItem": true, "billItem": { "unitPrice": 219.5, "taxRateRef": { "id": "5dbc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for / STANDARD", "effectiveTaxRate": 0 } }, "isInvoiceItem": true, "invoiceItem": { "unitPrice": 0, "taxRateRef": { "id": "5dbc0fb9-89d1-ea11-bbaa-000d3a2b9185", "name": "Setup for / STANDARD", "effectiveTaxRate": 0 } }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 565, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/items" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/items?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "0897441f-1a26-48b9-b0cb-f6aee07815b7", "name": "Matt Ager test non-stock item", "code": "MA-NONSTOCK", "modifiedDate": "2022-10-26T13:32:00Z", "sourceModifiedDate": "2022-07-20T14:02:37Z", "itemStatus": "Active", "type": "Unknown", "isBillItem": true, "billItem": { "description": "Matt Ager test non-stock item", "unitPrice": 20 }, "isInvoiceItem": false }, { "id": "2227e596-2ae3-4c95-82a1-db492d334371", "name": "Matt Ager Test Push Item 4", "code": "MA-TESTPUSH4", "modifiedDate": "2022-10-26T13:32:00Z", "sourceModifiedDate": "2022-07-21T08:28:04Z", "itemStatus": "Active", "type": "Inventory", "isBillItem": false, "isInvoiceItem": true, "invoiceItem": { "unitPrice": 0 } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 22, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/items" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/items?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "212f0efe-4203-4f69-96c3-281b57c0eaa2", "name": "Banana", "code": "234", "modifiedDate": "2022-10-26T13:33:13Z", "sourceModifiedDate": "2020-07-24T14:06:31Z", "itemStatus": "Active", "type": "Inventory", "isBillItem": true, "billItem": { "description": "Banana", "unitPrice": 50 }, "isInvoiceItem": true, "invoiceItem": { "unitPrice": 0 } }, { "id": "5ace8857-6b78-4138-a34c-e9e309b55600", "name": "Monthly subscription for support", "code": "M-SUBSCRIPTION", "modifiedDate": "2022-10-26T13:33:13Z", "sourceModifiedDate": "2017-07-12T02:28:25Z", "itemStatus": "Active", "type": "Unknown", "isBillItem": false, "isInvoiceItem": true, "invoiceItem": { "unitPrice": 25, "taxRateRef": { "id": "92c01056-0b5e-44f8-81df-83b6f2a41dbd", "name": "UK sales standard rate", "effectiveTaxRate": 20 } } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 14, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/items" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/items?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "1037223", "name": "Pens x50", "code": "", "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2020-04-02T11:28:20", "itemStatus": "Active", "type": "Unknown", "isBillItem": true, "billItem": { "description": "A box of 50 pens", "unitPrice": 10, "taxRateRef": { "id": "11768", "name": "VAT1", "effectiveTaxRate": 17 } }, "isInvoiceItem": true, "invoiceItem": { "description": "A box of 50 pens", "unitPrice": 10, "taxRateRef": { "id": "11768", "name": "VAT1", "effectiveTaxRate": 17 } }, "metadata": { "isDeleted": false } }, { "id": "1037225", "name": "Eraser x10", "code": "", "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2020-04-02T11:28:04", "itemStatus": "Active", "type": "Unknown", "isBillItem": true, "billItem": { "description": "A box of 10 erasers", "unitPrice": 2.5, "taxRateRef": { "id": "11768", "name": "VAT1", "effectiveTaxRate": 17 } }, "isInvoiceItem": true, "invoiceItem": { "description": "A box of 10 erasers", "unitPrice": 2.5, "taxRateRef": { "id": "11768", "name": "VAT1", "effectiveTaxRate": 17 } }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 19, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/items" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/items?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "136", "name": "Test 2 Name", "code": "Test 2 Name", "modifiedDate": "2023-01-30T14:46:41Z", "sourceModifiedDate": "2022-10-10T10:22:51", "itemStatus": "Active", "type": "Inventory", "isBillItem": false, "isInvoiceItem": false }, { "id": "153", "name": "Discount before", "code": "Discount before", "modifiedDate": "2023-01-30T14:46:41Z", "sourceModifiedDate": "2021-07-05T14:17:45", "itemStatus": "Active", "type": "Unknown", "isBillItem": false, "isInvoiceItem": false } ], "pageNumber": 1, "pageSize": 2, "totalResults": 6, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/items" }, "next": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/items?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "100000-933272656", "name": "Cabinets:Cabinet Pulls", "modifiedDate": "2023-04-26T09:12:18Z", "sourceModifiedDate": "2022-07-18T06:06:57", "itemStatus": "Active", "type": "Inventory", "isBillItem": true, "billItem": { "description": "Cabinet Pulls", "unitPrice": 3, "accountRef": { "id": "1E0000-933270542", "name": "Cost of Goods Sold" } }, "isInvoiceItem": true, "invoiceItem": { "description": "Cabinet Pulls", "unitPrice": 0, "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" }, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" } }, "metadata": { "isDeleted": false } }, { "id": "10000-933272655", "name": "Framing", "modifiedDate": "2023-04-26T09:12:18Z", "sourceModifiedDate": "2007-12-15T19:32:53", "itemStatus": "Active", "type": "Service", "isBillItem": true, "billItem": { "description": "Framing labor", "unitPrice": 55, "accountRef": { "id": "190000-933270541", "name": "Labor Income" } }, "isInvoiceItem": true, "invoiceItem": { "description": "Framing labor", "unitPrice": 55, "accountRef": { "id": "190000-933270541", "name": "Labor Income" }, "taxRateRef": { "id": "20000-999022286", "name": "Non-Taxable Sales" } }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 85, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/items" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/items?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "1", "name": "Sales", "modifiedDate": "2023-01-18T11:02:36Z", "sourceModifiedDate": "2017-11-24T16:53:08Z", "itemStatus": "Active", "type": "Service", "isBillItem": false, "isInvoiceItem": true, "invoiceItem": { "unitPrice": 0, "accountRef": { "id": "1", "name": "Sales" } } }, { "id": "10", "name": "SP-6", "code": "SP-6", "modifiedDate": "2023-01-18T11:02:36Z", "sourceModifiedDate": "2020-03-02T14:45:07Z", "itemStatus": "Active", "type": "Service", "isBillItem": false, "isInvoiceItem": true, "invoiceItem": { "description": "Ramen Bowl White / Small", "unitPrice": 15, "accountRef": { "id": "1", "name": "Sales" } } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 40, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/items" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/items?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "1", "name": "Services", "modifiedDate": "2023-04-26T09:35:57Z", "sourceModifiedDate": "2017-01-05T13:24:41Z", "itemStatus": "Active", "type": "Service", "isBillItem": false, "isInvoiceItem": true, "invoiceItem": { "unitPrice": 0, "accountRef": { "id": "1", "name": "Services" } }, "metadata": { "isDeleted": false } }, { "id": "10", "name": "Pad folios", "modifiedDate": "2023-04-26T09:35:57Z", "sourceModifiedDate": "2017-01-05T13:26:13Z", "itemStatus": "Active", "type": "Service", "isBillItem": true, "billItem": { "description": "Promotional items - engraved padfolios", "unitPrice": 7.5, "accountRef": { "id": "69", "name": "Cost of Sales - billable expenses" }, "taxRateRef": { "id": "3_Bills", "name": "20.0% S Bills", "effectiveTaxRate": 20 } }, "isInvoiceItem": true, "invoiceItem": { "description": "Promotional items - engraved padfolios", "unitPrice": 15, "accountRef": { "id": "68", "name": "Billable Expenses Income" }, "taxRateRef": { "id": "3_Invoices", "name": "20.0% S Invoices", "effectiveTaxRate": 20 } }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 59, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/items" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/items?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "102140", "name": "FitBit", "code": "003", "modifiedDate": "2022-10-14T09:35:52Z", "sourceModifiedDate": "2020-08-10T13:20:35Z", "itemStatus": "Unknown", "type": "Unknown", "isBillItem": true, "billItem": { "description": "", "taxRateRef": { "id": "1729", "name": "Standard rate", "effectiveTaxRate": 20 } }, "isInvoiceItem": true, "invoiceItem": { "description": "", "taxRateRef": { "id": "1729", "name": "Standard rate", "effectiveTaxRate": 20 } } }, { "id": "34737", "name": "M", "code": "M", "modifiedDate": "2022-10-14T09:35:52Z", "sourceModifiedDate": "2021-08-01T16:00:33Z", "itemStatus": "Unknown", "type": "Unknown", "isBillItem": true, "billItem": { "description": "", "taxRateRef": { "id": "1731", "name": "Exempt transactions", "effectiveTaxRate": 0 } }, "isInvoiceItem": true, "invoiceItem": { "description": "", "unitPrice": 0, "taxRateRef": { "id": "1731", "name": "Exempt transactions", "effectiveTaxRate": 0 } } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 119, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/items" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/items?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "1d4677d7900e4285962e58ef370fb234", "name": "Essence of several cherries", "code": "Cherry Essence", "modifiedDate": "2022-10-24T14:52:49Z", "sourceModifiedDate": "2022-08-19T12:55:08Z", "itemStatus": "Active", "type": "Unknown", "isBillItem": true, "billItem": { "unitPrice": 7, "accountRef": { "id": "9a995955267a11e797950a57719b2edb", "name": "Cost of sales - goods" }, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 } }, "isInvoiceItem": true, "invoiceItem": { "unitPrice": 10, "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" }, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 } } }, { "id": "2b8123a523174151a71f91882f48bf3a", "name": "Consulting", "code": "BA Consulting", "modifiedDate": "2022-10-24T14:52:49Z", "sourceModifiedDate": "2020-06-04T09:07:52Z", "itemStatus": "Active", "type": "Unknown", "isBillItem": true, "billItem": { "unitPrice": 50, "accountRef": { "id": "9a995f17267a11e797950a57719b2edb", "name": "Cost of sales - delivery" }, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 } }, "isInvoiceItem": true, "invoiceItem": { "unitPrice": 40, "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" }, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 } } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 16, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/items" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/items?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "1", "name": "Travel", "code": "60200", "modifiedDate": "2023-04-04T16:31:25Z", "sourceModifiedDate": "2020-10-02T00:07:17", "itemStatus": "Active", "type": "NonInventory", "isBillItem": true, "billItem": {}, "isInvoiceItem": false, "metadata": { "isDeleted": false } }, { "id": "10", "name": "Trade Shows and Exhibits", "code": "60510", "modifiedDate": "2023-04-04T16:31:25Z", "sourceModifiedDate": "2020-10-02T00:07:18", "itemStatus": "Active", "type": "NonInventory", "isBillItem": true, "billItem": {}, "isInvoiceItem": false, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 52, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/items" }, "next": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/items?page=2&pageSize=2" } } } }, "Wave": { "value": { "results": [ { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjcyNTI=", "name": "Golf balls", "modifiedDate": "2022-11-16T18:15:25Z", "sourceModifiedDate": "2019-10-17T07:57:01Z", "itemStatus": "Active", "type": "Unknown", "isBillItem": false, "isInvoiceItem": true, "invoiceItem": { "description": "", "unitPrice": 10, "accountRef": { "id": "QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2", "name": "Sales" } } }, { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjczNDU=", "name": "golf balls", "modifiedDate": "2022-11-16T18:15:25Z", "sourceModifiedDate": "2019-10-17T08:00:29Z", "itemStatus": "Active", "type": "Unknown", "isBillItem": true, "billItem": { "description": "", "unitPrice": 5, "accountRef": { "id": "QWNjb3VudDo3OTE3NTA1OTkwNjU0OTY2MDE7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2", "name": "Office Supplies" } }, "isInvoiceItem": false } ], "pageNumber": 1, "pageSize": 2, "totalResults": 16, "_links": { "current": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/items" }, "next": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/items?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "1dbc92da-ca7b-4ad3-baa0-24e2f30c8a1f", "name": "Golf balls - white 9 pack", "code": "GB9-White", "modifiedDate": "2023-03-15T20:35:09Z", "sourceModifiedDate": "2023-02-17T11:10:49", "itemStatus": "Unknown", "type": "Unknown", "isBillItem": true, "billItem": { "description": "Golf balls - white 9 pack. Wholesale catalog item #020812-9", "unitPrice": 25, "accountRef": { "id": "127f3b99-8dc2-4b7e-854c-91ef9bd2757b", "name": "Purchases" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 } }, "isInvoiceItem": true, "invoiceItem": { "description": "Golf balls - white - 9 pack. Please reorder with code GB9-White", "unitPrice": 32, "accountRef": { "id": "c563b607-fb0e-4d06-9ddb-76fdeef20ae3", "name": "Sales" }, "taxRateRef": { "id": "OUTPUT2", "name": "20% (VAT on Income)", "effectiveTaxRate": 20 } }, "metadata": { "isDeleted": false } }, { "id": "24de2241-4f9c-4a0f-b726-dcc603bde547", "name": "T-Shirt Medium Black", "code": "TSM - Black", "modifiedDate": "2023-03-15T20:35:09Z", "sourceModifiedDate": "2023-02-17T11:10:49", "itemStatus": "Unknown", "type": "Inventory", "isBillItem": true, "billItem": { "description": "Company Branded T-Shirt Medium Black. Order code #2382", "unitPrice": 20, "accountRef": { "id": "eacdbc15-2da2-4ef3-8d5c-3d2a7473c074", "name": "Cost of Goods Sold" }, "taxRateRef": { "id": "NONE", "name": "No VAT", "effectiveTaxRate": 0 } }, "isInvoiceItem": true, "invoiceItem": { "description": "Company Branded T-Shirt Medium Black. Check out our website for other offers!", "unitPrice": 40, "accountRef": { "id": "c563b607-fb0e-4d06-9ddb-76fdeef20ae3", "name": "Sales" }, "taxRateRef": { "id": "OUTPUT2", "name": "20% (VAT on Income)", "effectiveTaxRate": 20 } }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 13, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/items" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/items?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000037116", "name": "A Codat", "code": "", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-06-10T09:04:58", "itemStatus": "Active", "type": "NonInventory", "isBillItem": true, "billItem": { "description": "", "unitPrice": 654, "accountRef": { "id": "104957000000000509", "name": "Cost of Goods Sold" } }, "isInvoiceItem": true, "invoiceItem": { "description": "", "unitPrice": 9001, "accountRef": { "id": "104957000000000376", "name": "Sales" } } }, { "id": "104957000000445001", "name": "Juice", "code": "", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-06-09T14:50:07", "itemStatus": "Active", "type": "NonInventory", "isBillItem": true, "billItem": { "description": "", "unitPrice": 2, "accountRef": { "id": "104957000000000509", "name": "Cost of Goods Sold" }, "taxRateRef": { "id": "104957000000033035", "name": "Zero Rate", "effectiveTaxRate": 0 } }, "isInvoiceItem": true, "invoiceItem": { "description": "Juice Box", "unitPrice": 10, "accountRef": { "id": "104957000000000376", "name": "Sales" }, "taxRateRef": { "id": "104957000000033035", "name": "Zero Rate", "effectiveTaxRate": 0 } } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 25, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/items?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/items" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/items?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List items* endpoint returns a list of [items](https://docs.codat.io/accounting-api#/schemas/Item) for a given company's connection.\n\n[Items](https://docs.codat.io/accounting-api#/schemas/Item) allow your customers to save and track details of the products and services that they buy and sell.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-items" } }, "/companies/{companyId}/data/items/{itemId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/itemId" } ], "get": { "tags": [ "Items" ], "summary": "Get item", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" }, "examples": { "Clear Books": { "value": { "id": "00491160-6ee5-4d76-9f34-998f00687481", "name": "Aluminium Silt Bucket", "code": "300", "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2022-01-30T11:23:00", "itemStatus": "Active", "type": "Service", "isBillItem": true, "billItem": { "description": "Underground - Drain Yard Gully", "unitPrice": 148.88, "accountRef": { "id": "7403e960-5b72-42ff-abf4-c870ad8910bd", "name": "Purchases" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 } }, "isInvoiceItem": true, "invoiceItem": { "description": "Underground - Drain Yard Gully", "unitPrice": 171.21, "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 } }, "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "FA-cff078bf-430b-ec11-86bc-0022481a4971", "name": "FA01", "code": "FA000100", "modifiedDate": "2023-03-27T14:21:25Z", "itemStatus": "Active", "type": "Unknown", "isBillItem": true, "billItem": { "accountRef": { "id": "6c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Equipment" } }, "isInvoiceItem": true, "invoiceItem": { "accountRef": { "id": "6c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Equipment" } }, "metadata": { "isDeleted": false } } }, "Exact (Netherlands)": { "value": { "id": "0897441f-1a26-48b9-b0cb-f6aee07815b7", "name": "Matt Ager test non-stock item", "code": "MA-NONSTOCK", "modifiedDate": "2022-10-26T13:32:00Z", "sourceModifiedDate": "2022-07-20T14:02:37Z", "itemStatus": "Active", "type": "Unknown", "isBillItem": true, "billItem": { "description": "Matt Ager test non-stock item", "unitPrice": 20 }, "isInvoiceItem": false } }, "Exact (UK)": { "value": { "id": "212f0efe-4203-4f69-96c3-281b57c0eaa2", "name": "Banana", "code": "234", "modifiedDate": "2022-10-26T13:33:13Z", "sourceModifiedDate": "2020-07-24T14:06:31Z", "itemStatus": "Active", "type": "Inventory", "isBillItem": true, "billItem": { "description": "Banana", "unitPrice": 50 }, "isInvoiceItem": true, "invoiceItem": { "unitPrice": 0 } } }, "FreshBooks": { "value": { "id": "1037223", "name": "Pens x50", "code": "", "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2020-04-02T11:28:20", "itemStatus": "Active", "type": "Unknown", "isBillItem": true, "billItem": { "description": "A box of 50 pens", "unitPrice": 10, "taxRateRef": { "id": "11768", "name": "VAT1", "effectiveTaxRate": 17 } }, "isInvoiceItem": true, "invoiceItem": { "description": "A box of 50 pens", "unitPrice": 10, "taxRateRef": { "id": "11768", "name": "VAT1", "effectiveTaxRate": 17 } }, "metadata": { "isDeleted": false } } }, "Oracle NetSuite": { "value": { "id": "136", "name": "Test 2 Name", "code": "Test 2 Name", "modifiedDate": "2023-01-30T14:46:41Z", "sourceModifiedDate": "2022-10-10T10:22:51", "itemStatus": "Active", "type": "Inventory", "isBillItem": false, "isInvoiceItem": false } }, "QuickBooks Desktop": { "value": { "id": "100000-933272656", "name": "Cabinets:Cabinet Pulls", "modifiedDate": "2023-04-26T09:12:18Z", "sourceModifiedDate": "2022-07-18T06:06:57", "itemStatus": "Active", "type": "Inventory", "isBillItem": true, "billItem": { "description": "Cabinet Pulls", "unitPrice": 3, "accountRef": { "id": "1E0000-933270542", "name": "Cost of Goods Sold" } }, "isInvoiceItem": true, "invoiceItem": { "description": "Cabinet Pulls", "unitPrice": 0, "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" }, "taxRateRef": { "id": "10000-999022286", "name": "Taxable Sales" } }, "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "1", "name": "Sales", "modifiedDate": "2023-01-18T11:02:36Z", "sourceModifiedDate": "2017-11-24T16:53:08Z", "itemStatus": "Active", "type": "Service", "isBillItem": false, "isInvoiceItem": true, "invoiceItem": { "unitPrice": 0, "accountRef": { "id": "1", "name": "Sales" } } } }, "QuickBooks Online Sandbox": { "value": { "id": "1", "name": "Services", "modifiedDate": "2023-04-26T09:35:57Z", "sourceModifiedDate": "2017-01-05T13:24:41Z", "itemStatus": "Active", "type": "Service", "isBillItem": false, "isInvoiceItem": true, "invoiceItem": { "unitPrice": 0, "accountRef": { "id": "1", "name": "Services" } }, "metadata": { "isDeleted": false } } }, "Sage 200cloud": { "value": { "id": "102140", "name": "FitBit", "code": "003", "modifiedDate": "2022-10-14T09:35:52Z", "sourceModifiedDate": "2020-08-10T13:20:35Z", "itemStatus": "Unknown", "type": "Unknown", "isBillItem": true, "billItem": { "description": "", "taxRateRef": { "id": "1729", "name": "Standard rate", "effectiveTaxRate": 20 } }, "isInvoiceItem": true, "invoiceItem": { "description": "", "taxRateRef": { "id": "1729", "name": "Standard rate", "effectiveTaxRate": 20 } } } }, "Sage Business Cloud Accounting": { "value": { "id": "1d4677d7900e4285962e58ef370fb234", "name": "Essence of several cherries", "code": "Cherry Essence", "modifiedDate": "2022-10-24T14:52:49Z", "sourceModifiedDate": "2022-08-19T12:55:08Z", "itemStatus": "Active", "type": "Unknown", "isBillItem": true, "billItem": { "unitPrice": 7, "accountRef": { "id": "9a995955267a11e797950a57719b2edb", "name": "Cost of sales - goods" }, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 } }, "isInvoiceItem": true, "invoiceItem": { "unitPrice": 10, "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" }, "taxRateRef": { "id": "GB_STANDARD", "name": "Standard 20.00%", "effectiveTaxRate": 20 } } } }, "Sage Intacct": { "value": { "id": "1", "name": "Travel", "code": "60200", "modifiedDate": "2023-04-04T16:31:25Z", "sourceModifiedDate": "2020-10-02T00:07:17", "itemStatus": "Active", "type": "NonInventory", "isBillItem": true, "billItem": {}, "isInvoiceItem": false, "metadata": { "isDeleted": false } } }, "Wave": { "value": { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjcyNTI=", "name": "Golf balls", "modifiedDate": "2022-11-16T18:15:25Z", "sourceModifiedDate": "2019-10-17T07:57:01Z", "itemStatus": "Active", "type": "Unknown", "isBillItem": false, "isInvoiceItem": true, "invoiceItem": { "description": "", "unitPrice": 10, "accountRef": { "id": "QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2", "name": "Sales" } } } }, "Xero": { "value": { "id": "1dbc92da-ca7b-4ad3-baa0-24e2f30c8a1f", "name": "Golf balls - white 9 pack", "code": "GB9-White", "modifiedDate": "2023-03-15T20:35:09Z", "sourceModifiedDate": "2023-02-17T11:10:49", "itemStatus": "Unknown", "type": "Unknown", "isBillItem": true, "billItem": { "description": "Golf balls - white 9 pack. Wholesale catalog item #020812-9", "unitPrice": 25, "accountRef": { "id": "127f3b99-8dc2-4b7e-854c-91ef9bd2757b", "name": "Purchases" }, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 } }, "isInvoiceItem": true, "invoiceItem": { "description": "Golf balls - white - 9 pack. Please reorder with code GB9-White", "unitPrice": 32, "accountRef": { "id": "c563b607-fb0e-4d06-9ddb-76fdeef20ae3", "name": "Sales" }, "taxRateRef": { "id": "OUTPUT2", "name": "20% (VAT on Income)", "effectiveTaxRate": 20 } }, "metadata": { "isDeleted": false } } }, "Zoho Books": { "value": { "id": "104957000000037116", "name": "A Codat", "code": "", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-06-10T09:04:58", "itemStatus": "Active", "type": "NonInventory", "isBillItem": true, "billItem": { "description": "", "unitPrice": 654, "accountRef": { "id": "104957000000000509", "name": "Cost of Goods Sold" } }, "isInvoiceItem": true, "invoiceItem": { "description": "", "unitPrice": 9001, "accountRef": { "id": "104957000000000376", "name": "Sales" } } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-item", "description": "The *Get item* endpoint returns a single item for a given itemId.\n\n[Items](https://docs.codat.io/accounting-api#/schemas/Item) allow your customers to save and track details of the products and services that they buy and sell.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=items) for integrations that support getting a specific item.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n" } }, "/companies/{companyId}/connections/{connectionId}/options/items": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create item model", "tags": [ "Items" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Item", "description": "An item includes details about a product or service that is provided to customers, or provided by suppliers", "properties": { "type": { "type": "String", "displayName": "Item Type", "description": "The type of the item", "options": [ { "value": "NonInventory", "type": "String", "displayName": "Non inventory type", "required": false }, { "value": "Service", "type": "String", "displayName": "Service type", "required": false } ], "required": true }, "itemStatus": { "type": "String", "displayName": "Item Status", "description": "The state of the item", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name for the item", "required": true, "validation": { "warnings": [ { "field": "Name", "details": "Sub-items are supported by introducing a colon in between parent and child i.e. Parent : Child" }, { "field": "Name", "details": "Max length of 31 characters." } ], "information": [] } }, "billItem": { "type": "Object", "displayName": "Bill Item Details", "description": "Item details specific to its usage with bills", "properties": { "unitPrice": { "type": "Number", "displayName": "Unit Price", "description": "The default unit price for the item", "required": false, "validation": { "warnings": [ { "field": "BillItem.UnitPrice", "details": "Value should be zero or greater" } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "The description of the item", "required": false, "validation": { "warnings": [ { "field": "BillItem.Description", "details": "Max length of 4096 characters." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the default nominal account the item is linked to", "properties": { "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": false }, "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": false } }, "required": false }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the default tax rate code the line item is linked to", "properties": { "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Name", "details": "Max length of 30 characters." } ], "information": [] } }, "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false } }, "required": false } }, "required": false }, "invoiceItem": { "type": "Object", "displayName": "Invoice Item Details", "description": "Item details specific to its usage with invoices", "properties": { "unitPrice": { "type": "Number", "displayName": "Unit Price", "description": "The default unit price for the item", "required": true, "validation": { "warnings": [ { "field": "InvoiceItem.UnitPrice", "details": "Value should be zero or greater" } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "The description of the item", "required": true, "validation": { "warnings": [ { "field": "InvoiceItem.Description", "details": "Max length of 4096 characters." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the default nominal account the item is linked to", "properties": { "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true }, "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the default tax rate code the line item is linked to", "properties": { "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Name", "details": "Max length of 30 characters." } ], "information": [] } }, "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false } }, "required": false } }, "required": true } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Item", "description": "An item includes details about a product or service that is provided to customers, or provided by suppliers", "properties": { "name": { "type": "String", "displayName": "Name", "description": "The name for the item", "required": true, "validation": { "warnings": [ { "field": "Name", "details": "Names must be unique across items." } ], "information": [ { "field": "Name", "details": "Should not be longer than 21 characters." } ] } }, "code": { "type": "String", "displayName": "Code", "description": "A user friendly reference for the item", "required": false, "validation": { "warnings": [], "information": [ { "field": "Code", "details": "Should not be longer than 21 characters." } ] } }, "isBillItem": { "type": "Boolean", "displayName": "Is Bill Item?", "description": "State whether this item can be used with bills", "required": true }, "isInvoiceItem": { "type": "Boolean", "displayName": "Is Invoice Item?", "description": "State whether this item can be used with invoices", "required": true }, "invoiceItem": { "type": "Object", "displayName": "Invoice Item Details", "description": "Item details specific to its usage with invoices", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description of the item", "required": true }, "unitPrice": { "type": "Number", "displayName": "Unit Price", "description": "The default unit price for the item", "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the default nominal account the item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [] } } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the default tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax code." } ], "information": [ { "field": "TaxRateRef.Id", "details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) or 'NON' (no tax) will not be accepted and a different tax rate must be used." } ] } } }, "required": true } }, "required": true }, "billItem": { "type": "Object", "displayName": "Bill Item Details", "description": "Item details specific to its usage with bills", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description of the item", "required": true }, "unitPrice": { "type": "Number", "displayName": "Unit Price", "description": "The default unit price for the item", "required": false }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the default nominal account the item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [] } } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the default tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax code." } ], "information": [ { "field": "TaxRateRef.Id", "details": "If an organisation has Automated Sales Tax enabled for US locales, then only 'TAX' (Automated Sales Tax) or 'NON' (no tax) can be used. If Automated Sales Tax is disabled for US locales then 'TAX' (Automated Sales Tax) or 'NON' (no tax) will not be accepted and a different tax rate must be used." } ] } } }, "required": true } }, "required": true }, "type": { "type": "String", "displayName": "Item Type", "description": "The type of the item", "options": [ { "value": "NonInventory", "type": "String", "displayName": "Non Inventory", "required": false }, { "value": "Service", "type": "String", "displayName": "Service", "required": false } ], "required": true } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Item", "description": "An item includes details about a product or service that is provided to customers, or provided by suppliers", "properties": { "name": { "type": "String", "displayName": "Name", "description": "The name for the item", "required": true }, "code": { "type": "String", "displayName": "Code", "description": "A user friendly reference for the item", "required": true }, "itemStatus": { "type": "String", "displayName": "Item Status", "description": "The state of the item", "required": true }, "type": { "type": "String", "displayName": "Item Type", "description": "The type of the item", "required": true }, "isBillItem": { "type": "Boolean", "displayName": "Is Bill Item?", "description": "State whether this item can be used with bills", "required": true }, "billItem": { "type": "Object", "displayName": "Bill Item Details", "description": "Item details specific to its usage with bills", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description of the item", "required": true }, "unitPrice": { "type": "Number", "displayName": "Unit Price", "description": "The default unit price for the item", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the default nominal account the item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the default tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": true }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": true } }, "required": true } }, "required": true }, "isInvoiceItem": { "type": "Boolean", "displayName": "Is Invoice Item?", "description": "State whether this item can be used with invoices", "required": true }, "invoiceItem": { "type": "Object", "displayName": "Invoice Item Details", "description": "Item details specific to its usage with invoices", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description of the item", "required": true }, "unitPrice": { "type": "Number", "displayName": "Unit Price", "description": "The default unit price for the item", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the default nominal account the item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the default tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": true }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": true } }, "required": true } }, "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Item", "description": "An item includes details about a product or service that is provided to customers, or provided by suppliers", "properties": { "code": { "type": "String", "displayName": "Code", "description": "A user friendly reference for the item", "required": true, "validation": { "warnings": [ { "field": "Code", "details": "Must not be longer than 30 characters long." }, { "field": "Code", "details": "Must be unique." }, { "field": "Code", "details": "Must be provided." } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "The name for the item", "required": false, "validation": { "warnings": [ { "field": "Name", "details": "Must not be longer than 50 characters long." } ], "information": [] } }, "itemStatus": { "type": "String", "displayName": "Item Status", "description": "The state of the item", "required": false, "validation": { "warnings": [], "information": [ { "field": "ItemStatus", "details": "Is ignored on push, and ItemStatus is always mapped as \"Unknown\"" } ] } }, "type": { "type": "String", "displayName": "Item Type", "description": "The type of the item", "required": false, "validation": { "warnings": [ { "field": "Type", "details": "Cannot be of type Inventory if no Inventory account exists in Xero." } ], "information": [ { "field": "Type", "details": "Must be 'Unknown' or 'Inventory', otherwise Item.Type will be defaulted to 'Unknown'." } ] } }, "invoiceItem": { "type": "Object", "displayName": "Invoice Item Details", "description": "Item details specific to its usage with invoices", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description of the item", "required": false, "validation": { "warnings": [ { "field": "InvoiceItem.Description", "details": "Must not be longer than 4000 characters long." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the default nominal account the item is linked to", "required": false } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "InvoiceItem", "details": "Must not be provided if IsInvoiceItem is false." }, { "field": "InvoiceItem", "details": "Must be provided if IsInvoiceItem is true." } ] } }, "billItem": { "type": "Object", "displayName": "Bill Item Details", "description": "Item details specific to its usage with bills", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description of the item", "required": false, "validation": { "warnings": [ { "field": "BillItem.Description", "details": "Must not be longer than 4000 characters long." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the default nominal account the item is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": false, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be provided if Item is of type Inventory." }, { "field": "AccountRef.Id", "details": "Must be provided if AccountRef is not null." } ], "information": [] } } }, "required": false, "validation": { "warnings": [ { "field": "BillItem.AccountRef", "details": "Must be provided if Item is of type Inventory." } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the default tax rate code the line item is linked to", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must be provided if TaxRateRef is not null." } ], "information": [] } } }, "required": false } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "BillItem", "details": "Must be provided if Item is of type Inventory." }, { "field": "BillItem", "details": "Must not be provided if IsBillItem is false." }, { "field": "BillItem", "details": "Must be provided if IsBillItem is true." } ] } } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-items-model", "description": "The *Get create item model* endpoint returns the expected data for the request payload when creating an [item](https://docs.codat.io/accounting-api#/schemas/Item) for a given company and integration.\n\n[Items](https://docs.codat.io/accounting-api#/schemas/Item) allow your customers to save and track details of the products and services that they buy and sell.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=items) for integrations that support creating an item.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/items": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Items" ], "summary": "Create item", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateItemResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create item* endpoint creates a new [item](https://docs.codat.io/accounting-api#/schemas/Item) for a given company's connection.\n\n[Items](https://docs.codat.io/accounting-api#/schemas/Item) allow your customers to save and track details of the products and services that they buy and sell.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create item model](https://docs.codat.io/accounting-api#/operations/get-create-items-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=items) for integrations that support creating an account.\n", "operationId": "create-item" } }, "/companies/{companyId}/data/journalEntries": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Journal entries" ], "summary": "List journal entries", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntries" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "770c89bb-3d6a-449a-9243-739378b4cd7d", "postedOn": "2022-04-19T00:00:00", "createdOn": "2022-04-19T00:00:00", "journalRef": { "id": "90bb7784-083b-4bcb-a534-b30756cee65d", "name": "General Journal" }, "journalLines": [ { "description": "", "netAmount": 32095.91, "currency": "GBP", "accountRef": { "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3", "name": "Undeposited Funds" } }, { "description": "Tax for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8", "netAmount": -2917.81, "currency": "GBP", "accountRef": { "id": "3a872b81-d1af-4d31-9bfa-a37280b8f68c", "name": "VAT" } }, { "description": "", "netAmount": -29178.09, "currency": "GBP", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" } } ], "modifiedDate": "2023-04-26T12:38:18Z", "recordRef": { "id": "c31a3778-e3ea-4d01-9281-dd2f291c8cb8", "dataType": "directIncomes" }, "metadata": { "isDeleted": false } }, { "id": "9f96606f-6846-40c6-b423-9b1753458e75", "postedOn": "2022-04-19T00:00:00", "createdOn": "2022-04-19T00:00:00", "journalRef": { "id": "90bb7784-083b-4bcb-a534-b30756cee65d", "name": "General Journal" }, "journalLines": [ { "description": "", "netAmount": 188.33, "currency": "GBP", "accountRef": { "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3", "name": "Undeposited Funds" } }, { "description": "Tax for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197", "netAmount": -17.12, "currency": "GBP", "accountRef": { "id": "3a872b81-d1af-4d31-9bfa-a37280b8f68c", "name": "VAT" } }, { "description": "", "netAmount": -171.21, "currency": "GBP", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" } } ], "modifiedDate": "2023-04-26T12:38:18Z", "recordRef": { "id": "38e8c917-0afc-4583-8ffe-1b53ad601197", "dataType": "directIncomes" }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1862, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "START", "postedOn": "2018-12-31T00:00:00", "createdOn": "2018-12-31T00:00:00", "journalRef": { "id": "4caabc3e-3d64-ed11-8c34-000d3a870cba", "name": "DEFAULT" }, "journalLines": [ { "description": "Opening Entry", "netAmount": -69723.14, "currency": "GBP", "accountRef": { "id": "ac1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Retained Earnings" } }, { "description": "Opening Entry", "netAmount": -20000, "currency": "GBP", "accountRef": { "id": "aa1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Share Capital" } }, { "description": "Opening Entry", "netAmount": -2329.42, "currency": "GBP", "accountRef": { "id": "8a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Payable" } }, { "description": "Opening Entry", "netAmount": 3499, "currency": "GBP", "accountRef": { "id": "6e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accumulated Depreciation" } }, { "description": "Opening Entry", "netAmount": 5498, "currency": "GBP", "accountRef": { "id": "6c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Equipment" } }, { "description": "Opening Entry", "netAmount": 28547.16, "currency": "GBP", "accountRef": { "id": "6a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Inventory" } }, { "description": "Opening Entry", "netAmount": 31638.4, "currency": "GBP", "accountRef": { "id": "641217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Receivable" } }, { "description": "Opening Entry", "netAmount": 2870, "currency": "GBP", "accountRef": { "id": "641217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Receivable" } }, { "description": "Opening Entry", "netAmount": 20000, "currency": "GBP", "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" } } ], "modifiedDate": "2023-03-27T14:21:31Z", "sourceModifiedDate": "2020-07-29T10:56:12Z", "metadata": { "isDeleted": false } }, { "id": "01-2019", "postedOn": "2019-01-01T00:00:00", "createdOn": "2019-01-01T00:00:00", "journalRef": { "id": "4caabc3e-3d64-ed11-8c34-000d3a870cba", "name": "DEFAULT" }, "journalLines": [ { "description": "January 2019", "netAmount": -2000, "currency": "GBP", "accountRef": { "id": "5e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Checking account" } }, { "description": "January 2019", "netAmount": 1000, "currency": "GBP", "accountRef": { "id": "401217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Salaries Expense" } }, { "description": "January 2019", "netAmount": 1000, "currency": "GBP", "accountRef": { "id": "341217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Rent Expense" } } ], "modifiedDate": "2023-03-27T14:21:31Z", "sourceModifiedDate": "2020-07-29T10:56:12Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 825, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "00002c0a-8061-4ad2-84fa-c879eea880a7", "createdOn": "2022-01-11T14:18:54", "updatedOn": "2022-01-11T14:18:54", "journalRef": { "id": "55ff34a3-0857-4202-b7ec-a399cfc26a4e", "name": "Memoriaal" }, "journalLines": [ { "description": "1 transactions of type CARD_PAYMENT_FEE_REFUND", "netAmount": -6.94, "currency": "EUR", "accountRef": { "id": "e0217fbf-8963-4134-80ef-929d5de8612d", "name": "Kosten 13e maand" }, "tracking": { "recordRefs": [] } }, { "description": "1 transactions of type CARD_PAYMENT_FEE_REFUND", "netAmount": 6.94, "currency": "EUR", "accountRef": { "id": "0166c96b-adf2-4667-a755-87e67c741f41", "name": "Resultaat verkoop activa" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2022-10-26T13:37:10Z", "sourceModifiedDate": "2022-01-11T14:18:54Z" }, { "id": "000154f0-e83a-4012-96a3-7db0b036b96b", "createdOn": "2020-04-22T13:56:46", "updatedOn": "2020-04-22T13:56:46", "journalRef": { "id": "151313ae-55b1-4ba0-b32a-e2ef6a8ce52a", "name": "Nominal Card" }, "journalLines": [ { "description": "Refunds with payment type of Cash", "netAmount": -144.36, "currency": "EUR", "accountRef": { "id": "0741cc89-e33a-4358-bcbd-3acb07b005dc", "name": "Nominal Card" }, "tracking": { "recordRefs": [] } }, { "description": "Refunds with payment type of Cash", "netAmount": 144.36, "currency": "EUR", "accountRef": { "id": "ef2fde36-4416-4bc5-b239-315b2929348c", "name": "Debiteuren" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2022-10-26T13:37:08Z", "sourceModifiedDate": "2020-04-22T13:56:46Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 35972, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "0008ef00-c5f8-4f97-bce9-5094b2f569dd", "createdOn": "2020-07-03T10:51:46", "updatedOn": "2020-07-03T10:51:46", "journalRef": { "id": "ed5068ff-cb0e-4edd-9777-36ac94a5d6f0", "name": "Sales journal" }, "journalLines": [ { "netAmount": -9.1, "currency": "GBP", "accountRef": { "id": "45ae4323-c93b-48b1-8393-db54254e4e6c", "name": "VAT To Pay" }, "tracking": { "recordRefs": [] } }, { "description": "6 service charges with 0.0% vat", "netAmount": -11.21, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "28.0 items with VatPercentage of 0.0", "netAmount": -308.61, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "Gratuity", "netAmount": -25.87, "currency": "GBP", "accountRef": { "id": "febc52c4-a1ed-4000-b51a-76f9f525445d", "name": "Salary Control Account" }, "tracking": { "recordRefs": [] } }, { "netAmount": -47.14, "currency": "GBP", "accountRef": { "id": "45ae4323-c93b-48b1-8393-db54254e4e6c", "name": "VAT To Pay" }, "tracking": { "recordRefs": [] } }, { "description": "19.0 items with VatPercentage of 20.0", "netAmount": -235.72, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "13.0 items with VatPercentage of 5.0", "netAmount": -182.06, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "1.0 gift cards", "netAmount": -1, "currency": "GBP", "accountRef": { "id": "febc52c4-a1ed-4000-b51a-76f9f525445d", "name": "Salary Control Account" }, "tracking": { "recordRefs": [] } }, { "netAmount": 820.71, "currency": "GBP", "accountRef": { "id": "cf9572e7-8afa-4339-9113-af32a66d9df9", "name": "Trade Debtors" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2022-10-26T13:35:45Z", "sourceModifiedDate": "2020-07-03T10:51:46Z", "recordRef": { "id": "0008ef00-c5f8-4f97-bce9-5094b2f569dd", "dataType": "invoices" } }, { "id": "001a8d63-2d5b-4b00-b17f-894108b6ce81", "createdOn": "2021-07-30T18:02:23", "updatedOn": "2021-07-30T18:02:23", "journalRef": { "id": "ed5068ff-cb0e-4edd-9777-36ac94a5d6f0", "name": "Sales journal" }, "journalLines": [ { "netAmount": 1038.01, "currency": "GBP", "accountRef": { "id": "cf9572e7-8afa-4339-9113-af32a66d9df9", "name": "Trade Debtors" }, "tracking": { "recordRefs": [] } }, { "description": "1.0 gift cards", "netAmount": -1, "currency": "GBP", "accountRef": { "id": "cc0ab812-d89a-452b-88a8-61666a0f0211", "name": "Accruals" }, "tracking": { "recordRefs": [] } }, { "netAmount": -19.29, "currency": "GBP", "accountRef": { "id": "45ae4323-c93b-48b1-8393-db54254e4e6c", "name": "VAT To Pay" }, "tracking": { "recordRefs": [] } }, { "netAmount": -60.82, "currency": "GBP", "accountRef": { "id": "45ae4323-c93b-48b1-8393-db54254e4e6c", "name": "VAT To Pay" }, "tracking": { "recordRefs": [] } }, { "description": "15.0 items with VatPercentage of 0.0", "netAmount": -248.28, "currency": "GBP", "accountRef": { "id": "ba7d27d1-72cf-411b-8ef3-55ca4b13dac3", "name": "Sundry Non-Operating Expenses" }, "tracking": { "recordRefs": [] } }, { "description": "Gratuity", "netAmount": -8.97, "currency": "GBP", "accountRef": { "id": "8f27a6b8-101d-4613-a059-2b462fb01b2f", "name": "anna_test_prod" }, "tracking": { "recordRefs": [] } }, { "description": "28.0 items with VatPercentage of 5.0", "netAmount": -385.7, "currency": "GBP", "accountRef": { "id": "ba7d27d1-72cf-411b-8ef3-55ca4b13dac3", "name": "Sundry Non-Operating Expenses" }, "tracking": { "recordRefs": [] } }, { "description": "2 service charges with 0.0% vat", "netAmount": -9.85, "currency": "GBP", "accountRef": { "id": "ba7d27d1-72cf-411b-8ef3-55ca4b13dac3", "name": "Sundry Non-Operating Expenses" }, "tracking": { "recordRefs": [] } }, { "description": "27.0 items with VatPercentage of 20.0", "netAmount": -304.1, "currency": "GBP", "accountRef": { "id": "ba7d27d1-72cf-411b-8ef3-55ca4b13dac3", "name": "Sundry Non-Operating Expenses" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2022-10-26T13:35:45Z", "sourceModifiedDate": "2021-07-30T18:02:23Z", "recordRef": { "id": "001a8d63-2d5b-4b00-b17f-894108b6ce81", "dataType": "invoices" } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 6785, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "24389149", "postedOn": "1987-10-01T00:00:00", "createdOn": "1987-10-01T00:00:00", "updatedOn": "1987-10-01T00:00:00", "journalLines": [ { "description": "", "netAmount": 222.88, "currency": "GBP", "accountRef": { "id": "128611", "name": "Accounts Receivable" } }, { "description": "Creative Writing Editorial", "netAmount": -222.88, "currency": "GBP", "accountRef": { "id": "128613", "name": "Sales" } }, { "description": "", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "128613", "name": "Sales" } } ], "modifiedDate": "2023-03-24T16:07:38Z", "sourceModifiedDate": "1987-10-01T00:00:00", "recordRef": { "id": "2596455", "dataType": "invoices" }, "metadata": { "isDeleted": false } }, { "id": "24389396", "postedOn": "1987-10-01T00:00:00", "createdOn": "1987-10-01T00:00:00", "updatedOn": "1987-10-01T00:00:00", "journalLines": [ { "description": "", "netAmount": -222.88, "currency": "GBP", "accountRef": { "id": "128611", "name": "Accounts Receivable" } }, { "description": "Creative Writing Editorial", "netAmount": 222.88, "currency": "GBP", "accountRef": { "id": "128613", "name": "Sales" } }, { "description": "", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "128613", "name": "Sales" } } ], "modifiedDate": "2023-03-24T16:07:38Z", "sourceModifiedDate": "1987-10-01T00:00:00", "recordRef": { "id": "2596455", "dataType": "invoices" }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 734, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "112", "postedOn": "2021-03-26T00:00:00", "createdOn": "2021-03-26T10:31:05", "updatedOn": "2021-03-26T10:31:06", "journalLines": [ { "netAmount": -120, "currency": "GBP", "accountRef": { "id": "825", "name": "Codat Europe Bank" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" }, { "id": "724", "dataType": "suppliers" } ] } }, { "netAmount": 120, "currency": "GBP", "accountRef": { "id": "111", "name": "Accounts Payable" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" }, { "id": "724", "dataType": "suppliers" } ] } } ], "modifiedDate": "2023-01-30T14:49:07Z", "sourceModifiedDate": "2021-03-26T10:31:06", "recordRef": { "id": "112", "dataType": "billPayments" } }, { "id": "7", "postedOn": "2021-03-26T00:00:00", "createdOn": "2021-03-26T10:02:18", "updatedOn": "2022-07-05T13:38:10", "journalLines": [ { "netAmount": -144, "currency": "GBP", "accountRef": { "id": "111", "name": "Accounts Payable" }, "tracking": { "recordRefs": [ { "id": "724", "dataType": "suppliers" } ] } }, { "netAmount": 120, "currency": "GBP", "accountRef": { "id": "716", "name": "Inventory In Transit" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" } ] } }, { "description": "VAT", "netAmount": 24, "currency": "GBP", "accountRef": { "id": "211", "name": "VAT on Purchases" }, "tracking": { "recordRefs": [ { "id": "713", "dataType": "suppliers" } ] } } ], "modifiedDate": "2023-01-30T14:49:07Z", "sourceModifiedDate": "2022-07-05T13:38:10", "recordRef": { "id": "7", "dataType": "bills" } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 11, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries" }, "next": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "2453-1071526256", "postedOn": "2022-11-28T00:00:00", "createdOn": "2022-11-28T00:00:00", "journalLines": [ { "description": "", "netAmount": 431.95, "currency": "GBP", "accountRef": { "id": "40000-933270541", "name": "Accounts Receivable" } }, { "description": "Foundation slab - prep and pouring", "netAmount": -167.5, "currency": "GBP", "accountRef": { "id": "190000-933270541", "name": "Labor Income" } }, { "description": "CA sales tax, San Domingo County", "netAmount": -18.45, "currency": "GBP", "accountRef": { "id": "100000-933270541", "name": "Sales Tax Payable" } }, { "description": "Rough lumber", "netAmount": -48, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Trim lumber", "netAmount": -38, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Window", "netAmount": -50, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Flooring", "netAmount": -50, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Window", "netAmount": -60, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } } ], "modifiedDate": "2023-04-26T09:11:56Z", "sourceModifiedDate": "2023-12-16T05:04:21", "recordRef": { "id": "2453-1071526256", "dataType": "invoices" }, "metadata": { "isDeleted": false } }, { "id": "469E-1071530054", "postedOn": "2022-11-30T00:00:00", "createdOn": "2022-11-30T00:00:00", "journalLines": [ { "description": "", "netAmount": 14488.64, "currency": "GBP", "accountRef": { "id": "40000-933270541", "name": "Accounts Receivable" } }, { "description": "Installation labor", "netAmount": -45.5, "currency": "GBP", "accountRef": { "id": "190000-933270541", "name": "Labor Income" } }, { "description": "Install drywall", "netAmount": -1320, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Electrical work", "netAmount": -1650, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Metal Work", "netAmount": -660, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Install insulation", "netAmount": -1100, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Plumbing", "netAmount": -1650, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Painting", "netAmount": -2420, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Install carpeting", "netAmount": -3300, "currency": "GBP", "accountRef": { "id": "1C0000-933270542", "name": "Subcontracted Labor Income" } }, { "description": "Custom Bay Window", "netAmount": -1925, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Window", "netAmount": -115.5, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Equipment Rental", "netAmount": -700, "currency": "GBP", "accountRef": { "id": "190000-933270541", "name": "Labor Income" } }, { "description": "10% retainage to be billed after job is complete and approved.", "netAmount": 555.5, "currency": "GBP", "accountRef": { "id": "70000-933270541", "name": "Retainage Receivable" } }, { "description": "CA sales tax, San Tomas County", "netAmount": -158.14, "currency": "GBP", "accountRef": { "id": "100000-933270541", "name": "Sales Tax Payable" } } ], "modifiedDate": "2023-04-26T09:11:56Z", "sourceModifiedDate": "2023-12-16T05:05:41", "recordRef": { "id": "469E-1071530054", "dataType": "invoices" }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 140, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "1", "postedOn": "2018-09-21T00:00:00", "createdOn": "2018-09-21T00:00:00", "journalLines": [ { "description": "Opening Balance from Bank", "netAmount": 170.23, "currency": "GBP", "accountRef": { "id": "61", "name": "Dave PP Current" }, "tracking": { "recordRefs": [] } }, { "description": "", "netAmount": -170.23, "currency": "GBP", "accountRef": { "id": "53", "name": "Retained profit balance forward account" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2023-01-18T11:03:25Z", "sourceModifiedDate": "2018-12-17T14:56:20Z" }, { "id": "15", "postedOn": "2018-09-21T00:00:00", "createdOn": "2018-09-21T00:00:00", "journalLines": [ { "description": "Payment to Google", "netAmount": -1.59, "currency": "GBP", "accountRef": { "id": "61", "name": "Dave PP Current" }, "tracking": { "recordRefs": [] } }, { "description": "Payment to Google", "netAmount": 1.59, "currency": "GBP", "accountRef": { "id": "37", "name": "Computer equipment accumulated depreciation brought forward" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2023-01-18T11:03:25Z", "sourceModifiedDate": "2018-12-17T14:56:44Z", "recordRef": { "id": "PUR-15", "dataType": "directCosts" } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 9405, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "12", "postedOn": "2015-02-23T00:00:00", "createdOn": "2015-02-23T00:00:00", "journalLines": [ { "description": "Opening stock for Guest Book", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Guest Book", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "65", "name": "Stock Asset" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Guest Book", "netAmount": 250, "currency": "GBP", "accountRef": { "id": "65", "name": "Stock Asset" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Guest Book", "netAmount": -250, "currency": "GBP", "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2023-04-26T09:36:42Z", "sourceModifiedDate": "2016-09-12T16:02:02Z", "metadata": { "isDeleted": false } }, { "id": "13", "postedOn": "2015-02-23T00:00:00", "createdOn": "2015-02-23T00:00:00", "journalLines": [ { "description": "Opening stock for Name Badges", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Name Badges", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "65", "name": "Stock Asset" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Name Badges", "netAmount": 7500, "currency": "GBP", "accountRef": { "id": "65", "name": "Stock Asset" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Name Badges", "netAmount": -7500, "currency": "GBP", "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2023-04-26T09:36:42Z", "sourceModifiedDate": "2016-09-12T16:02:04Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 9190, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "88", "description": "Opening Stock", "postedOn": "2021-01-01T00:00:00", "createdOn": "2010-04-27T17:16:57", "journalLines": [ { "description": "Opening Stock", "netAmount": -40710, "currency": "GBP", "accountRef": { "id": "1001", "name": "Stock" } }, { "description": "Opening Stock", "netAmount": 40710, "currency": "GBP", "accountRef": { "id": "5200", "name": "Opening Stock" } } ], "modifiedDate": "2023-03-30T14:42:38Z", "sourceModifiedDate": "2022-11-25T09:43:54", "recordRef": { "id": "88", "dataType": "journalEntries" }, "metadata": { "isDeleted": false } }, { "id": "92", "description": "Goods", "postedOn": "2021-01-01T00:00:00", "createdOn": "2010-04-27T17:16:57", "journalLines": [ { "description": "Goods/Services - Goods", "netAmount": -5875, "currency": "GBP", "accountRef": { "id": "2100", "name": "Creditors Control Account" } }, { "description": "Goods/Services - Goods", "netAmount": 5000, "currency": "GBP", "accountRef": { "id": "5000", "name": "Materials Purchased" } }, { "description": "Goods/Services - Goods", "netAmount": 875, "currency": "GBP", "accountRef": { "id": "2201", "name": "Purchase Tax Control Account" } } ], "modifiedDate": "2023-03-30T14:42:38Z", "sourceModifiedDate": "2022-11-25T09:43:54", "recordRef": { "id": "92", "dataType": "bills" }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1119, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "b0489c4b33de11e797950a57719b2edb", "postedOn": "2017-05-08T11:08:39", "createdOn": "2017-05-08T11:08:39", "updatedOn": "2017-05-08T11:08:39", "journalLines": [ { "description": "Consulting services", "netAmount": 1440, "currency": "GBP", "accountRef": { "id": "9a9931b4267a11e797950a57719b2edb", "name": "VAT on Sales - Holding Account" } }, { "description": "Consulting services", "netAmount": 7200, "currency": "GBP", "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" } }, { "netAmount": -8640, "currency": "GBP", "accountRef": { "id": "9a991c56267a11e797950a57719b2edb", "name": "Trade Debtors" } } ], "modifiedDate": "2022-10-24T15:31:26Z", "sourceModifiedDate": "2017-05-08T11:08:39Z" }, { "id": "c23efa4233de11e797950a57719b2edb", "postedOn": "2017-05-08T11:09:09", "createdOn": "2017-05-08T11:09:09", "updatedOn": "2017-05-08T11:09:09", "journalLines": [ { "netAmount": 1080, "currency": "GBP", "accountRef": { "id": "9a991c56267a11e797950a57719b2edb", "name": "Trade Debtors" } }, { "description": "Consulting services", "netAmount": -180, "currency": "GBP", "accountRef": { "id": "9a9931b4267a11e797950a57719b2edb", "name": "VAT on Sales - Holding Account" } }, { "description": "Consulting services", "netAmount": -900, "currency": "GBP", "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" } } ], "modifiedDate": "2022-10-24T15:31:26Z", "sourceModifiedDate": "2017-05-08T11:09:09Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 24386, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "262177", "description": "Invoices - 1100: 2021/04/22 03:44:26:7042 Batch Summary Entry", "postedOn": "2021-04-22T00:00:00", "createdOn": "2021-04-22T10:44:27", "updatedOn": "2021-04-22T10:44:27", "journalRef": { "id": "1", "name": "Accounts Receivable Journal" }, "journalLines": [ { "description": "", "netAmount": -100, "currency": "GBP", "accountRef": { "id": "176", "name": "Revenue - Services" } }, { "description": "", "netAmount": -20, "currency": "GBP", "accountRef": { "id": "306", "name": "Sales Tax Payable" } }, { "description": "", "netAmount": 120, "currency": "GBP", "accountRef": { "id": "2", "name": "Accounts Receivable" } } ], "modifiedDate": "2023-04-04T16:31:37Z", "sourceModifiedDate": "2021-04-22T10:44:27", "metadata": { "isDeleted": false } }, { "id": "262179", "description": "Receipts(Bank-501_CHK) - 1100: April 2021 Batch Summary Entry", "postedOn": "2021-04-30T00:00:00", "createdOn": "2021-04-22T11:01:11", "updatedOn": "2022-04-19T13:38:45", "journalRef": { "id": "7", "name": "Cash Receipts Journal" }, "journalLines": [ { "description": "", "netAmount": -120, "currency": "GBP", "accountRef": { "id": "2", "name": "Accounts Receivable" } }, { "description": "", "netAmount": 120, "currency": "GBP", "accountRef": { "id": "353", "name": "Current Account" } }, { "description": "", "netAmount": 150, "currency": "GBP", "accountRef": { "id": "353", "name": "Current Account" } }, { "description": "", "netAmount": -150, "currency": "GBP", "accountRef": { "id": "179", "name": "Revenue - Other" } } ], "modifiedDate": "2023-04-04T16:31:37Z", "sourceModifiedDate": "2022-04-19T13:38:45", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 21, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries" }, "next": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "033d79c7-565b-419a-9e1b-33ab58efcf3d", "postedOn": "2021-11-19T00:00:00", "createdOn": "2023-02-17T21:07:12", "journalLines": [ { "description": "", "netAmount": -7267.2, "currency": "GBP", "accountRef": { "id": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "name": "Accounts Payable" } }, { "description": "Half day training - Microsoft Office", "netAmount": 1800, "currency": "GBP", "accountRef": { "id": "46f9461e-788b-4906-8b74-d1ea17f6dc10", "name": "Consulting" } }, { "description": "Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month.", "netAmount": 4000, "currency": "GBP", "accountRef": { "id": "f96c9458-d724-47bf-8f74-a9d5726465ce", "name": "General Expenses" } }, { "description": "Stationery charges", "netAmount": 256, "currency": "GBP", "accountRef": { "id": "cba6527d-f102-4538-b421-e483233e9d5a", "name": "Printing & Stationery" } }, { "description": "", "netAmount": 1211.2, "currency": "GBP", "accountRef": { "id": "b12f79b9-a082-4b8b-971e-d321292943c7", "name": "VAT" } } ], "modifiedDate": "2023-03-15T20:37:09Z", "sourceModifiedDate": "2023-02-17T21:07:12", "recordRef": { "id": "3945273c-cc04-479f-a4b5-1e3dc7a55ed1", "dataType": "bills" }, "metadata": { "isDeleted": false } }, { "id": "98ac5060-c9ed-4359-bcd5-711e649e7899", "postedOn": "2021-12-20T00:00:00", "createdOn": "2023-02-17T21:07:23", "journalLines": [ { "description": "", "netAmount": -7267.2, "currency": "GBP", "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" } }, { "description": "", "netAmount": 7267.2, "currency": "GBP", "accountRef": { "id": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "name": "Accounts Payable" } } ], "modifiedDate": "2023-03-15T20:37:09Z", "sourceModifiedDate": "2023-02-17T21:07:23", "recordRef": { "id": "74004690-82a1-4810-aaca-6ce575af94b4", "dataType": "billPayments" }, "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 290, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) for a given company's connection.\n\n[Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-journal-entries" } }, "/companies/{companyId}/data/journalEntries/{journalEntryId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/journalEntryId" } ], "get": { "tags": [ "Journal entries" ], "summary": "Get journal entry", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntry" }, "examples": { "Clear Books": { "value": { "id": "770c89bb-3d6a-449a-9243-739378b4cd7d", "postedOn": "2022-04-19T00:00:00", "createdOn": "2022-04-19T00:00:00", "journalRef": { "id": "90bb7784-083b-4bcb-a534-b30756cee65d", "name": "General Journal" }, "journalLines": [ { "description": "", "netAmount": 32095.91, "currency": "GBP", "accountRef": { "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3", "name": "Undeposited Funds" } }, { "description": "Tax for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8", "netAmount": -2917.81, "currency": "GBP", "accountRef": { "id": "3a872b81-d1af-4d31-9bfa-a37280b8f68c", "name": "VAT" } }, { "description": "", "netAmount": -29178.09, "currency": "GBP", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" } } ], "modifiedDate": "2023-04-26T12:38:18Z", "recordRef": { "id": "c31a3778-e3ea-4d01-9281-dd2f291c8cb8", "dataType": "directIncomes" }, "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "START", "postedOn": "2018-12-31T00:00:00", "createdOn": "2018-12-31T00:00:00", "journalRef": { "id": "4caabc3e-3d64-ed11-8c34-000d3a870cba", "name": "DEFAULT" }, "journalLines": [ { "description": "Opening Entry", "netAmount": -69723.14, "currency": "GBP", "accountRef": { "id": "ac1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Retained Earnings" } }, { "description": "Opening Entry", "netAmount": -20000, "currency": "GBP", "accountRef": { "id": "aa1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Share Capital" } }, { "description": "Opening Entry", "netAmount": -2329.42, "currency": "GBP", "accountRef": { "id": "8a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Payable" } }, { "description": "Opening Entry", "netAmount": 3499, "currency": "GBP", "accountRef": { "id": "6e1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accumulated Depreciation" } }, { "description": "Opening Entry", "netAmount": 5498, "currency": "GBP", "accountRef": { "id": "6c1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Equipment" } }, { "description": "Opening Entry", "netAmount": 28547.16, "currency": "GBP", "accountRef": { "id": "6a1217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Inventory" } }, { "description": "Opening Entry", "netAmount": 31638.4, "currency": "GBP", "accountRef": { "id": "641217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Receivable" } }, { "description": "Opening Entry", "netAmount": 2870, "currency": "GBP", "accountRef": { "id": "641217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Accounts Receivable" } }, { "description": "Opening Entry", "netAmount": 20000, "currency": "GBP", "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" } } ], "modifiedDate": "2023-03-27T14:21:31Z", "sourceModifiedDate": "2020-07-29T10:56:12Z", "metadata": { "isDeleted": false } } }, "Exact (Netherlands)": { "value": { "id": "00002c0a-8061-4ad2-84fa-c879eea880a7", "createdOn": "2022-01-11T14:18:54", "updatedOn": "2022-01-11T14:18:54", "journalRef": { "id": "55ff34a3-0857-4202-b7ec-a399cfc26a4e", "name": "Memoriaal" }, "journalLines": [ { "description": "1 transactions of type CARD_PAYMENT_FEE_REFUND", "netAmount": -6.94, "currency": "EUR", "accountRef": { "id": "e0217fbf-8963-4134-80ef-929d5de8612d", "name": "Kosten 13e maand" }, "tracking": { "recordRefs": [] } }, { "description": "1 transactions of type CARD_PAYMENT_FEE_REFUND", "netAmount": 6.94, "currency": "EUR", "accountRef": { "id": "0166c96b-adf2-4667-a755-87e67c741f41", "name": "Resultaat verkoop activa" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2022-10-26T13:37:10Z", "sourceModifiedDate": "2022-01-11T14:18:54Z" } }, "Exact (UK)": { "value": { "id": "0008ef00-c5f8-4f97-bce9-5094b2f569dd", "createdOn": "2020-07-03T10:51:46", "updatedOn": "2020-07-03T10:51:46", "journalRef": { "id": "ed5068ff-cb0e-4edd-9777-36ac94a5d6f0", "name": "Sales journal" }, "journalLines": [ { "netAmount": -9.1, "currency": "GBP", "accountRef": { "id": "45ae4323-c93b-48b1-8393-db54254e4e6c", "name": "VAT To Pay" }, "tracking": { "recordRefs": [] } }, { "description": "6 service charges with 0.0% vat", "netAmount": -11.21, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "28.0 items with VatPercentage of 0.0", "netAmount": -308.61, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "Gratuity", "netAmount": -25.87, "currency": "GBP", "accountRef": { "id": "febc52c4-a1ed-4000-b51a-76f9f525445d", "name": "Salary Control Account" }, "tracking": { "recordRefs": [] } }, { "netAmount": -47.14, "currency": "GBP", "accountRef": { "id": "45ae4323-c93b-48b1-8393-db54254e4e6c", "name": "VAT To Pay" }, "tracking": { "recordRefs": [] } }, { "description": "19.0 items with VatPercentage of 20.0", "netAmount": -235.72, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "13.0 items with VatPercentage of 5.0", "netAmount": -182.06, "currency": "GBP", "accountRef": { "id": "43acd218-6a95-445f-994c-660273e0ced9", "name": "Sales" }, "tracking": { "recordRefs": [] } }, { "description": "1.0 gift cards", "netAmount": -1, "currency": "GBP", "accountRef": { "id": "febc52c4-a1ed-4000-b51a-76f9f525445d", "name": "Salary Control Account" }, "tracking": { "recordRefs": [] } }, { "netAmount": 820.71, "currency": "GBP", "accountRef": { "id": "cf9572e7-8afa-4339-9113-af32a66d9df9", "name": "Trade Debtors" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2022-10-26T13:35:45Z", "sourceModifiedDate": "2020-07-03T10:51:46Z", "recordRef": { "id": "0008ef00-c5f8-4f97-bce9-5094b2f569dd", "dataType": "invoices" } } }, "FreshBooks": { "value": { "id": "24389149", "postedOn": "1987-10-01T00:00:00", "createdOn": "1987-10-01T00:00:00", "updatedOn": "1987-10-01T00:00:00", "journalLines": [ { "description": "", "netAmount": 222.88, "currency": "GBP", "accountRef": { "id": "128611", "name": "Accounts Receivable" } }, { "description": "Creative Writing Editorial", "netAmount": -222.88, "currency": "GBP", "accountRef": { "id": "128613", "name": "Sales" } }, { "description": "", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "128613", "name": "Sales" } } ], "modifiedDate": "2023-03-24T16:07:38Z", "sourceModifiedDate": "1987-10-01T00:00:00", "recordRef": { "id": "2596455", "dataType": "invoices" }, "metadata": { "isDeleted": false } } }, "Oracle NetSuite": { "value": { "id": "112", "postedOn": "2021-03-26T00:00:00", "createdOn": "2021-03-26T10:31:05", "updatedOn": "2021-03-26T10:31:06", "journalLines": [ { "netAmount": -120, "currency": "GBP", "accountRef": { "id": "825", "name": "Codat Europe Bank" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" }, { "id": "724", "dataType": "suppliers" } ] } }, { "netAmount": 120, "currency": "GBP", "accountRef": { "id": "111", "name": "Accounts Payable" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" }, { "id": "724", "dataType": "suppliers" } ] } } ], "modifiedDate": "2023-01-30T14:49:07Z", "sourceModifiedDate": "2021-03-26T10:31:06", "recordRef": { "id": "112", "dataType": "billPayments" } } }, "QuickBooks Desktop": { "value": { "id": "2453-1071526256", "postedOn": "2022-11-28T00:00:00", "createdOn": "2022-11-28T00:00:00", "journalLines": [ { "description": "", "netAmount": 431.95, "currency": "GBP", "accountRef": { "id": "40000-933270541", "name": "Accounts Receivable" } }, { "description": "Foundation slab - prep and pouring", "netAmount": -167.5, "currency": "GBP", "accountRef": { "id": "190000-933270541", "name": "Labor Income" } }, { "description": "CA sales tax, San Domingo County", "netAmount": -18.45, "currency": "GBP", "accountRef": { "id": "100000-933270541", "name": "Sales Tax Payable" } }, { "description": "Rough lumber", "netAmount": -48, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Trim lumber", "netAmount": -38, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Window", "netAmount": -50, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Flooring", "netAmount": -50, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } }, { "description": "Window", "netAmount": -60, "currency": "GBP", "accountRef": { "id": "1A0000-933270542", "name": "Materials Income" } } ], "modifiedDate": "2023-04-26T09:11:56Z", "sourceModifiedDate": "2023-12-16T05:04:21", "recordRef": { "id": "2453-1071526256", "dataType": "invoices" }, "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "1", "postedOn": "2018-09-21T00:00:00", "createdOn": "2018-09-21T00:00:00", "journalLines": [ { "description": "Opening Balance from Bank", "netAmount": 170.23, "currency": "GBP", "accountRef": { "id": "61", "name": "Dave PP Current" }, "tracking": { "recordRefs": [] } }, { "description": "", "netAmount": -170.23, "currency": "GBP", "accountRef": { "id": "53", "name": "Retained profit balance forward account" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2023-01-18T11:03:25Z", "sourceModifiedDate": "2018-12-17T14:56:20Z" } }, "QuickBooks Online Sandbox": { "value": { "id": "12", "postedOn": "2015-02-23T00:00:00", "createdOn": "2015-02-23T00:00:00", "journalLines": [ { "description": "Opening stock for Guest Book", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Guest Book", "netAmount": 0, "currency": "GBP", "accountRef": { "id": "65", "name": "Stock Asset" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Guest Book", "netAmount": 250, "currency": "GBP", "accountRef": { "id": "65", "name": "Stock Asset" }, "tracking": { "recordRefs": [] } }, { "description": "Opening stock for Guest Book", "netAmount": -250, "currency": "GBP", "accountRef": { "id": "55", "name": "Opening Balance Equity" }, "tracking": { "recordRefs": [] } } ], "modifiedDate": "2023-04-26T09:36:42Z", "sourceModifiedDate": "2016-09-12T16:02:02Z", "metadata": { "isDeleted": false } } }, "Sage 50 (UK)": { "value": { "id": "88", "description": "Opening Stock", "postedOn": "2021-01-01T00:00:00", "createdOn": "2010-04-27T17:16:57", "journalLines": [ { "description": "Opening Stock", "netAmount": -40710, "currency": "GBP", "accountRef": { "id": "1001", "name": "Stock" } }, { "description": "Opening Stock", "netAmount": 40710, "currency": "GBP", "accountRef": { "id": "5200", "name": "Opening Stock" } } ], "modifiedDate": "2023-03-30T14:42:38Z", "sourceModifiedDate": "2022-11-25T09:43:54", "recordRef": { "id": "88", "dataType": "journalEntries" }, "metadata": { "isDeleted": false } } }, "Sage Business Cloud Accounting": { "value": { "id": "b0489c4b33de11e797950a57719b2edb", "postedOn": "2017-05-08T11:08:39", "createdOn": "2017-05-08T11:08:39", "updatedOn": "2017-05-08T11:08:39", "journalLines": [ { "description": "Consulting services", "netAmount": 1440, "currency": "GBP", "accountRef": { "id": "9a9931b4267a11e797950a57719b2edb", "name": "VAT on Sales - Holding Account" } }, { "description": "Consulting services", "netAmount": 7200, "currency": "GBP", "accountRef": { "id": "9a994b92267a11e797950a57719b2edb", "name": "Sales Type A" } }, { "netAmount": -8640, "currency": "GBP", "accountRef": { "id": "9a991c56267a11e797950a57719b2edb", "name": "Trade Debtors" } } ], "modifiedDate": "2022-10-24T15:31:26Z", "sourceModifiedDate": "2017-05-08T11:08:39Z" } }, "Sage Intacct": { "value": { "id": "262177", "description": "Invoices - 1100: 2021/04/22 03:44:26:7042 Batch Summary Entry", "postedOn": "2021-04-22T00:00:00", "createdOn": "2021-04-22T10:44:27", "updatedOn": "2021-04-22T10:44:27", "journalRef": { "id": "1", "name": "Accounts Receivable Journal" }, "journalLines": [ { "description": "", "netAmount": -100, "currency": "GBP", "accountRef": { "id": "176", "name": "Revenue - Services" } }, { "description": "", "netAmount": -20, "currency": "GBP", "accountRef": { "id": "306", "name": "Sales Tax Payable" } }, { "description": "", "netAmount": 120, "currency": "GBP", "accountRef": { "id": "2", "name": "Accounts Receivable" } } ], "modifiedDate": "2023-04-04T16:31:37Z", "sourceModifiedDate": "2021-04-22T10:44:27", "metadata": { "isDeleted": false } } }, "Xero": { "value": { "id": "033d79c7-565b-419a-9e1b-33ab58efcf3d", "postedOn": "2021-11-19T00:00:00", "createdOn": "2023-02-17T21:07:12", "journalLines": [ { "description": "", "netAmount": -7267.2, "currency": "GBP", "accountRef": { "id": "e0faa299-ca0d-4b0a-9e32-0dfabdf9179a", "name": "Accounts Payable" } }, { "description": "Half day training - Microsoft Office", "netAmount": 1800, "currency": "GBP", "accountRef": { "id": "46f9461e-788b-4906-8b74-d1ea17f6dc10", "name": "Consulting" } }, { "description": "Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month.", "netAmount": 4000, "currency": "GBP", "accountRef": { "id": "f96c9458-d724-47bf-8f74-a9d5726465ce", "name": "General Expenses" } }, { "description": "Stationery charges", "netAmount": 256, "currency": "GBP", "accountRef": { "id": "cba6527d-f102-4538-b421-e483233e9d5a", "name": "Printing & Stationery" } }, { "description": "", "netAmount": 1211.2, "currency": "GBP", "accountRef": { "id": "b12f79b9-a082-4b8b-971e-d321292943c7", "name": "VAT" } } ], "modifiedDate": "2023-03-15T20:37:09Z", "sourceModifiedDate": "2023-02-17T21:07:12", "recordRef": { "id": "3945273c-cc04-479f-a4b5-1e3dc7a55ed1", "dataType": "bills" }, "metadata": { "isDeleted": false } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId.\n\n[Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support getting a specific journal entry.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-journal-entry" } }, "/companies/{companyId}/connections/{connectionId}/options/journalEntries": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create journal entry model", "tags": [ "Journal entries" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Dynamics 365 Business Central": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "journalRef": { "type": "Object", "displayName": "Journal Reference", "description": "Reference to the journal in which this journal entry was created", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the journal", "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalRef", "details": "Only General type Journals are allowed" } ] } }, "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": true }, "description": { "type": "String", "displayName": "Description", "description": "An optional top level description for the journal entry", "required": false }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true, "validation": { "warnings": [ { "field": "JournalLines.AccountRef", "details": "Bank accounts are not allowed" } ], "information": [] } }, "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": true, "validation": { "warnings": [ { "field": "JournalLines.Currency", "details": "Only base currency is allowed" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "JournalLines", "details": "Must contain 2 journal lines" } ], "information": [] } } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "An optional top level description for the journal entry", "required": false }, "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": false, "validation": { "warnings": [], "information": [ { "field": "PostedOn", "details": "Defaults to today's date if not specified" } ] } }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true }, "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": false, "validation": { "warnings": [], "information": [ { "field": "JournalLines.Currency", "details": "Must be the base currency" } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines.AccountRef", "details": "Specified account must be in the same base currency as the subsidiary" } ] } }, "tracking": { "type": "Object", "displayName": "Tracking", "description": "Information this item is being tracked against", "properties": { "recordRefs": { "type": "Array", "displayName": "Record References", "description": "A collection of records this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "trackingCategories", "type": "String", "displayName": "trackingCategories", "required": false }, { "value": "customers", "type": "String", "displayName": "customers", "required": false }, { "value": "suppliers", "type": "String", "displayName": "suppliers", "required": false } ], "required": true, "validation": { "warnings": [ { "field": "RecordRefs.DataType", "details": "At most one trackingCategory RecordRef of each type (classification/department/location) may be provided, and only one entity (either customers/suppliers) RecordRef may be provided" } ], "information": [] } } }, "required": false } }, "required": true } }, "required": true } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": false }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": false, "validation": { "warnings": [ { "field": "JournalLines.Description", "details": "Max length of 4000 characters." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "required": true, "validation": { "warnings": [ { "field": "JournalLines.AccountRef", "details": "The currency of all accounts in the Journal Entry must use the base currency of the QuickBooks Desktop company" } ], "information": [] } }, "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines.NetAmount", "details": "For debit lines, the net amount should be positive, for credit lines it should be negative" }, { "field": "JournalLines.NetAmount", "details": "The sum of net amounts for all line items must be 0" } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": false, "validation": { "warnings": [ { "field": "JournalLines.Currency", "details": "Must be a three letter ISO code that matches the currency of the QuickBooks Desktop company" }, { "field": "JournalLines.Currency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "JournalLines.Currency", "details": "Must match the base currency of the QuickBooks Desktop company" }, { "field": "JournalLines.Currency", "details": "If not set, will default to the default currency of the QuickBooks Desktop company" } ] } } }, "required": true } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": true }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": false, "validation": { "warnings": [], "information": [ { "field": "JournalLines.Description", "details": "Must be no longer than 4000 characters long" } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": false, "validation": { "warnings": [], "information": [ { "field": "JournalLines.Currency", "details": "Required if multi-currency is enabled for the company" }, { "field": "JournalLines.Currency", "details": "When present, all JournalLine currencies should match" } ] } }, "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true }, "tracking": { "type": "Object", "displayName": "Tracking", "description": "Information this item is being tracked against", "properties": { "recordRefs": { "type": "Array", "displayName": "Record References", "description": "A collection of records this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "RecordRefs.Id", "details": "Must begin with 'CLASS_' or 'DEPARTMENT_'" }, { "field": "RecordRefs.Id", "details": "Must match the ID of an existing tracking category and be of type 'DEPARTMENT' or 'CLASS'." } ], "information": [] } }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true, "validation": { "warnings": [ { "field": "RecordRefs.DataType", "details": "Must be 'trackingCategories'" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "Tracking.RecordRefs", "details": "Must not contain multiple 'CLASS_' records or 'DEPARTMENT_' records" } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines", "details": "There must be at least two lines" } ] } } }, "required": true, "validation": { "warnings": [ { "details": "To push a JournalEntry to a French Company in QuickBooks Online, an active JournalCode with type 'Others' or 'Autres' must exist inside the Company" } ], "information": [] } } }, "QuickBooks Online": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": true }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": false, "validation": { "warnings": [], "information": [ { "field": "JournalLines.Description", "details": "Must be no longer than 4000 characters long" } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": false, "validation": { "warnings": [], "information": [ { "field": "JournalLines.Currency", "details": "Required if multi-currency is enabled for the company" }, { "field": "JournalLines.Currency", "details": "When present, all JournalLine currencies should match" } ] } }, "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true }, "tracking": { "type": "Object", "displayName": "Tracking", "description": "Information this item is being tracked against", "properties": { "recordRefs": { "type": "Array", "displayName": "Record References", "description": "A collection of records this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "RecordRefs.Id", "details": "Must begin with 'CLASS_' or 'DEPARTMENT_'" }, { "field": "RecordRefs.Id", "details": "Must match the ID of an existing tracking category and be of type 'DEPARTMENT' or 'CLASS'." } ], "information": [] } }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true, "validation": { "warnings": [ { "field": "RecordRefs.DataType", "details": "Must be 'trackingCategories'" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "Tracking.RecordRefs", "details": "Must not contain multiple 'CLASS_' records or 'DEPARTMENT_' records" } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines", "details": "There must be at least two lines" } ] } } }, "required": true, "validation": { "warnings": [ { "details": "To push a JournalEntry to a French Company in QuickBooks Online, an active JournalCode with type 'Others' or 'Autres' must exist inside the Company" } ], "information": [] } } }, "Sage 50 (UK)": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "createdOn": { "type": "DateTime", "displayName": "Created On", "description": "Date on which the journal was created in Sage50.", "required": false, "validation": { "warnings": [], "information": [ { "field": "createdOn", "details": "if empty then Sage 50 will auto generate a created on date" } ] } }, "updatedOn": { "type": "DateTime", "displayName": "Updated On", "description": "Date on which the journal was last updated in Sage50.", "required": true, "validation": { "warnings": [ { "field": "updatedOn", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "description": { "type": "String", "displayName": "Description", "description": "Optional description of the journal entry.", "required": false, "validation": { "warnings": [ { "field": "description", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "modifiedDate": { "type": "DateTime", "displayName": "Source Modified Date", "description": "Date on which the record was last updated via pushes.", "required": true, "validation": { "warnings": [ { "field": "modifiedDate", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "sourceModifiedDate": { "type": "DateTime", "displayName": "Source Modified Date", "description": "Date on which the record was last changed in Sage50.", "required": true, "validation": { "warnings": [ { "field": "sourceModifiedDate", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "recordRef": { "type": "Object", "displayName": "Record Reference", "description": "Links a journal entry to the underlying record that created it.", "required": false }, "dataType": { "type": "String", "displayName": "Data Type", "description": "Data type of the underlying record that created the journal entry.", "required": false, "validation": { "warnings": [ { "field": "dataType", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "journalRef": { "type": "Object", "displayName": "Journal Reference", "description": "Links journal entries to the relevant journal", "required": false }, "id": { "type": "String", "displayName": "Id", "description": "The reference journal id", "required": false, "validation": { "warnings": [ { "field": "id", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "name": { "type": "String", "displayName": "Name", "description": "The reference journal name", "required": false, "validation": { "warnings": [ { "field": "name", "details": "Is not supported and therefore will be ignored" } ], "information": [] } }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "Journal line items of the journal entry.", "properties": { "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative.", "required": true, "validation": { "warnings": [ { "field": "journalLines.netAmount", "details": "Cannot equal 0" } ], "information": [] } }, "description": { "type": "String", "displayName": "description", "description": "Description of the journal line item.", "required": false }, "currency": { "type": "String", "displayName": "currency", "description": "Currency for the journal line item.", "required": false, "validation": { "warnings": [ { "field": "journalLines.currency", "details": "Journal entries can only be pushed in the base currency of the target company." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "accountRef", "description": "Links a journal entry to any associated accounts.", "properties": { "id": { "type": "String", "displayName": "Id", "description": "The ID of the Account the line is linked to.", "required": false, "validation": { "warnings": [ { "field": "id", "details": "Cannot post journal entries against non-base currency nominal codes" } ], "information": [] } } }, "required": false } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company." } ] } } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": true }, "journalRef": { "type": "Object", "displayName": "Journal Reference", "description": "Reference to the journal in which this journal entry was created", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the journal", "required": true } }, "required": true }, "description": { "type": "String", "displayName": "Description", "description": "An optional top level description for the journal entry", "required": true, "validation": { "warnings": [ { "field": "Description", "details": "Must be no greater than 512 characters" } ], "information": [] } }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true, "validation": { "warnings": [ { "field": "JournalLines.NetAmount", "details": "Must not be a 0 amount" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": true }, "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": false, "validation": { "warnings": [ { "field": "JournalLines.Description", "details": "Must be no greater than 512 characters" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": false, "validation": { "warnings": [ { "field": "JournalLines.Currency", "details": "If provided, must match the base currency for the company" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "JournalLines", "details": "There must be at least two lines" } ], "information": [] } } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "An optional top level description for the journal entry", "required": true }, "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": true }, "createdOn": { "type": "DateTime", "displayName": "Created On", "description": "The date the entry was created in the originating system", "required": true }, "updatedOn": { "type": "DateTime", "displayName": "Updated On", "description": "The date in which the journal was last updated in the originating system", "required": true }, "journalRef": { "type": "Object", "displayName": "Journal Reference", "description": "Reference to the journal in which this journal entry was created", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the journal", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the journal", "required": true } }, "required": true }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": true }, "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency for the line", "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "tracking": { "type": "Object", "displayName": "Tracking", "description": "Information this item is being tracked against", "properties": { "recordRefs": { "type": "Array", "displayName": "Record References", "description": "A collection of records this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true } }, "required": true } }, "required": true }, "recordRef": { "type": "Object", "displayName": "Record Reference", "description": "Reference to the record for which this journal entry was created", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "JournalEntry", "properties": { "postedOn": { "type": "DateTime", "displayName": "Posted On", "description": "The date the entry was posted in the originating system", "required": true, "validation": { "warnings": [], "information": [ { "field": "PostedOn", "details": "If no date is specified, it will default to today's date." } ] } }, "journalLines": { "type": "Array", "displayName": "Journal Lines", "description": "A collection of detail lines that represent the transactions associated in this entry", "properties": { "description": { "type": "String", "displayName": "Description", "description": "The description for the journal line", "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines.Description", "details": "Must not be longer than 4000 characters long and must be the same for all lines." } ] } }, "netAmount": { "type": "Number", "displayName": "Net Amount", "description": "The amount for the journal line, excluding tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines.NetAmount", "details": "Must be provided." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the line is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a valid GUID." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines.AccountRef", "details": "Must be provided." } ] } }, "tracking": { "type": "Object", "displayName": "Tracking", "description": "Information this item is being tracked against", "properties": { "recordRefs": { "type": "Array", "displayName": "Record References", "description": "A collection of records this item is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [], "information": [ { "field": "RecordRefs.Id", "details": "Must not be a parent tracking category." }, { "field": "RecordRefs.Id", "details": "Must be provided." } ] } } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "Tracking.RecordRefs", "details": "Tracking categories must not have the same parent tracking category." }, { "field": "Tracking.RecordRefs", "details": "Maximum of 2 Tracking Categories." } ] } } }, "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "JournalLines", "details": "At least 2 must be provided." } ] } } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-journalEntries-model", "description": "The *Get create journal entry model* endpoint returns the expected data for the request payload when creating a [journal entry](https://docs.codat.io/accounting-api#/schemas/JournalEntry) for a given company and integration.\n\n[Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support creating a journal entry.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/journalEntries": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Journal entries" ], "summary": "Create journal entry", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntry" }, "examples": { "QuickBooks Desktop": { "value": { "description": "record level description", "postedOn": "2023-02-23T19:49:16.052Z", "createdOn": "2023-02-22T19:49:16.052Z", "updatedOn": "2023-02-21T19:49:16.052Z", "journalRef": { "id": "12" }, "journalLines": [ { "description": "journalLines.description debit", "netAmount": 23.02, "currency": "USD", "accountRef": { "id": "80000019-1671793811", "name": "Office Supplies" }, "tracking": { "recordRefs": [ { "id": "80000001-1674553252", "dataType": "customers" } ] } }, { "description": "journalLines.description credit", "netAmount": -23.02, "currency": "USD", "accountRef": { "id": "8000001E-1671793811", "name": "Utilities" }, "tracking": { "recordRefs": [ { "id": "80000002-1674553271", "dataType": "trackingCategories" } ] } } ], "recordRef": { "id": "80000002-6722155312", "dataType": "bills" }, "metadata": { "isDeleted": true } } }, "Sage Intacct": { "value": { "description": "test", "postedOn": "2023-03-29T00:00:00Z", "journalRef": { "id": "207" }, "journalLines": [ { "description": "line desc 1", "netAmount": 9, "currency": "GBP", "accountRef": { "id": "151" } }, { "description": "line desc 2", "netAmount": -9, "currency": "GBP", "accountRef": { "id": "154" } } ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJournalEntryResponse" }, "examples": { "Sage Intacct": { "value": { "changes": [ { "type": "Created", "recordRef": { "dataType": "journalEntries" } } ], "data": { "description": "test", "postedOn": "2023-03-29T00:00:00Z", "journalRef": { "id": "207" }, "journalLines": [ { "description": "line desc 1", "netAmount": 9, "currency": "GBP", "accountRef": { "id": "151" } }, { "description": "line desc 2", "netAmount": -9, "currency": "GBP", "accountRef": { "id": "154" } } ] }, "dataType": "journalEntries", "companyId": "d7f743a9-1804-4116-8c8a-e606f7e2f66c", "pushOperationKey": "b9c1381a-8742-4a45-9dc5-528101dbd0e3", "dataConnectionKey": "fa139396-523a-4a58-bf2b-8da82c8a673f", "requestedOnUtc": "2023-03-31T14:53:44.6401039Z", "status": "Pending", "statusCode": 202 } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create journal entry* endpoint creates a new [journal entry](https://docs.codat.io/accounting-api#/schemas/JournalEntry) for a given company's connection.\n\n[Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create journal entry model](https://docs.codat.io/accounting-api#/operations/get-create-journalEntries-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support creating an account.\n", "operationId": "create-journal-entry" } }, "/companies/{companyId}/connections/{connectionId}/push/journalEntries/{journalEntryId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/journalEntryId" } ], "delete": { "summary": "Delete journal entry", "operationId": "delete-journal-entry", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOperationSummary" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "> **Use with caution**\n>\n>Because journal entries underpin every transaction in an accounting software, deleting a journal entry can affect every transaction for a given company.\n> \n> **Before you proceed, make sure you understand the implications of deleting journal entries from an accounting perspective.**\n\nThe *Delete journal entry* endpoint allows you to delete a specified journal entry from an accounting software.\n\n[Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\n### Process\n1. Pass the `{journalEntryId}` to the *Delete journal entry* endpoint and store the `pushOperationKey` returned.\n2. Check the status of the delete by checking the status of push operation either via\n 1. [Push operation webhook](https://docs.codat.io/introduction/webhooks/core-rules-types#push-operation-status-has-changed) (advised),\n 2. [Push operation status endpoint](https://docs.codat.io/codat-api#/operations/get-push-operation). \n \n A `Success` status indicates that the journal entry object was deleted from the accounting software.\n3. (Optional) Check that the journal entry was deleted from the accounting software.\n\n### Effect on related objects\n\nBe aware that deleting a journal entry from an accounting software might cause related objects to be modified. For example, if you delete the journal entry for a paid invoice in QuickBooks Online, the invoice is deleted but the payment against that invoice is not. The payment is converted to a payment on account.\n\n## Integration specifics\nIntegrations that support soft delete do not permanently delete the object in the accounting software.\n\n| Integration | Soft Deleted | \n|-------------|--------------|\n| QuickBooks Online | Yes | \n\n> **Supported Integrations**\n> \n> This functionality is currently only supported for our QuickBooks Online integration. Check out our [public roadmap](https://portal.productboard.com/codat/7-public-product-roadmap/tabs/46-accounting-api) to see what we're building next, and to submit ideas for new features.", "tags": [ "Journal entries" ] } }, "/companies/{companyId}/data/journals": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Journals" ], "summary": "List journals", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journals" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "90bb7784-083b-4bcb-a534-b30756cee65d", "journalCode": "GJ", "name": "General Journal", "type": "General Journal", "hasChildren": true, "createdOn": "2021-12-11T13:04:02", "status": "Active", "modifiedDate": "2023-04-26T12:38:18Z", "sourceModifiedDate": "2022-07-15T20:19:02", "metadata": { "isDeleted": false } }, { "id": "07b94827-c0a5-4cc7-ba58-3f9efec3b4b3", "journalCode": "PAY", "name": "Payroll Journal", "type": "Payroll Journal", "parentId": "90bb7784-083b-4bcb-a534-b30756cee65d", "hasChildren": false, "createdOn": "2021-12-11T13:04:02", "status": "Active", "modifiedDate": "2023-04-26T12:38:18Z", "sourceModifiedDate": "2022-07-24T14:17:02", "metadata": { "isDeleted": false } } ], "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2" } }, "pageNumber": 1, "pageSize": 2, "totalResults": 4 } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "211317b3-89d1-ea11-bbaa-000d3a2b9185", "journalCode": "ASSETS", "name": "ASSETS", "type": "Assets", "hasChildren": true, "status": "Active", "modifiedDate": "2023-03-27T14:21:10Z", "sourceModifiedDate": "2023-02-02T10:26:25Z", "metadata": { "isDeleted": false } }, { "id": "9a94ef78-92ec-ec11-82f9-000d3a8746a9", "journalCode": "BNKDEPOSIT-BNKD", "name": "BNKD", "type": "Bank Deposits", "parentId": "af7d7e6b-e5c8-ec11-8e7e-000d3a86e04a", "hasChildren": false, "createdOn": "2022-06-15T10:03:59", "status": "Active", "modifiedDate": "2023-03-27T14:21:10Z", "sourceModifiedDate": "2022-06-15T22:45:30Z", "metadata": { "isDeleted": false } } ], "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2" } }, "pageNumber": 1, "pageSize": 2, "totalResults": 46 } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "aae31284-e23d-456b-9957-fbf4bcef6c19", "journalCode": "21", "name": "12345678", "type": "Bank", "hasChildren": false, "createdOn": "2019-11-05T14:44:51", "status": "Active", "modifiedDate": "2022-10-26T13:31:58Z", "sourceModifiedDate": "2020-01-24T11:41:25Z" }, { "id": "74677165-1bd3-49b4-87d0-32d974674f86", "journalCode": "23", "name": "Abraham's Billion Dollar stuff", "type": "Bank", "hasChildren": false, "createdOn": "2019-11-22T13:35:57", "status": "Active", "modifiedDate": "2022-10-26T13:31:58Z", "sourceModifiedDate": "2019-11-22T13:35:57Z" } ], "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2" } }, "pageNumber": 1, "pageSize": 2, "totalResults": 47 } }, "Exact (UK)": { "value": { "results": [ { "id": "05b9febe-34b3-4836-8277-002294b233a9", "journalCode": "25", "name": "annaBankAccount1", "type": "Bank", "hasChildren": false, "createdOn": "2021-04-26T16:44:47", "status": "Active", "modifiedDate": "2022-10-26T13:33:08Z", "sourceModifiedDate": "2021-04-26T16:44:47Z" }, { "id": "b9c3d6a6-4ce2-4714-9ff6-fb15892300f7", "journalCode": "31", "name": "annaBankAccount10", "type": "Bank", "hasChildren": false, "createdOn": "2021-05-18T10:24:18", "status": "Active", "modifiedDate": "2022-10-26T13:33:08Z", "sourceModifiedDate": "2021-05-18T10:24:18Z" } ], "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2" } }, "pageNumber": 1, "pageSize": 2, "totalResults": 21 } }, "Sage Intacct": { "value": { "results": [ { "id": "207", "journalCode": "AJPT", "name": "A Journal Push Test", "type": "", "hasChildren": false, "createdOn": "2022-01-17T10:44:23", "status": "Active", "modifiedDate": "2023-04-04T16:31:30Z", "sourceModifiedDate": "2022-01-17T10:44:23", "metadata": { "isDeleted": false } }, { "id": "223", "journalCode": "AJPT2", "name": "A Journal Push Test 2", "type": "", "hasChildren": false, "createdOn": "2022-01-18T15:39:07", "status": "Active", "modifiedDate": "2023-04-04T16:31:30Z", "sourceModifiedDate": "2022-01-18T15:39:07", "metadata": { "isDeleted": false } } ], "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2" } }, "pageNumber": 1, "pageSize": 2, "totalResults": 1211 } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List journals* endpoint returns a list of [journals](https://docs.codat.io/accounting-api#/schemas/Journal) for a given company's connection.\n\n[Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-journals" } }, "/companies/{companyId}/data/journals/{journalId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/journalId" } ], "get": { "tags": [ "Journals" ], "summary": "Get journal", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal" }, "examples": { "Clear Books": { "value": { "id": "90bb7784-083b-4bcb-a534-b30756cee65d", "journalCode": "GJ", "name": "General Journal", "type": "General Journal", "hasChildren": true, "createdOn": "2021-12-11T13:04:02", "status": "Active", "modifiedDate": "2023-04-26T12:38:18Z", "sourceModifiedDate": "2022-07-15T20:19:02", "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "211317b3-89d1-ea11-bbaa-000d3a2b9185", "journalCode": "ASSETS", "name": "ASSETS", "type": "Assets", "hasChildren": true, "status": "Active", "modifiedDate": "2023-03-27T14:21:10Z", "sourceModifiedDate": "2023-02-02T10:26:25Z", "metadata": { "isDeleted": false } } }, "Exact (Netherlands)": { "value": { "id": "aae31284-e23d-456b-9957-fbf4bcef6c19", "journalCode": "21", "name": "12345678", "type": "Bank", "hasChildren": false, "createdOn": "2019-11-05T14:44:51", "status": "Active", "modifiedDate": "2022-10-26T13:31:58Z", "sourceModifiedDate": "2020-01-24T11:41:25Z" } }, "Exact (UK)": { "value": { "id": "05b9febe-34b3-4836-8277-002294b233a9", "journalCode": "25", "name": "annaBankAccount1", "type": "Bank", "hasChildren": false, "createdOn": "2021-04-26T16:44:47", "status": "Active", "modifiedDate": "2022-10-26T13:33:08Z", "sourceModifiedDate": "2021-04-26T16:44:47Z" } }, "Sage Intacct": { "value": { "id": "207", "journalCode": "AJPT", "name": "A Journal Push Test", "type": "", "hasChildren": false, "createdOn": "2022-01-17T10:44:23", "status": "Active", "modifiedDate": "2023-04-04T16:31:30Z", "sourceModifiedDate": "2022-01-17T10:44:23", "metadata": { "isDeleted": false } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get journal* endpoint returns a single journal for a given journalId.\n\n[Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support getting a specific journal.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-journal" } }, "/companies/{companyId}/connections/{connectionId}/options/journals": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create journal model", "tags": [ "Journals" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Sage Intacct": { "value": { "type": "Object", "displayName": "Journal", "properties": { "name": { "type": "String", "displayName": "Name", "description": "The name of the journal", "required": true, "validation": { "warnings": [ { "field": "Name", "details": "Must be no greater than 40 characters" } ], "information": [] } }, "journalCode": { "type": "String", "displayName": "Journal Number", "description": "The number or code for the journal", "required": true, "validation": { "warnings": [ { "field": "JournalCode", "details": "Must be no greater than 16 characters" } ], "information": [] } }, "status": { "type": "String", "displayName": "Status", "description": "The status of the journal", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Journal", "properties": { "journalCode": { "type": "String", "displayName": "Journal Number", "description": "The number or code for the journal", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the journal", "required": true }, "type": { "type": "String", "displayName": "Type", "description": "The type of journal", "required": true }, "parentId": { "type": "String", "displayName": "Parent Id", "description": "Identifier for the parent journal - empty if journal is the parent", "required": true }, "hasChildren": { "type": "Boolean", "displayName": "Has Children", "description": "If a journal has children, the journal is parent of those children journals", "required": true }, "createdOn": { "type": "DateTime", "displayName": "Created On", "description": "The date the journal was created in the originating system", "required": true }, "status": { "type": "String", "displayName": "Status", "description": "The status of the journal", "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-journals-model", "description": "The *Get create journal model* endpoint returns the expected data for the request payload when creating a [journal](https://docs.codat.io/accounting-api#/schemas/Journal) for a given company and integration.\n\n[Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support creating a journal.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/journals": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Journals" ], "summary": "Create journal", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Journal/definitions/journalPrototype" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJournalResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create journal* endpoint creates a new [journal](https://docs.codat.io/accounting-api#/schemas/Journal) for a given company's connection.\n\n[Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create journal model](https://docs.codat.io/accounting-api#/operations/get-create-journals-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support creating an account.\n", "operationId": "create-journal" } }, "/companies/{companyId}/data/paymentMethods": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Payment methods" ], "summary": "List payment methods", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethods" }, "examples": { "QuickBooks Online": { "value": { "results": [ { "id": "3", "name": "Card", "type": "Unknown", "status": "Active", "modifiedDate": "2023-01-18T11:02:37Z", "sourceModifiedDate": "2017-11-24T16:53:08Z" }, { "id": "1", "name": "Cash", "type": "Unknown", "status": "Active", "modifiedDate": "2023-01-18T11:02:37Z", "sourceModifiedDate": "2017-11-24T16:53:08Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 4, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/paymentMethods?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/paymentMethods" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/paymentMethods?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "3", "name": "Card", "type": "Unknown", "status": "Active", "modifiedDate": "2023-04-26T09:35:57Z", "sourceModifiedDate": "2022-03-07T15:53:27Z", "metadata": { "isDeleted": false } }, { "id": "1", "name": "Cash", "type": "Unknown", "status": "Active", "modifiedDate": "2023-04-26T09:35:57Z", "sourceModifiedDate": "2016-08-30T09:26:13Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 4, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/paymentMethods?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/paymentMethods" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/paymentMethods?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "12", "name": "ACH", "type": "Other", "status": "Unknown", "modifiedDate": "2023-04-04T16:31:24Z", "metadata": { "isDeleted": false } }, { "id": "6", "name": "Cash", "type": "Cash", "status": "Unknown", "modifiedDate": "2023-04-04T16:31:24Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 6, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/paymentMethods?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/paymentMethods" }, "next": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/paymentMethods?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List payment methods* endpoint returns a list of [payment methods](https://docs.codat.io/accounting-api#/schemas/PaymentMethod) for a given company's connection.\n\n[Payment methods](https://docs.codat.io/accounting-api#/schemas/PaymentMethod) are used to pay a Bill. Payment Methods are referenced on [Bill Payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) and [Payments](https://docs.codat.io/accounting-api#/schemas/Payment).\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-payment-methods" } }, "/companies/{companyId}/data/paymentMethods/{paymentMethodId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/paymentMethodId" } ], "get": { "tags": [ "Payment methods" ], "summary": "Get payment method", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" }, "examples": { "QuickBooks Online": { "value": { "id": "3", "name": "Card", "type": "Unknown", "status": "Active", "modifiedDate": "2023-01-18T11:02:37Z", "sourceModifiedDate": "2017-11-24T16:53:08Z" } }, "QuickBooks Online Sandbox": { "value": { "id": "3", "name": "Card", "type": "Unknown", "status": "Active", "modifiedDate": "2023-04-26T09:35:57Z", "sourceModifiedDate": "2022-03-07T15:53:27Z", "metadata": { "isDeleted": false } } }, "Sage Intacct": { "value": { "id": "12", "name": "ACH", "type": "Other", "status": "Unknown", "modifiedDate": "2023-04-04T16:31:24Z", "metadata": { "isDeleted": false } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get payment method* endpoint returns a single payment method for a given paymentMethodId.\n\n[Payment methods](https://docs.codat.io/accounting-api#/schemas/PaymentMethod) are used to pay a Bill. Payment Methods are referenced on [Bill Payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) and [Payments](https://docs.codat.io/accounting-api#/schemas/Payment).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=paymentMethods) for integrations that support getting a specific payment method.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-payment-method" } }, "/companies/{companyId}/data/payments": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Payments" ], "summary": "List payments", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payments" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "7ba4fc1b-e248-49ba-8bf8-0813d7f203a8", "customerRef": { "id": "a82042f1-a005-4ca5-bfd3-5bc237123aa5", "companyName": "Keara Leffler" }, "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "totalAmount": 3669.52, "currency": "GBP", "currencyRate": 1, "date": "2022-04-25T13:04:02", "note": "Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1", "lines": [ { "amount": 3669.52, "links": [ { "type": "Invoice", "id": "ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1", "amount": -3669.52, "currencyRate": 1 } ], "allocatedOnDate": "2022-04-25T13:04:02" } ], "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2022-04-25T13:04:02", "reference": "ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1", "metadata": { "isDeleted": false } }, { "id": "9407d5ee-893a-4547-bd89-bc7b795ee774", "customerRef": { "id": "d65ac505-072c-49ec-be3c-3cb74228966d", "companyName": "Jensen Steuber" }, "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "paymentMethodRef": { "id": "8db2de81-0db4-46ee-b7f9-c711a7e89a01", "name": "Cash payments-IHz" }, "totalAmount": 1772.72, "currency": "GBP", "currencyRate": 1, "date": "2022-04-25T13:04:02", "note": "Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660", "lines": [ { "amount": 1772.72, "links": [ { "type": "Invoice", "id": "2518ca08-5e2a-4630-8cee-a6bcd1625660", "amount": -1772.72, "currencyRate": 1 } ], "allocatedOnDate": "2022-04-25T13:04:02" } ], "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2022-04-25T13:04:02", "reference": "2518ca08-5e2a-4630-8cee-a6bcd1625660", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 200, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "e0299ced-89d1-ea11-bbaa-000d3a2b9185", "customerRef": { "id": "b61217b3-89d1-ea11-bbaa-000d3a2b9185", "companyName": "Trey Researches" }, "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" }, "totalAmount": 128.16, "currency": "GBP", "currencyRate": 1, "date": "2019-01-15T00:00:00", "note": "Invoice 102001", "lines": [ { "amount": 128.16, "links": [ { "type": "Invoice", "id": "18c906bf-89d1-ea11-bbaa-000d3a2b9185", "amount": -128.16, "currencyRate": 1 } ], "allocatedOnDate": "2019-01-15T00:00:00" } ], "modifiedDate": "2023-03-27T14:21:27Z", "sourceModifiedDate": "0001-01-01T00:00:00Z", "reference": "Document No: 103001", "metadata": { "isDeleted": false } }, { "id": "042a9ced-89d1-ea11-bbaa-000d3a2b9185", "customerRef": { "id": "b41217b3-89d1-ea11-bbaa-000d3a2b9185", "companyName": "Adatum Corporation" }, "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" }, "totalAmount": 600.48, "currency": "GBP", "currencyRate": 1, "date": "2019-01-16T00:00:00", "note": "Invoice 102002", "lines": [ { "amount": 600.48, "links": [ { "type": "Invoice", "id": "1bc906bf-89d1-ea11-bbaa-000d3a2b9185", "amount": -600.48, "currencyRate": 1 } ], "allocatedOnDate": "2019-01-16T00:00:00" } ], "modifiedDate": "2023-03-27T14:21:27Z", "sourceModifiedDate": "0001-01-01T00:00:00Z", "reference": "Document No: 103002", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 249, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "090f5d9f-d1ce-4a61-985f-d3915618b64a_c3bf08a3-4d51-4859-acbb-5075f9484f87", "customerRef": { "id": "c3bf08a3-4d51-4859-acbb-5075f9484f87", "companyName": "Mr Abe" }, "accountRef": { "id": "35717508-0696-4481-a32c-2835f0ed8b4e", "name": "Test GL account 2" }, "totalAmount": 229.08, "currency": "EUR", "currencyRate": 1, "date": "2019-11-26T00:00:00Z", "lines": [ { "amount": 229.08, "links": [ { "type": "Invoice", "id": "f010d4df-13ea-45d1-8525-785164df7dd9", "amount": -229.08, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:36:13Z", "sourceModifiedDate": "2019-11-26T12:31:46Z", "reference": "19230011" }, { "id": "1650bb9c-5d9a-40f2-9015-0e251a12f861_c3bf08a3-4d51-4859-acbb-5075f9484f87", "customerRef": { "id": "c3bf08a3-4d51-4859-acbb-5075f9484f87", "companyName": "Mr Abe" }, "accountRef": { "id": "35717508-0696-4481-a32c-2835f0ed8b4e", "name": "Test GL account 2" }, "totalAmount": 991.56, "currency": "EUR", "currencyRate": 1, "date": "2019-11-26T00:00:00Z", "lines": [ { "amount": 991.56, "links": [ { "type": "Invoice", "id": "013f05e6-2583-4e6d-8309-a479808cf7bf", "amount": -991.56, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:36:13Z", "sourceModifiedDate": "2019-11-26T12:31:12Z", "reference": "19230010" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 46, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "14b7d656-07ee-4d70-aafa-61c0030c08ad_7e566728-a7f3-4860-a7f5-381664673287", "customerRef": { "id": "7e566728-a7f3-4860-a7f5-381664673287", "companyName": "Customer A" }, "accountRef": { "id": "4a4e34b5-7f62-4b64-a44a-073398b14b41", "name": "Bank" }, "totalAmount": 1, "currency": "GBP", "currencyRate": 1, "date": "2020-01-02T00:00:00Z", "lines": [ { "amount": 1, "links": [ { "type": "Invoice", "id": "6220ed43-1fec-4e17-a88f-c7ee5b949e76", "amount": -1, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:35:14Z", "sourceModifiedDate": "2020-01-02T10:08:27Z", "reference": "20200002" }, { "id": "d8b093cf-3d37-405b-9e85-72552226553f_7e566728-a7f3-4860-a7f5-381664673287", "customerRef": { "id": "7e566728-a7f3-4860-a7f5-381664673287", "companyName": "Customer A" }, "accountRef": { "id": "4a4e34b5-7f62-4b64-a44a-073398b14b41", "name": "Bank" }, "totalAmount": 1, "currency": "GBP", "currencyRate": 1, "date": "2020-01-02T00:00:00Z", "lines": [ { "amount": 1, "links": [ { "type": "Invoice", "id": "6220ed43-1fec-4e17-a88f-c7ee5b949e76", "amount": -1, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:35:14Z", "sourceModifiedDate": "2020-01-02T09:58:15Z", "reference": "20200001" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 5, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "135234099", "customerRef": { "id": "6162049", "companyName": "Wintershall Holding GmbH" }, "totalAmount": 100, "currency": "GBP", "date": "2017-11-23T00:00:00", "note": "CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 015", "lines": [ { "amount": 100, "links": [ { "type": "Invoice", "id": "21973931", "amount": -100, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-25T14:21:37Z", "metadata": { "isDeleted": false } }, { "id": "135258250", "customerRef": { "id": "6162230", "companyName": "Stronachs LLP" }, "totalAmount": 100, "currency": "GBP", "date": "2017-11-23T00:00:00", "note": "CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 006", "lines": [ { "amount": 100, "links": [ { "type": "Invoice", "id": "21952246", "amount": -100, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-25T14:21:37Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1146, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "765831", "customerRef": { "id": "113070" }, "totalAmount": 1, "currency": "GBP", "date": "2018-09-11T00:00:00", "note": "Overpayment: invoice #0000003, some test", "lines": [ { "amount": 1, "links": [ { "type": "PaymentOnAccount", "id": "113070", "amount": -1, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-24T16:07:24Z", "sourceModifiedDate": "2018-09-11T06:58:46", "metadata": { "isDeleted": false } }, { "id": "988600", "customerRef": { "id": "380630" }, "totalAmount": 5, "currency": "GBP", "date": "2019-01-21T00:00:00", "note": "Overpayment: invoice #0000007", "lines": [ { "amount": 5, "links": [ { "type": "PaymentOnAccount", "id": "380630", "amount": -5, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-24T16:07:24Z", "sourceModifiedDate": "2019-01-21T10:23:59", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 239, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments?page=2&pageSize=2" } } } }, "KashFlow": { "value": { "results": [ { "id": "139214921", "customerRef": { "id": "85743294", "companyName": "Parent customer" }, "totalAmount": 1.2, "currency": "GBP", "date": "2010-04-07T00:00:00", "note": "", "lines": [ { "amount": 1.2, "links": [ { "type": "Invoice", "id": "137055108", "amount": -1.2, "currencyRate": 1 } ] } ], "modifiedDate": "2022-09-30T10:29:15Z" }, { "id": "86861497", "customerRef": { "id": "69946501", "companyName": "Peter Lord" }, "totalAmount": 10, "currency": "GBP", "date": "2017-05-01T00:00:00", "note": "", "lines": [ { "amount": 10, "links": [ { "type": "Invoice", "id": "85315064", "amount": -10, "currencyRate": 1 } ] } ], "modifiedDate": "2022-09-30T10:29:15Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 74, "_links": { "current": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments" }, "next": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "8828", "customerRef": { "id": "417", "companyName": "10 Breww Ltd" }, "totalAmount": 0, "currency": "GBP", "currencyRate": 1, "date": "2021-04-09T00:00:00", "lines": [ { "amount": 0, "links": [ { "type": "Invoice", "id": "8530", "amount": -16, "currencyRate": 1 }, { "type": "CreditNote", "id": "8828", "amount": 16, "currencyRate": 1 } ] } ], "modifiedDate": "2022-09-20T08:18:33Z", "sourceModifiedDate": "2022-02-25T10:58:37", "reference": "Credit Memo #CM28" }, { "id": "428", "customerRef": { "id": "417", "companyName": "10 Breww Ltd" }, "accountRef": { "id": "122", "name": "Undeposited Funds" }, "totalAmount": 90, "currency": "GBP", "currencyRate": 1, "date": "2021-04-20T00:00:00", "lines": [ { "amount": 90, "links": [ { "type": "Invoice", "id": "416", "amount": -90, "currencyRate": 1 } ] }, { "amount": 10, "links": [ { "type": "Invoice", "id": "416", "amount": -10, "currencyRate": 1 } ] }, { "amount": -10, "links": [ { "type": "Other", "id": "428", "amount": 10, "currencyRate": 1 } ] } ], "modifiedDate": "2022-09-20T08:18:33Z", "sourceModifiedDate": "2022-04-28T13:36:54", "reference": "Payment #PYMT01" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 113, "_links": { "current": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments" }, "next": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "6915-1197775450", "customerRef": { "id": "220000-933272658", "companyName": "Melton, Johnny" }, "accountRef": { "id": "80000-933270541", "name": "Undeposited Funds" }, "totalAmount": 14488.64, "currency": "GBP", "currencyRate": 1, "date": "2023-01-10T00:00:00", "note": "Check - 80000-933270541", "lines": [ { "amount": 14488.64, "links": [ { "type": "Invoice", "id": "469E-1071530054", "amount": -14488.64, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:08:36Z", "sourceModifiedDate": "2023-12-16T05:06:11", "reference": "19650", "metadata": { "isDeleted": false } }, { "id": "6973-1197775625", "customerRef": { "id": "420000-1071522044", "companyName": "Prentice, Adelaide" }, "accountRef": { "id": "80000-933270541", "name": "Undeposited Funds" }, "totalAmount": 431.95, "currency": "GBP", "currencyRate": 1, "date": "2023-01-15T00:00:00", "note": "Check - 80000-933270541", "lines": [ { "amount": 431.95, "links": [ { "type": "Invoice", "id": "2453-1071526256", "amount": -431.95, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:08:36Z", "sourceModifiedDate": "2023-12-16T05:06:11", "reference": "983409", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 108, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "710", "customerRef": { "id": "9", "companyName": "Abe" }, "accountRef": { "id": "56", "name": "Undeposited Funds" }, "totalAmount": 95.2, "currency": "GBP", "currencyRate": 1, "date": "2018-10-05T00:00:00", "note": "Sarah's Test", "lines": [ { "amount": 95.2, "links": [ { "type": "Invoice", "id": "688", "amount": -95.2, "currencyRate": 1 } ] } ], "modifiedDate": "2023-01-18T11:03:14Z", "sourceModifiedDate": "2020-08-14T09:59:29Z" }, { "id": "9298", "customerRef": { "id": "9", "companyName": "Abe" }, "accountRef": { "id": "56", "name": "Undeposited Funds" }, "totalAmount": 95.2, "currency": "GBP", "currencyRate": 1, "date": "2018-10-05T00:00:00", "note": "Adeel Test", "lines": [ { "amount": 95.2, "links": [ { "type": "PaymentOnAccount", "id": "9", "amount": -95.2, "currencyRate": 1 } ] } ], "modifiedDate": "2023-01-18T11:03:18Z", "sourceModifiedDate": "2022-06-20T13:51:36Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 3723, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "25", "customerRef": { "id": "55", "companyName": "Oxon Insurance - Holiday Party" }, "accountRef": { "id": "81", "name": "Current" }, "totalAmount": 10800, "currency": "GBP", "currencyRate": 1, "date": "2016-02-12T00:00:00", "note": "", "lines": [ { "amount": 10800, "links": [ { "type": "PaymentOnAccount", "id": "55", "amount": -10800, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:36:50Z", "sourceModifiedDate": "2022-02-03T12:09:35Z", "metadata": { "isDeleted": false } }, { "id": "31", "customerRef": { "id": "59", "companyName": "Ecker Holiday event" }, "accountRef": { "id": "81", "name": "Current" }, "totalAmount": 15615, "currency": "GBP", "currencyRate": 1, "date": "2016-02-12T00:00:00", "note": "", "lines": [ { "amount": 15615, "links": [ { "type": "Invoice", "id": "30", "amount": -15615, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:36:50Z", "sourceModifiedDate": "2016-09-12T16:50:17Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 813, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "29684", "customerRef": { "id": "STE001", "companyName": "Stevenson & Smith" }, "totalAmount": 500, "currency": "GBP", "currencyRate": 1, "date": "2019-01-30T00:00:00Z", "note": "Payment on Account", "lines": [ { "amount": 12.5, "links": [ { "type": "Invoice", "id": "29676", "amount": -12.5, "currencyRate": 1 } ] }, { "amount": 487.5, "links": [ { "type": "Invoice", "id": "29851", "amount": -487.5, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-14T09:36:05Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "reference": "5897532" }, { "id": "29681", "customerRef": { "id": "MAC001", "companyName": "Macolm Hall Associates" }, "totalAmount": 0, "currency": "GBP", "currencyRate": 1, "date": "2019-12-31T00:00:00Z", "note": "Opening Balance", "lines": [ { "amount": 0, "links": [ { "type": "Invoice", "id": "29745", "amount": 0.05, "currencyRate": 1 }, { "type": "CreditNote", "id": "29681", "amount": -0.05, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-14T09:36:05Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "reference": "O/BAL" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 83, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "53", "customerRef": { "id": "STE001", "companyName": "Stevenson & Smith" }, "accountRef": { "id": "1200", "name": "Bank Current Account" }, "totalAmount": 500, "currency": "GBP", "currencyRate": 1, "date": "2021-01-30T00:00:00", "note": "Sales receipt on account 53 linked to sales invoice tx-3, sales invoice inv-31.", "lines": [ { "amount": 12.5, "links": [ { "type": "Invoice", "id": "TX-3", "amount": -12.5, "currencyRate": 1 } ] }, { "amount": 245.34, "links": [ { "type": "Invoice", "id": "INV-31", "amount": -245.34, "currencyRate": 1 } ] }, { "amount": 126.9, "links": [ { "type": "Invoice", "id": "INV-31", "amount": -126.9, "currencyRate": 1 } ] }, { "amount": 115.26, "links": [ { "type": "Invoice", "id": "INV-31", "amount": -115.26, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-30T14:42:39Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } }, { "id": "8", "customerRef": { "id": "MAC001", "companyName": "Macolm Hall Associates" }, "accountRef": { "id": "" }, "totalAmount": 0, "currency": "GBP", "currencyRate": 1, "date": "2021-12-31T00:00:00", "note": "Sales credit tx-8 linked to sales invoice inv-10.", "lines": [ { "amount": 0, "links": [ { "type": "Invoice", "id": "INV-10", "amount": -0.05, "currencyRate": 1 }, { "type": "CreditNote", "id": "TX-8", "amount": 0.05, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-30T14:42:39Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 53, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "d39f7a5733de11e797950a57719b2edb", "customerRef": { "id": "f4ff85ba33dd11e797950a57719b2edb", "companyName": "Widgets Limited" }, "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "totalAmount": -1080, "currency": "GBP", "currencyRate": 1, "date": "2017-05-08T00:00:00", "note": "Customer refund using credit/debit card", "lines": [ { "amount": -1080, "links": [ { "type": "CreditNote", "id": "c1a0176c33de11e797950a57719b2edb", "amount": 1080, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-24T14:55:39Z", "sourceModifiedDate": "2017-05-08T11:09:38Z" }, { "id": "03a5fdc8baa643fb97587033b0c4590b", "customerRef": { "id": "3cc3148bbd8111e8bad90617b3da4b8a", "companyName": "John's Test Customer" }, "accountRef": { "id": "2572c8766afc11e8aaa5027d54329956", "name": "Tide Current" }, "totalAmount": 100, "currency": "GBP", "currencyRate": 1, "date": "2017-11-23T00:00:00", "note": "Customer receipt using credit/debit card", "lines": [ { "amount": 100, "links": [ { "type": "Invoice", "id": "ede1e735bd8111e8bad90617b3da4b8a", "amount": -100, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-24T14:55:39Z", "sourceModifiedDate": "2019-01-17T14:14:55Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2321, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/payments" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/payments?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "2918", "customerRef": { "id": "12", "companyName": "MK Manufacturing" }, "accountRef": { "id": "353", "name": "Current Account" }, "paymentMethodRef": { "id": "1", "name": "Printed Check" }, "totalAmount": 120, "currency": "GBP", "date": "2021-04-22T00:00:00", "note": "", "lines": [ { "amount": 120, "links": [ { "type": "Invoice", "id": "2916", "amount": -120, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-04T16:32:02Z", "sourceModifiedDate": "2021-04-22T11:01:11Z", "metadata": { "isDeleted": false } }, { "id": "6105", "customerRef": { "id": "531", "companyName": "Shoprite" }, "accountRef": { "id": "353", "name": "Current Account" }, "paymentMethodRef": { "id": "6", "name": "Cash" }, "totalAmount": 150, "currency": "GBP", "date": "2022-04-19T00:00:00", "note": "", "lines": [ { "amount": 150, "links": [ { "type": "PaymentOnAccount", "id": "531", "amount": -150, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-04T16:32:02Z", "sourceModifiedDate": "2022-04-19T13:38:45Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/payments" } } } }, "Xero": { "value": { "results": [ { "id": "65b746c8-9a5d-4a95-8096-d2316fcff592", "customerRef": { "id": "afd4093b-c655-4847-8ee2-10a4f2c3eae3", "companyName": "Maddox Publishing Group" }, "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "totalAmount": 4200, "currency": "GBP", "currencyRate": 1, "date": "2022-02-17T00:00:00", "lines": [ { "amount": 4200, "links": [ { "type": "Invoice", "id": "321bfed3-2da2-4969-9358-4de97821181b", "amount": -4200, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-15T20:37:08Z", "sourceModifiedDate": "2021-01-02T22:50:58", "metadata": { "isDeleted": false } }, { "id": "8c481b70-b5d7-4de4-a7f7-9e161be2c472", "customerRef": { "id": "a871a956-05b5-4e2a-9419-7aeb478ca647", "companyName": "Ridgeway University" }, "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "totalAmount": 500, "currency": "GBP", "currencyRate": 1, "date": "2022-02-17T00:00:00", "lines": [ { "amount": 500, "links": [ { "type": "Invoice", "id": "4b6d0c8f-10fa-42cd-a6e5-53b175e90005", "amount": -500, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-15T20:37:08Z", "sourceModifiedDate": "2021-01-02T22:51:43", "reference": "", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 30, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/payments" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/payments?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000070175", "customerRef": { "id": "104957000000037097", "companyName": "Test Company" }, "accountRef": { "id": "104957000000060010", "name": "Abdi Test" }, "totalAmount": 9001, "currency": "GBP", "currencyRate": 1, "date": "2020-02-06T00:00:00", "note": "Cheque deposit", "lines": [ { "amount": 9001, "links": [ { "type": "Invoice", "id": "104957000000038052", "amount": -9001, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-03T08:41:17Z", "reference": "4" }, { "id": "104957000000067014", "customerRef": { "id": "104957000000037097", "companyName": "Test Company" }, "accountRef": { "id": "104957000000060010", "name": "Abdi Test" }, "totalAmount": 9001, "currency": "GBP", "currencyRate": 1, "date": "2020-02-14T00:00:00", "note": "", "lines": [ { "amount": 9001, "links": [ { "type": "Invoice", "id": "104957000000038106", "amount": -9001, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-03T08:41:17Z", "reference": "1" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 33, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List payments* endpoint returns a list of [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for a given company's connection.\n\n[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-payments" } }, "/companies/{companyId}/data/payments/{paymentId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/paymentId" } ], "get": { "tags": [ "Payments" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" }, "examples": { "Clear Books": { "value": { "id": "7ba4fc1b-e248-49ba-8bf8-0813d7f203a8", "customerRef": { "id": "a82042f1-a005-4ca5-bfd3-5bc237123aa5", "companyName": "Keara Leffler" }, "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "totalAmount": 3669.52, "currency": "GBP", "currencyRate": 1, "date": "2022-04-25T13:04:02", "note": "Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1", "lines": [ { "amount": 3669.52, "links": [ { "type": "Invoice", "id": "ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1", "amount": -3669.52, "currencyRate": 1 } ], "allocatedOnDate": "2022-04-25T13:04:02" } ], "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2022-04-25T13:04:02", "reference": "ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1", "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "e0299ced-89d1-ea11-bbaa-000d3a2b9185", "customerRef": { "id": "b61217b3-89d1-ea11-bbaa-000d3a2b9185", "companyName": "Trey Researches" }, "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" }, "totalAmount": 128.16, "currency": "GBP", "currencyRate": 1, "date": "2019-01-15T00:00:00", "note": "Invoice 102001", "lines": [ { "amount": 128.16, "links": [ { "type": "Invoice", "id": "18c906bf-89d1-ea11-bbaa-000d3a2b9185", "amount": -128.16, "currencyRate": 1 } ], "allocatedOnDate": "2019-01-15T00:00:00" } ], "modifiedDate": "2023-03-27T14:21:27Z", "sourceModifiedDate": "0001-01-01T00:00:00Z", "reference": "Document No: 103001", "metadata": { "isDeleted": false } } }, "Exact (Netherlands)": { "value": { "id": "090f5d9f-d1ce-4a61-985f-d3915618b64a_c3bf08a3-4d51-4859-acbb-5075f9484f87", "customerRef": { "id": "c3bf08a3-4d51-4859-acbb-5075f9484f87", "companyName": "Mr Abe" }, "accountRef": { "id": "35717508-0696-4481-a32c-2835f0ed8b4e", "name": "Test GL account 2" }, "totalAmount": 229.08, "currency": "EUR", "currencyRate": 1, "date": "2019-11-26T00:00:00Z", "lines": [ { "amount": 229.08, "links": [ { "type": "Invoice", "id": "f010d4df-13ea-45d1-8525-785164df7dd9", "amount": -229.08, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:36:13Z", "sourceModifiedDate": "2019-11-26T12:31:46Z", "reference": "19230011" } }, "Exact (UK)": { "value": { "id": "14b7d656-07ee-4d70-aafa-61c0030c08ad_7e566728-a7f3-4860-a7f5-381664673287", "customerRef": { "id": "7e566728-a7f3-4860-a7f5-381664673287", "companyName": "Customer A" }, "accountRef": { "id": "4a4e34b5-7f62-4b64-a44a-073398b14b41", "name": "Bank" }, "totalAmount": 1, "currency": "GBP", "currencyRate": 1, "date": "2020-01-02T00:00:00Z", "lines": [ { "amount": 1, "links": [ { "type": "Invoice", "id": "6220ed43-1fec-4e17-a88f-c7ee5b949e76", "amount": -1, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:35:14Z", "sourceModifiedDate": "2020-01-02T10:08:27Z", "reference": "20200002" } }, "FreeAgent": { "value": { "id": "135234099", "customerRef": { "id": "6162049", "companyName": "Wintershall Holding GmbH" }, "totalAmount": 100, "currency": "GBP", "date": "2017-11-23T00:00:00", "note": "CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 015", "lines": [ { "amount": 100, "links": [ { "type": "Invoice", "id": "21973931", "amount": -100, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-25T14:21:37Z", "metadata": { "isDeleted": false } } }, "FreshBooks": { "value": { "id": "765831", "customerRef": { "id": "113070" }, "totalAmount": 1, "currency": "GBP", "date": "2018-09-11T00:00:00", "note": "Overpayment: invoice #0000003, some test", "lines": [ { "amount": 1, "links": [ { "type": "PaymentOnAccount", "id": "113070", "amount": -1, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-24T16:07:24Z", "sourceModifiedDate": "2018-09-11T06:58:46", "metadata": { "isDeleted": false } } }, "KashFlow": { "value": { "id": "139214921", "customerRef": { "id": "85743294", "companyName": "Parent customer" }, "totalAmount": 1.2, "currency": "GBP", "date": "2010-04-07T00:00:00", "note": "", "lines": [ { "amount": 1.2, "links": [ { "type": "Invoice", "id": "137055108", "amount": -1.2, "currencyRate": 1 } ] } ], "modifiedDate": "2022-09-30T10:29:15Z" } }, "Oracle NetSuite": { "value": { "id": "8828", "customerRef": { "id": "417", "companyName": "10 Breww Ltd" }, "totalAmount": 0, "currency": "GBP", "currencyRate": 1, "date": "2021-04-09T00:00:00", "lines": [ { "amount": 0, "links": [ { "type": "Invoice", "id": "8530", "amount": -16, "currencyRate": 1 }, { "type": "CreditNote", "id": "8828", "amount": 16, "currencyRate": 1 } ] } ], "modifiedDate": "2022-09-20T08:18:33Z", "sourceModifiedDate": "2022-02-25T10:58:37", "reference": "Credit Memo #CM28" } }, "QuickBooks Desktop": { "value": { "id": "6915-1197775450", "customerRef": { "id": "220000-933272658", "companyName": "Melton, Johnny" }, "accountRef": { "id": "80000-933270541", "name": "Undeposited Funds" }, "totalAmount": 14488.64, "currency": "GBP", "currencyRate": 1, "date": "2023-01-10T00:00:00", "note": "Check - 80000-933270541", "lines": [ { "amount": 14488.64, "links": [ { "type": "Invoice", "id": "469E-1071530054", "amount": -14488.64, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:08:36Z", "sourceModifiedDate": "2023-12-16T05:06:11", "reference": "19650", "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "710", "customerRef": { "id": "9", "companyName": "Abe" }, "accountRef": { "id": "56", "name": "Undeposited Funds" }, "totalAmount": 95.2, "currency": "GBP", "currencyRate": 1, "date": "2018-10-05T00:00:00", "note": "Sarah's Test", "lines": [ { "amount": 95.2, "links": [ { "type": "Invoice", "id": "688", "amount": -95.2, "currencyRate": 1 } ] } ], "modifiedDate": "2023-01-18T11:03:14Z", "sourceModifiedDate": "2020-08-14T09:59:29Z" } }, "QuickBooks Online Sandbox": { "value": { "id": "25", "customerRef": { "id": "55", "companyName": "Oxon Insurance - Holiday Party" }, "accountRef": { "id": "81", "name": "Current" }, "totalAmount": 10800, "currency": "GBP", "currencyRate": 1, "date": "2016-02-12T00:00:00", "note": "", "lines": [ { "amount": 10800, "links": [ { "type": "PaymentOnAccount", "id": "55", "amount": -10800, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:36:50Z", "sourceModifiedDate": "2022-02-03T12:09:35Z", "metadata": { "isDeleted": false } } }, "Sage 200cloud": { "value": { "id": "29684", "customerRef": { "id": "STE001", "companyName": "Stevenson & Smith" }, "totalAmount": 500, "currency": "GBP", "currencyRate": 1, "date": "2019-01-30T00:00:00Z", "note": "Payment on Account", "lines": [ { "amount": 12.5, "links": [ { "type": "Invoice", "id": "29676", "amount": -12.5, "currencyRate": 1 } ] }, { "amount": 487.5, "links": [ { "type": "Invoice", "id": "29851", "amount": -487.5, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-14T09:36:05Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "reference": "5897532" } }, "Sage 50 (UK)": { "value": { "id": "53", "customerRef": { "id": "STE001", "companyName": "Stevenson & Smith" }, "accountRef": { "id": "1200", "name": "Bank Current Account" }, "totalAmount": 500, "currency": "GBP", "currencyRate": 1, "date": "2021-01-30T00:00:00", "note": "Sales receipt on account 53 linked to sales invoice tx-3, sales invoice inv-31.", "lines": [ { "amount": 12.5, "links": [ { "type": "Invoice", "id": "TX-3", "amount": -12.5, "currencyRate": 1 } ] }, { "amount": 245.34, "links": [ { "type": "Invoice", "id": "INV-31", "amount": -245.34, "currencyRate": 1 } ] }, { "amount": 126.9, "links": [ { "type": "Invoice", "id": "INV-31", "amount": -126.9, "currencyRate": 1 } ] }, { "amount": 115.26, "links": [ { "type": "Invoice", "id": "INV-31", "amount": -115.26, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-30T14:42:39Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } } }, "Sage Business Cloud Accounting": { "value": { "id": "d39f7a5733de11e797950a57719b2edb", "customerRef": { "id": "f4ff85ba33dd11e797950a57719b2edb", "companyName": "Widgets Limited" }, "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "totalAmount": -1080, "currency": "GBP", "currencyRate": 1, "date": "2017-05-08T00:00:00", "note": "Customer refund using credit/debit card", "lines": [ { "amount": -1080, "links": [ { "type": "CreditNote", "id": "c1a0176c33de11e797950a57719b2edb", "amount": 1080, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-24T14:55:39Z", "sourceModifiedDate": "2017-05-08T11:09:38Z" } }, "Sage Intacct": { "value": { "id": "2918", "customerRef": { "id": "12", "companyName": "MK Manufacturing" }, "accountRef": { "id": "353", "name": "Current Account" }, "paymentMethodRef": { "id": "1", "name": "Printed Check" }, "totalAmount": 120, "currency": "GBP", "date": "2021-04-22T00:00:00", "note": "", "lines": [ { "amount": 120, "links": [ { "type": "Invoice", "id": "2916", "amount": -120, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-04T16:32:02Z", "sourceModifiedDate": "2021-04-22T11:01:11Z", "metadata": { "isDeleted": false } } }, "Xero": { "value": { "id": "65b746c8-9a5d-4a95-8096-d2316fcff592", "customerRef": { "id": "afd4093b-c655-4847-8ee2-10a4f2c3eae3", "companyName": "Maddox Publishing Group" }, "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "totalAmount": 4200, "currency": "GBP", "currencyRate": 1, "date": "2022-02-17T00:00:00", "lines": [ { "amount": 4200, "links": [ { "type": "Invoice", "id": "321bfed3-2da2-4969-9358-4de97821181b", "amount": -4200, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-15T20:37:08Z", "sourceModifiedDate": "2021-01-02T22:50:58", "metadata": { "isDeleted": false } } }, "Zoho Books": { "value": { "id": "104957000000070175", "customerRef": { "id": "104957000000037097", "companyName": "Test Company" }, "accountRef": { "id": "104957000000060010", "name": "Abdi Test" }, "totalAmount": 9001, "currency": "GBP", "currencyRate": 1, "date": "2020-02-06T00:00:00", "note": "Cheque deposit", "lines": [ { "amount": 9001, "links": [ { "type": "Invoice", "id": "104957000000038052", "amount": -9001, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-03T08:41:17Z", "reference": "4" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get payment", "description": "The *Get payment* endpoint returns a single payment for a given paymentId.\n\n[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support getting a specific payment.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-payment" } }, "/companies/{companyId}/connections/{connectionId}/data/payments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "tags": [ "Payments" ], "summary": "List payments", "parameters": [ { "name": "linkType", "in": "query", "required": true, "schema": { "type": "string", "example": "invoice", "description": "The type of link on a payment's line in Codat." }, "description": "The type of link on a payment's line in Codat." }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payments" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "7ba4fc1b-e248-49ba-8bf8-0813d7f203a8", "customerRef": { "id": "a82042f1-a005-4ca5-bfd3-5bc237123aa5", "companyName": "Keara Leffler" }, "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "totalAmount": 3669.52, "currency": "GBP", "currencyRate": 1, "date": "2022-04-25T13:04:02", "note": "Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1", "lines": [ { "amount": 3669.52, "links": [ { "type": "Invoice", "id": "ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1", "amount": -3669.52, "currencyRate": 1 } ], "allocatedOnDate": "2022-04-25T13:04:02" } ], "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2022-04-25T13:04:02", "reference": "ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1", "metadata": { "isDeleted": false } }, { "id": "9407d5ee-893a-4547-bd89-bc7b795ee774", "customerRef": { "id": "d65ac505-072c-49ec-be3c-3cb74228966d", "companyName": "Jensen Steuber" }, "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "name": "Business Current Account" }, "paymentMethodRef": { "id": "8db2de81-0db4-46ee-b7f9-c711a7e89a01", "name": "Cash payments-IHz" }, "totalAmount": 1772.72, "currency": "GBP", "currencyRate": 1, "date": "2022-04-25T13:04:02", "note": "Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660", "lines": [ { "amount": 1772.72, "links": [ { "type": "Invoice", "id": "2518ca08-5e2a-4630-8cee-a6bcd1625660", "amount": -1772.72, "currencyRate": 1 } ], "allocatedOnDate": "2022-04-25T13:04:02" } ], "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2022-04-25T13:04:02", "reference": "2518ca08-5e2a-4630-8cee-a6bcd1625660", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 200, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "e0299ced-89d1-ea11-bbaa-000d3a2b9185", "customerRef": { "id": "b61217b3-89d1-ea11-bbaa-000d3a2b9185", "companyName": "Trey Researches" }, "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" }, "totalAmount": 128.16, "currency": "GBP", "currencyRate": 1, "date": "2019-01-15T00:00:00", "note": "Invoice 102001", "lines": [ { "amount": 128.16, "links": [ { "type": "Invoice", "id": "18c906bf-89d1-ea11-bbaa-000d3a2b9185", "amount": -128.16, "currencyRate": 1 } ], "allocatedOnDate": "2019-01-15T00:00:00" } ], "modifiedDate": "2023-03-27T14:21:27Z", "sourceModifiedDate": "0001-01-01T00:00:00Z", "reference": "Document No: 103001", "metadata": { "isDeleted": false } }, { "id": "042a9ced-89d1-ea11-bbaa-000d3a2b9185", "customerRef": { "id": "b41217b3-89d1-ea11-bbaa-000d3a2b9185", "companyName": "Adatum Corporation" }, "accountRef": { "id": "621217b3-89d1-ea11-bbaa-000d3a2b9185", "name": "Petty Cash" }, "totalAmount": 600.48, "currency": "GBP", "currencyRate": 1, "date": "2019-01-16T00:00:00", "note": "Invoice 102002", "lines": [ { "amount": 600.48, "links": [ { "type": "Invoice", "id": "1bc906bf-89d1-ea11-bbaa-000d3a2b9185", "amount": -600.48, "currencyRate": 1 } ], "allocatedOnDate": "2019-01-16T00:00:00" } ], "modifiedDate": "2023-03-27T14:21:27Z", "sourceModifiedDate": "0001-01-01T00:00:00Z", "reference": "Document No: 103002", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 249, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "090f5d9f-d1ce-4a61-985f-d3915618b64a_c3bf08a3-4d51-4859-acbb-5075f9484f87", "customerRef": { "id": "c3bf08a3-4d51-4859-acbb-5075f9484f87", "companyName": "Mr Abe" }, "accountRef": { "id": "35717508-0696-4481-a32c-2835f0ed8b4e", "name": "Test GL account 2" }, "totalAmount": 229.08, "currency": "EUR", "currencyRate": 1, "date": "2019-11-26T00:00:00Z", "lines": [ { "amount": 229.08, "links": [ { "type": "Invoice", "id": "f010d4df-13ea-45d1-8525-785164df7dd9", "amount": -229.08, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:36:13Z", "sourceModifiedDate": "2019-11-26T12:31:46Z", "reference": "19230011" }, { "id": "1650bb9c-5d9a-40f2-9015-0e251a12f861_c3bf08a3-4d51-4859-acbb-5075f9484f87", "customerRef": { "id": "c3bf08a3-4d51-4859-acbb-5075f9484f87", "companyName": "Mr Abe" }, "accountRef": { "id": "35717508-0696-4481-a32c-2835f0ed8b4e", "name": "Test GL account 2" }, "totalAmount": 991.56, "currency": "EUR", "currencyRate": 1, "date": "2019-11-26T00:00:00Z", "lines": [ { "amount": 991.56, "links": [ { "type": "Invoice", "id": "013f05e6-2583-4e6d-8309-a479808cf7bf", "amount": -991.56, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:36:13Z", "sourceModifiedDate": "2019-11-26T12:31:12Z", "reference": "19230010" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 46, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "14b7d656-07ee-4d70-aafa-61c0030c08ad_7e566728-a7f3-4860-a7f5-381664673287", "customerRef": { "id": "7e566728-a7f3-4860-a7f5-381664673287", "companyName": "Customer A" }, "accountRef": { "id": "4a4e34b5-7f62-4b64-a44a-073398b14b41", "name": "Bank" }, "totalAmount": 1, "currency": "GBP", "currencyRate": 1, "date": "2020-01-02T00:00:00Z", "lines": [ { "amount": 1, "links": [ { "type": "Invoice", "id": "6220ed43-1fec-4e17-a88f-c7ee5b949e76", "amount": -1, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:35:14Z", "sourceModifiedDate": "2020-01-02T10:08:27Z", "reference": "20200002" }, { "id": "d8b093cf-3d37-405b-9e85-72552226553f_7e566728-a7f3-4860-a7f5-381664673287", "customerRef": { "id": "7e566728-a7f3-4860-a7f5-381664673287", "companyName": "Customer A" }, "accountRef": { "id": "4a4e34b5-7f62-4b64-a44a-073398b14b41", "name": "Bank" }, "totalAmount": 1, "currency": "GBP", "currencyRate": 1, "date": "2020-01-02T00:00:00Z", "lines": [ { "amount": 1, "links": [ { "type": "Invoice", "id": "6220ed43-1fec-4e17-a88f-c7ee5b949e76", "amount": -1, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-26T13:35:14Z", "sourceModifiedDate": "2020-01-02T09:58:15Z", "reference": "20200001" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 5, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "135234099", "customerRef": { "id": "6162049", "companyName": "Wintershall Holding GmbH" }, "totalAmount": 100, "currency": "GBP", "date": "2017-11-23T00:00:00", "note": "CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 015", "lines": [ { "amount": 100, "links": [ { "type": "Invoice", "id": "21973931", "amount": -100, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-25T14:21:37Z", "metadata": { "isDeleted": false } }, { "id": "135258250", "customerRef": { "id": "6162230", "companyName": "Stronachs LLP" }, "totalAmount": 100, "currency": "GBP", "date": "2017-11-23T00:00:00", "note": "CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 006", "lines": [ { "amount": 100, "links": [ { "type": "Invoice", "id": "21952246", "amount": -100, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-25T14:21:37Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1146, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "765831", "customerRef": { "id": "113070" }, "totalAmount": 1, "currency": "GBP", "date": "2018-09-11T00:00:00", "note": "Overpayment: invoice #0000003, some test", "lines": [ { "amount": 1, "links": [ { "type": "PaymentOnAccount", "id": "113070", "amount": -1, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-24T16:07:24Z", "sourceModifiedDate": "2018-09-11T06:58:46", "metadata": { "isDeleted": false } }, { "id": "988600", "customerRef": { "id": "380630" }, "totalAmount": 5, "currency": "GBP", "date": "2019-01-21T00:00:00", "note": "Overpayment: invoice #0000007", "lines": [ { "amount": 5, "links": [ { "type": "PaymentOnAccount", "id": "380630", "amount": -5, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-24T16:07:24Z", "sourceModifiedDate": "2019-01-21T10:23:59", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 239, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments?page=2&pageSize=2" } } } }, "KashFlow": { "value": { "results": [ { "id": "139214921", "customerRef": { "id": "85743294", "companyName": "Parent customer" }, "totalAmount": 1.2, "currency": "GBP", "date": "2010-04-07T00:00:00", "note": "", "lines": [ { "amount": 1.2, "links": [ { "type": "Invoice", "id": "137055108", "amount": -1.2, "currencyRate": 1 } ] } ], "modifiedDate": "2022-09-30T10:29:15Z" }, { "id": "86861497", "customerRef": { "id": "69946501", "companyName": "Peter Lord" }, "totalAmount": 10, "currency": "GBP", "date": "2017-05-01T00:00:00", "note": "", "lines": [ { "amount": 10, "links": [ { "type": "Invoice", "id": "85315064", "amount": -10, "currencyRate": 1 } ] } ], "modifiedDate": "2022-09-30T10:29:15Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 74, "_links": { "current": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments" }, "next": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "8828", "customerRef": { "id": "417", "companyName": "10 Breww Ltd" }, "totalAmount": 0, "currency": "GBP", "currencyRate": 1, "date": "2021-04-09T00:00:00", "lines": [ { "amount": 0, "links": [ { "type": "Invoice", "id": "8530", "amount": -16, "currencyRate": 1 }, { "type": "CreditNote", "id": "8828", "amount": 16, "currencyRate": 1 } ] } ], "modifiedDate": "2022-09-20T08:18:33Z", "sourceModifiedDate": "2022-02-25T10:58:37", "reference": "Credit Memo #CM28" }, { "id": "428", "customerRef": { "id": "417", "companyName": "10 Breww Ltd" }, "accountRef": { "id": "122", "name": "Undeposited Funds" }, "totalAmount": 90, "currency": "GBP", "currencyRate": 1, "date": "2021-04-20T00:00:00", "lines": [ { "amount": 90, "links": [ { "type": "Invoice", "id": "416", "amount": -90, "currencyRate": 1 } ] }, { "amount": 10, "links": [ { "type": "Invoice", "id": "416", "amount": -10, "currencyRate": 1 } ] }, { "amount": -10, "links": [ { "type": "Other", "id": "428", "amount": 10, "currencyRate": 1 } ] } ], "modifiedDate": "2022-09-20T08:18:33Z", "sourceModifiedDate": "2022-04-28T13:36:54", "reference": "Payment #PYMT01" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 113, "_links": { "current": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments" }, "next": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "6915-1197775450", "customerRef": { "id": "220000-933272658", "companyName": "Melton, Johnny" }, "accountRef": { "id": "80000-933270541", "name": "Undeposited Funds" }, "totalAmount": 14488.64, "currency": "GBP", "currencyRate": 1, "date": "2023-01-10T00:00:00", "note": "Check - 80000-933270541", "lines": [ { "amount": 14488.64, "links": [ { "type": "Invoice", "id": "469E-1071530054", "amount": -14488.64, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:08:36Z", "sourceModifiedDate": "2023-12-16T05:06:11", "reference": "19650", "metadata": { "isDeleted": false } }, { "id": "6973-1197775625", "customerRef": { "id": "420000-1071522044", "companyName": "Prentice, Adelaide" }, "accountRef": { "id": "80000-933270541", "name": "Undeposited Funds" }, "totalAmount": 431.95, "currency": "GBP", "currencyRate": 1, "date": "2023-01-15T00:00:00", "note": "Check - 80000-933270541", "lines": [ { "amount": 431.95, "links": [ { "type": "Invoice", "id": "2453-1071526256", "amount": -431.95, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:08:36Z", "sourceModifiedDate": "2023-12-16T05:06:11", "reference": "983409", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 108, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "710", "customerRef": { "id": "9", "companyName": "Abe" }, "accountRef": { "id": "56", "name": "Undeposited Funds" }, "totalAmount": 95.2, "currency": "GBP", "currencyRate": 1, "date": "2018-10-05T00:00:00", "note": "Sarah's Test", "lines": [ { "amount": 95.2, "links": [ { "type": "Invoice", "id": "688", "amount": -95.2, "currencyRate": 1 } ] } ], "modifiedDate": "2023-01-18T11:03:14Z", "sourceModifiedDate": "2020-08-14T09:59:29Z" }, { "id": "9298", "customerRef": { "id": "9", "companyName": "Abe" }, "accountRef": { "id": "56", "name": "Undeposited Funds" }, "totalAmount": 95.2, "currency": "GBP", "currencyRate": 1, "date": "2018-10-05T00:00:00", "note": "Adeel Test", "lines": [ { "amount": 95.2, "links": [ { "type": "PaymentOnAccount", "id": "9", "amount": -95.2, "currencyRate": 1 } ] } ], "modifiedDate": "2023-01-18T11:03:18Z", "sourceModifiedDate": "2022-06-20T13:51:36Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 3723, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "25", "customerRef": { "id": "55", "companyName": "Oxon Insurance - Holiday Party" }, "accountRef": { "id": "81", "name": "Current" }, "totalAmount": 10800, "currency": "GBP", "currencyRate": 1, "date": "2016-02-12T00:00:00", "note": "", "lines": [ { "amount": 10800, "links": [ { "type": "PaymentOnAccount", "id": "55", "amount": -10800, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:36:50Z", "sourceModifiedDate": "2022-02-03T12:09:35Z", "metadata": { "isDeleted": false } }, { "id": "31", "customerRef": { "id": "59", "companyName": "Ecker Holiday event" }, "accountRef": { "id": "81", "name": "Current" }, "totalAmount": 15615, "currency": "GBP", "currencyRate": 1, "date": "2016-02-12T00:00:00", "note": "", "lines": [ { "amount": 15615, "links": [ { "type": "Invoice", "id": "30", "amount": -15615, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-26T09:36:50Z", "sourceModifiedDate": "2016-09-12T16:50:17Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 813, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "29684", "customerRef": { "id": "STE001", "companyName": "Stevenson & Smith" }, "totalAmount": 500, "currency": "GBP", "currencyRate": 1, "date": "2019-01-30T00:00:00Z", "note": "Payment on Account", "lines": [ { "amount": 12.5, "links": [ { "type": "Invoice", "id": "29676", "amount": -12.5, "currencyRate": 1 } ] }, { "amount": 487.5, "links": [ { "type": "Invoice", "id": "29851", "amount": -487.5, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-14T09:36:05Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "reference": "5897532" }, { "id": "29681", "customerRef": { "id": "MAC001", "companyName": "Macolm Hall Associates" }, "totalAmount": 0, "currency": "GBP", "currencyRate": 1, "date": "2019-12-31T00:00:00Z", "note": "Opening Balance", "lines": [ { "amount": 0, "links": [ { "type": "Invoice", "id": "29745", "amount": 0.05, "currencyRate": 1 }, { "type": "CreditNote", "id": "29681", "amount": -0.05, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-14T09:36:05Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "reference": "O/BAL" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 83, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "53", "customerRef": { "id": "STE001", "companyName": "Stevenson & Smith" }, "accountRef": { "id": "1200", "name": "Bank Current Account" }, "totalAmount": 500, "currency": "GBP", "currencyRate": 1, "date": "2021-01-30T00:00:00", "note": "Sales receipt on account 53 linked to sales invoice tx-3, sales invoice inv-31.", "lines": [ { "amount": 12.5, "links": [ { "type": "Invoice", "id": "TX-3", "amount": -12.5, "currencyRate": 1 } ] }, { "amount": 245.34, "links": [ { "type": "Invoice", "id": "INV-31", "amount": -245.34, "currencyRate": 1 } ] }, { "amount": 126.9, "links": [ { "type": "Invoice", "id": "INV-31", "amount": -126.9, "currencyRate": 1 } ] }, { "amount": 115.26, "links": [ { "type": "Invoice", "id": "INV-31", "amount": -115.26, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-30T14:42:39Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } }, { "id": "8", "customerRef": { "id": "MAC001", "companyName": "Macolm Hall Associates" }, "accountRef": { "id": "" }, "totalAmount": 0, "currency": "GBP", "currencyRate": 1, "date": "2021-12-31T00:00:00", "note": "Sales credit tx-8 linked to sales invoice inv-10.", "lines": [ { "amount": 0, "links": [ { "type": "Invoice", "id": "INV-10", "amount": -0.05, "currencyRate": 1 }, { "type": "CreditNote", "id": "TX-8", "amount": 0.05, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-30T14:42:39Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 53, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "d39f7a5733de11e797950a57719b2edb", "customerRef": { "id": "f4ff85ba33dd11e797950a57719b2edb", "companyName": "Widgets Limited" }, "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "totalAmount": -1080, "currency": "GBP", "currencyRate": 1, "date": "2017-05-08T00:00:00", "note": "Customer refund using credit/debit card", "lines": [ { "amount": -1080, "links": [ { "type": "CreditNote", "id": "c1a0176c33de11e797950a57719b2edb", "amount": 1080, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-24T14:55:39Z", "sourceModifiedDate": "2017-05-08T11:09:38Z" }, { "id": "03a5fdc8baa643fb97587033b0c4590b", "customerRef": { "id": "3cc3148bbd8111e8bad90617b3da4b8a", "companyName": "John's Test Customer" }, "accountRef": { "id": "2572c8766afc11e8aaa5027d54329956", "name": "Tide Current" }, "totalAmount": 100, "currency": "GBP", "currencyRate": 1, "date": "2017-11-23T00:00:00", "note": "Customer receipt using credit/debit card", "lines": [ { "amount": 100, "links": [ { "type": "Invoice", "id": "ede1e735bd8111e8bad90617b3da4b8a", "amount": -100, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-24T14:55:39Z", "sourceModifiedDate": "2019-01-17T14:14:55Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2321, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/payments" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/payments?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "2918", "customerRef": { "id": "12", "companyName": "MK Manufacturing" }, "accountRef": { "id": "353", "name": "Current Account" }, "paymentMethodRef": { "id": "1", "name": "Printed Check" }, "totalAmount": 120, "currency": "GBP", "date": "2021-04-22T00:00:00", "note": "", "lines": [ { "amount": 120, "links": [ { "type": "Invoice", "id": "2916", "amount": -120, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-04T16:32:02Z", "sourceModifiedDate": "2021-04-22T11:01:11Z", "metadata": { "isDeleted": false } }, { "id": "6105", "customerRef": { "id": "531", "companyName": "Shoprite" }, "accountRef": { "id": "353", "name": "Current Account" }, "paymentMethodRef": { "id": "6", "name": "Cash" }, "totalAmount": 150, "currency": "GBP", "date": "2022-04-19T00:00:00", "note": "", "lines": [ { "amount": 150, "links": [ { "type": "PaymentOnAccount", "id": "531", "amount": -150, "currencyRate": 1 } ] } ], "modifiedDate": "2023-04-04T16:32:02Z", "sourceModifiedDate": "2022-04-19T13:38:45Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/payments" } } } }, "Xero": { "value": { "results": [ { "id": "65b746c8-9a5d-4a95-8096-d2316fcff592", "customerRef": { "id": "afd4093b-c655-4847-8ee2-10a4f2c3eae3", "companyName": "Maddox Publishing Group" }, "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "totalAmount": 4200, "currency": "GBP", "currencyRate": 1, "date": "2022-02-17T00:00:00", "lines": [ { "amount": 4200, "links": [ { "type": "Invoice", "id": "321bfed3-2da2-4969-9358-4de97821181b", "amount": -4200, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-15T20:37:08Z", "sourceModifiedDate": "2021-01-02T22:50:58", "metadata": { "isDeleted": false } }, { "id": "8c481b70-b5d7-4de4-a7f7-9e161be2c472", "customerRef": { "id": "a871a956-05b5-4e2a-9419-7aeb478ca647", "companyName": "Ridgeway University" }, "accountRef": { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "name": "Business Bank Account" }, "totalAmount": 500, "currency": "GBP", "currencyRate": 1, "date": "2022-02-17T00:00:00", "lines": [ { "amount": 500, "links": [ { "type": "Invoice", "id": "4b6d0c8f-10fa-42cd-a6e5-53b175e90005", "amount": -500, "currencyRate": 1 } ] } ], "modifiedDate": "2023-03-15T20:37:08Z", "sourceModifiedDate": "2021-01-02T22:51:43", "reference": "", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 30, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/payments" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/payments?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000070175", "customerRef": { "id": "104957000000037097", "companyName": "Test Company" }, "accountRef": { "id": "104957000000060010", "name": "Abdi Test" }, "totalAmount": 9001, "currency": "GBP", "currencyRate": 1, "date": "2020-02-06T00:00:00", "note": "Cheque deposit", "lines": [ { "amount": 9001, "links": [ { "type": "Invoice", "id": "104957000000038052", "amount": -9001, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-03T08:41:17Z", "reference": "4" }, { "id": "104957000000067014", "customerRef": { "id": "104957000000037097", "companyName": "Test Company" }, "accountRef": { "id": "104957000000060010", "name": "Abdi Test" }, "totalAmount": 9001, "currency": "GBP", "currencyRate": 1, "date": "2020-02-14T00:00:00", "note": "", "lines": [ { "amount": 9001, "links": [ { "type": "Invoice", "id": "104957000000038106", "amount": -9001, "currencyRate": 1 } ] } ], "modifiedDate": "2022-10-03T08:41:17Z", "reference": "1" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 33, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List payments* endpoint returns a list of [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for a given company's connection.\n\n[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "payments" } }, "/companies/{companyId}/connections/{connectionId}/options/payments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create payment model", "tags": [ "Payments" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "FreeAgent": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [] } } }, "required": true }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must match the sum of the line amounts." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": true }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Amount", "details": "Must match the sum of the link amounts." } ] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Invoice", "type": "String", "displayName": "Invoice", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "CreditNote", "required": false }, { "value": "Other", "type": "String", "displayName": "Other", "required": false } ], "required": true } }, "required": true } }, "required": true, "validation": { "warnings": [ { "field": "Lines", "details": "Only one line may be specified" } ], "information": [] } } }, "required": true } }, "FreshBooks": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "required": true } }, "required": true, "validation": { "warnings": [ { "field": "Lines.Links", "details": "Payment Amount must not exceed Invoice Amount Due or available Customer Credit" }, { "field": "Lines.Links", "details": "Must be a Payment with one Invoice of PaymentOnAccount Link or two links of types Invoice and PaymentOnAccount" } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "Lines", "details": "Only one line is supported" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "options": [ { "value": "AED", "type": "Array", "displayName": "AED", "required": false }, { "value": "AFN", "type": "Array", "displayName": "AFN", "required": false }, { "value": "ALL", "type": "Array", "displayName": "ALL", "required": false }, { "value": "AMD", "type": "Array", "displayName": "AMD", "required": false }, { "value": "ANG", "type": "Array", "displayName": "ANG", "required": false }, { "value": "AOA", "type": "Array", "displayName": "AOA", "required": false }, { "value": "ARS", "type": "Array", "displayName": "ARS", "required": false }, { "value": "AUD", "type": "Array", "displayName": "AUD", "required": false }, { "value": "AWG", "type": "Array", "displayName": "AWG", "required": false }, { "value": "AZN", "type": "Array", "displayName": "AZN", "required": false }, { "value": "BAM", "type": "Array", "displayName": "BAM", "required": false }, { "value": "BBD", "type": "Array", "displayName": "BBD", "required": false }, { "value": "BDT", "type": "Array", "displayName": "BDT", "required": false }, { "value": "BGN", "type": "Array", "displayName": "BGN", "required": false }, { "value": "BHD", "type": "Array", "displayName": "BHD", "required": false }, { "value": "BIF", "type": "Array", "displayName": "BIF", "required": false }, { "value": "BMD", "type": "Array", "displayName": "BMD", "required": false }, { "value": "BND", "type": "Array", "displayName": "BND", "required": false }, { "value": "BOB", "type": "Array", "displayName": "BOB", "required": false }, { "value": "BRL", "type": "Array", "displayName": "BRL", "required": false }, { "value": "BSD", "type": "Array", "displayName": "BSD", "required": false }, { "value": "BTN", "type": "Array", "displayName": "BTN", "required": false }, { "value": "BWP", "type": "Array", "displayName": "BWP", "required": false }, { "value": "BYR", "type": "Array", "displayName": "BYR", "required": false }, { "value": "BZD", "type": "Array", "displayName": "BZD", "required": false }, { "value": "CAD", "type": "Array", "displayName": "CAD", "required": false }, { "value": "CDF", "type": "Array", "displayName": "CDF", "required": false }, { "value": "CHF", "type": "Array", "displayName": "CHF", "required": false }, { "value": "CLP", "type": "Array", "displayName": "CLP", "required": false }, { "value": "CNY", "type": "Array", "displayName": "CNY", "required": false }, { "value": "COP", "type": "Array", "displayName": "COP", "required": false }, { "value": "CRC", "type": "Array", "displayName": "CRC", "required": false }, { "value": "CUC", "type": "Array", "displayName": "CUC", "required": false }, { "value": "CUP", "type": "Array", "displayName": "CUP", "required": false }, { "value": "CVE", "type": "Array", "displayName": "CVE", "required": false }, { "value": "CZK", "type": "Array", "displayName": "CZK", "required": false }, { "value": "DJF", "type": "Array", "displayName": "DJF", "required": false }, { "value": "DKK", "type": "Array", "displayName": "DKK", "required": false }, { "value": "DOP", "type": "Array", "displayName": "DOP", "required": false }, { "value": "DZD", "type": "Array", "displayName": "DZD", "required": false }, { "value": "EGP", "type": "Array", "displayName": "EGP", "required": false }, { "value": "ERN", "type": "Array", "displayName": "ERN", "required": false }, { "value": "ETB", "type": "Array", "displayName": "ETB", "required": false }, { "value": "EUR", "type": "Array", "displayName": "EUR", "required": false }, { "value": "FJD", "type": "Array", "displayName": "FJD", "required": false }, { "value": "FKP", "type": "Array", "displayName": "FKP", "required": false }, { "value": "GBP", "type": "Array", "displayName": "GBP", "required": false }, { "value": "GEL", "type": "Array", "displayName": "GEL", "required": false }, { "value": "GGP", "type": "Array", "displayName": "GGP", "required": false }, { "value": "GHS", "type": "Array", "displayName": "GHS", "required": false }, { "value": "GIP", "type": "Array", "displayName": "GIP", "required": false }, { "value": "GMD", "type": "Array", "displayName": "GMD", "required": false }, { "value": "GNF", "type": "Array", "displayName": "GNF", "required": false }, { "value": "GTQ", "type": "Array", "displayName": "GTQ", "required": false }, { "value": "GYD", "type": "Array", "displayName": "GYD", "required": false }, { "value": "HKD", "type": "Array", "displayName": "HKD", "required": false }, { "value": "HNL", "type": "Array", "displayName": "HNL", "required": false }, { "value": "HRK", "type": "Array", "displayName": "HRK", "required": false }, { "value": "HTG", "type": "Array", "displayName": "HTG", "required": false }, { "value": "HUF", "type": "Array", "displayName": "HUF", "required": false }, { "value": "IDR", "type": "Array", "displayName": "IDR", "required": false }, { "value": "ILS", "type": "Array", "displayName": "ILS", "required": false }, { "value": "IMP", "type": "Array", "displayName": "IMP", "required": false }, { "value": "INR", "type": "Array", "displayName": "INR", "required": false }, { "value": "IQD", "type": "Array", "displayName": "IQD", "required": false }, { "value": "IRR", "type": "Array", "displayName": "IRR", "required": false }, { "value": "ISK", "type": "Array", "displayName": "ISK", "required": false }, { "value": "JEP", "type": "Array", "displayName": "JEP", "required": false }, { "value": "JMD", "type": "Array", "displayName": "JMD", "required": false }, { "value": "JOD", "type": "Array", "displayName": "JOD", "required": false }, { "value": "JPY", "type": "Array", "displayName": "JPY", "required": false }, { "value": "KES", "type": "Array", "displayName": "KES", "required": false }, { "value": "KGS", "type": "Array", "displayName": "KGS", "required": false }, { "value": "KHR", "type": "Array", "displayName": "KHR", "required": false }, { "value": "KMF", "type": "Array", "displayName": "KMF", "required": false }, { "value": "KPW", "type": "Array", "displayName": "KPW", "required": false }, { "value": "KRW", "type": "Array", "displayName": "KRW", "required": false }, { "value": "KWD", "type": "Array", "displayName": "KWD", "required": false }, { "value": "KYD", "type": "Array", "displayName": "KYD", "required": false }, { "value": "KZT", "type": "Array", "displayName": "KZT", "required": false }, { "value": "LAK", "type": "Array", "displayName": "LAK", "required": false }, { "value": "LBP", "type": "Array", "displayName": "LBP", "required": false }, { "value": "LKR", "type": "Array", "displayName": "LKR", "required": false }, { "value": "LRD", "type": "Array", "displayName": "LRD", "required": false }, { "value": "LSL", "type": "Array", "displayName": "LSL", "required": false }, { "value": "LYD", "type": "Array", "displayName": "LYD", "required": false }, { "value": "MAD", "type": "Array", "displayName": "MAD", "required": false }, { "value": "MDL", "type": "Array", "displayName": "MDL", "required": false }, { "value": "MGA", "type": "Array", "displayName": "MGA", "required": false }, { "value": "MKD", "type": "Array", "displayName": "MKD", "required": false }, { "value": "MMK", "type": "Array", "displayName": "MMK", "required": false }, { "value": "MNT", "type": "Array", "displayName": "MNT", "required": false }, { "value": "MOP", "type": "Array", "displayName": "MOP", "required": false }, { "value": "MRO", "type": "Array", "displayName": "MRO", "required": false }, { "value": "MUR", "type": "Array", "displayName": "MUR", "required": false }, { "value": "MVR", "type": "Array", "displayName": "MVR", "required": false }, { "value": "MWK", "type": "Array", "displayName": "MWK", "required": false }, { "value": "MXN", "type": "Array", "displayName": "MXN", "required": false }, { "value": "MYR", "type": "Array", "displayName": "MYR", "required": false }, { "value": "MZN", "type": "Array", "displayName": "MZN", "required": false }, { "value": "NAD", "type": "Array", "displayName": "NAD", "required": false }, { "value": "NGN", "type": "Array", "displayName": "NGN", "required": false }, { "value": "NIO", "type": "Array", "displayName": "NIO", "required": false }, { "value": "NOK", "type": "Array", "displayName": "NOK", "required": false }, { "value": "NPR", "type": "Array", "displayName": "NPR", "required": false }, { "value": "NZD", "type": "Array", "displayName": "NZD", "required": false }, { "value": "OMR", "type": "Array", "displayName": "OMR", "required": false }, { "value": "PAB", "type": "Array", "displayName": "PAB", "required": false }, { "value": "PEN", "type": "Array", "displayName": "PEN", "required": false }, { "value": "PGK", "type": "Array", "displayName": "PGK", "required": false }, { "value": "PHP", "type": "Array", "displayName": "PHP", "required": false }, { "value": "PKR", "type": "Array", "displayName": "PKR", "required": false }, { "value": "PLN", "type": "Array", "displayName": "PLN", "required": false }, { "value": "PYG", "type": "Array", "displayName": "PYG", "required": false }, { "value": "QAR", "type": "Array", "displayName": "QAR", "required": false }, { "value": "RON", "type": "Array", "displayName": "RON", "required": false }, { "value": "RSD", "type": "Array", "displayName": "RSD", "required": false }, { "value": "RUB", "type": "Array", "displayName": "RUB", "required": false }, { "value": "RWF", "type": "Array", "displayName": "RWF", "required": false }, { "value": "SAR", "type": "Array", "displayName": "SAR", "required": false }, { "value": "SBD", "type": "Array", "displayName": "SBD", "required": false }, { "value": "SCR", "type": "Array", "displayName": "SCR", "required": false }, { "value": "SDG", "type": "Array", "displayName": "SDG", "required": false }, { "value": "SEK", "type": "Array", "displayName": "SEK", "required": false }, { "value": "SGD", "type": "Array", "displayName": "SGD", "required": false }, { "value": "SHP", "type": "Array", "displayName": "SHP", "required": false }, { "value": "SLL", "type": "Array", "displayName": "SLL", "required": false }, { "value": "SOS", "type": "Array", "displayName": "SOS", "required": false }, { "value": "SPL", "type": "Array", "displayName": "SPL", "required": false }, { "value": "SRD", "type": "Array", "displayName": "SRD", "required": false }, { "value": "STD", "type": "Array", "displayName": "STD", "required": false }, { "value": "SVC", "type": "Array", "displayName": "SVC", "required": false }, { "value": "SYP", "type": "Array", "displayName": "SYP", "required": false }, { "value": "SZL", "type": "Array", "displayName": "SZL", "required": false }, { "value": "THB", "type": "Array", "displayName": "THB", "required": false }, { "value": "TJS", "type": "Array", "displayName": "TJS", "required": false }, { "value": "TMT", "type": "Array", "displayName": "TMT", "required": false }, { "value": "TND", "type": "Array", "displayName": "TND", "required": false }, { "value": "TOP", "type": "Array", "displayName": "TOP", "required": false }, { "value": "TRY", "type": "Array", "displayName": "TRY", "required": false }, { "value": "TTD", "type": "Array", "displayName": "TTD", "required": false }, { "value": "TVD", "type": "Array", "displayName": "TVD", "required": false }, { "value": "TWD", "type": "Array", "displayName": "TWD", "required": false }, { "value": "TZS", "type": "Array", "displayName": "TZS", "required": false }, { "value": "UAH", "type": "Array", "displayName": "UAH", "required": false }, { "value": "UGX", "type": "Array", "displayName": "UGX", "required": false }, { "value": "USD", "type": "Array", "displayName": "USD", "required": false }, { "value": "UYU", "type": "Array", "displayName": "UYU", "required": false }, { "value": "UZS", "type": "Array", "displayName": "UZS", "required": false }, { "value": "VEF", "type": "Array", "displayName": "VEF", "required": false }, { "value": "VND", "type": "Array", "displayName": "VND", "required": false }, { "value": "VUV", "type": "Array", "displayName": "VUV", "required": false }, { "value": "WST", "type": "Array", "displayName": "WST", "required": false }, { "value": "XAF", "type": "Array", "displayName": "XAF", "required": false }, { "value": "XCD", "type": "Array", "displayName": "XCD", "required": false }, { "value": "XDR", "type": "Array", "displayName": "XDR", "required": false }, { "value": "XOF", "type": "Array", "displayName": "XOF", "required": false }, { "value": "XPF", "type": "Array", "displayName": "XPF", "required": false }, { "value": "YER", "type": "Array", "displayName": "YER", "required": false }, { "value": "ZAR", "type": "Array", "displayName": "ZAR", "required": false }, { "value": "ZMW", "type": "Array", "displayName": "ZMW", "required": false }, { "value": "ZWD", "type": "Array", "displayName": "ZWD", "required": false } ], "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "Can be used for Payments on Account only" } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false } }, "required": true } }, "MYOB AccountRight and Essentials": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the payment has been sent by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must be a valid GUID." }, { "field": "CustomerRef.Id", "details": "Must match the ID of an existing customer." } ], "information": [ { "field": "CustomerRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "CustomerRef", "details": "Must be provided." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a valid GUID." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Precision must be maximum of two decimal places." }, { "field": "TotalAmount", "details": "Must be greater than zero." } ], "information": [ { "field": "TotalAmount", "details": "Must be provided and must equal the sum of the link items amount." } ] } }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true, "validation": { "warnings": [], "information": [ { "field": "Date", "details": "Must be provided." } ] } }, "reference": { "type": "String", "displayName": "Reference", "description": "A user friendly reference for the payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Reference", "details": "Must not be greater than 8 characters long." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "options": [ { "value": "AUD", "type": "String", "displayName": "Australian Dollar", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Must be provided." } ] } }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Amount", "details": "Must be provided." } ] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Id", "details": "Must be provided." } ] } }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Amount", "details": "Precision must be maximum of two decimal places." }, { "field": "Links.Amount", "details": "Must be provided." } ] } }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Invoice", "type": "String", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Type", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Links", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines", "details": "Must be provided." } ] } } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the payment has been sent by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account of type 'Bank' OR type 'Asset' (with category 'FixedAsset'/'OthAsset'/'OthCurrAsset') OR type 'Liability' (with category 'LongTermLiab'/'OthCurrLiab') OR type 'Expense' (with category 'Expense'/'OthExpense')" } ], "information": [] } } }, "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must be greater than zero" }, { "field": "TotalAmount", "details": "Must be provided and must be equal to the sum of the lines amounts" } ], "information": [] } }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "If the currency is set make sure it's the same as the 'Invoice' and/or 'CreditMemo' currency" } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false }, "reference": { "type": "String", "displayName": "Reference", "description": "A user friendly reference for the payment", "required": false, "validation": { "warnings": [ { "field": "Reference", "details": "The id format should be 'location-'" } ], "information": [ { "field": "Reference", "details": "This field can be used to provide a tracking category id (Location only)" } ] } }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true, "validation": { "warnings": [ { "field": "Links.Id", "details": "If the Link Type specified is an 'Invoice' or 'CreditNote' make sure the status is either 'PartiallyPaid' or 'Submitted'" } ], "information": [] } }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Invoice", "type": "String", "displayName": "Invoice", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "Credit Note", "required": false }, { "value": "PaymentOnAccount", "type": "String", "displayName": "Payment On Account", "required": false } ], "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true } }, "required": true } }, "required": true } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the payment has been sent by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must match the ID of an existing supplier." } ], "information": [] } } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing 'Bank' or 'Other Current Asset' account." } ], "information": [ { "field": "AccountRef.Id", "details": "Not required if total amount of the payment is 0." } ] } } }, "required": true }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false }, "reference": { "type": "String", "displayName": "Reference", "description": "A user friendly reference for the payment", "required": false, "validation": { "warnings": [ { "field": "Reference", "details": "Max length of 20 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "Must be a three letter ISO code that matches the currency of the customer." }, { "field": "Currency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "Currency", "details": "If not set, will default to the default currency of the customer." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1." }, { "field": "CurrencyRate", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must match the sum of amounts in the lines" } ], "information": [] } }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true, "validation": { "warnings": [ { "field": "Lines.Amount", "details": "Amount plus the sum of amounts in the links must equal 0" } ], "information": [] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Invoice", "type": "String", "displayName": "Invoice", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "Credit Note", "required": false }, { "value": "PaymentOnAccount", "type": "String", "displayName": "Payment On Account", "required": false } ], "required": true, "validation": { "warnings": [ { "field": "Links.Type", "details": "Only 1 link with type 'PaymentOnAccount' may be specified per line, this line may contain no other links" }, { "field": "Links.Type", "details": "Only 1 link with type 'Invoice' may be specified per line" } ], "information": [] } }, "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true } }, "required": true } }, "required": true } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the payment has been sent by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "CustomerRef", "details": "Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "AccountRef", "details": "Must match the ID of an existing Account." } ] } }, "paymentMethodRef": { "type": "Object", "displayName": "Payment Method Reference", "description": "Reference to the method of this payment", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the payment method", "required": true } }, "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Required if multi-currency is enabled for the company" } ] } }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Invoice", "type": "String", "displayName": "Invoice", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "Credit Note", "required": false }, { "value": "PaymentOnAccount", "type": "String", "displayName": "Payment On Account", "required": false } ], "required": true }, "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true } }, "required": true } }, "required": false } }, "required": true } }, "QuickBooks Online": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the payment has been sent by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "CustomerRef", "details": "Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "AccountRef", "details": "Must match the ID of an existing Account." } ] } }, "paymentMethodRef": { "type": "Object", "displayName": "Payment Method Reference", "description": "Reference to the method of this payment", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the payment method", "required": true } }, "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Required if multi-currency is enabled for the company" } ] } }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Invoice", "type": "String", "displayName": "Invoice", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "Credit Note", "required": false }, { "value": "PaymentOnAccount", "type": "String", "displayName": "Payment On Account", "required": false } ], "required": true }, "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true } }, "required": true } }, "required": false } }, "required": true } }, "Sage 50 (UK)": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "accountRef": { "type": "Object", "displayName": "Bank Account", "description": "The bank account to pay this invoice from.", "properties": { "id": { "type": "String", "displayName": "Account Id", "description": "Nominal code of the bank account.", "required": true, "validation": { "warnings": [ { "field": "accountRef.id", "details": "Must match the ID of an existing bank account and have a max length of 8 characters." } ], "information": [] } } }, "required": true }, "customerRef": { "type": "Object", "displayName": "Customer", "description": "Customer to be paid.", "properties": { "id": { "type": "String", "displayName": "Customer Id", "description": "Identifier of the customer.", "required": true, "validation": { "warnings": [ { "field": "customerRef.id", "details": "Must match the ID of an existing customer and have a max length of 8 characters." } ], "information": [] } } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount being paid to the customer.", "required": true, "validation": { "warnings": [], "information": [ { "details": "This must equal the sum of the line amounts" } ] } }, "reference": { "type": "Number", "displayName": "Reference", "description": "The user reference for this invoice payment.", "required": false }, "date": { "type": "Number", "displayName": "Issue Date", "description": "The date this payment was issued.", "required": true }, "note": { "type": "Number", "displayName": "Note", "description": "A description of the payment.", "required": false }, "lines": { "type": "Array", "displayName": "Line Items", "description": "Line items of the payment.", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The amount of this line item", "required": true, "validation": { "warnings": [], "information": [ { "details": "this must equal the negative of the sum of the link amounts" } ] } }, "links": { "type": "Array", "displayName": "Links", "description": "Links to the invoice being paid.", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The amount to be added to the value of the invoice", "required": true, "validation": { "warnings": [], "information": [ { "details": "When paying off an invoice, this value will be negative" } ] } }, "id": { "type": "String", "displayName": "Invoice Id", "description": "The ID of the invoice to pay", "required": true }, "type": { "type": "String", "displayName": "Payment Link Type", "description": "The type of the item to be paid", "options": [ { "value": "Invoice", "type": "String", "displayName": "Invoice", "required": false }, { "value": "PaymentOnAccount", "type": "String", "displayName": "Payment On Account", "required": false }, { "value": "Refund", "type": "String", "displayName": "Refund", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "Credit Note", "required": false }, { "value": "Payment", "type": "String", "displayName": "Payment", "required": false } ], "required": true } }, "required": true } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Sage 50 only supports one line item per invoice payment so all lines will be merged together in the response." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company." } ] } } }, "Sage Business Cloud Accounting": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing Account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be provided." } ] } } }, "required": false, "validation": { "warnings": [ { "field": "AccountRef", "details": "Required unless the Payment is only allocating a Credit Note." } ], "information": [] } }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the payment has been sent by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must match the ID of an existing Customer." } ], "information": [ { "field": "CustomerRef.Id", "details": "Must be provided." } ] } } }, "required": true }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true, "validation": { "warnings": [], "information": [ { "field": "Date", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must be zero when allocating against Invoices using a Credit Note only." }, { "field": "TotalAmount", "details": "Must equal the sum of the link items amount." } ], "information": [ { "field": "TotalAmount", "details": "Must be provided." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Should not be longer than 25 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "If supplied, must match the currency of the customer." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": false }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Id", "details": "Must be provided." } ] } }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true, "validation": { "warnings": [ { "field": "Links.Amount", "details": "Must be greater than zero except when Type is Invoice" } ], "information": [ { "field": "Links.Amount", "details": "Must be provided." } ] } }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Invoice", "type": "String", "displayName": "Invoice", "required": false }, { "value": "PaymentOnAccount", "type": "String", "displayName": "PaymentOnAccount", "required": false }, { "value": "Refund", "type": "String", "displayName": "Refund", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "CreditNote", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Type", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Links", "details": "Must be provided." } ] } } }, "required": true } }, "required": true } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [], "information": [ { "field": "TotalAmount", "details": "Must equal the sum of Lines.Amount." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Note", "details": "Must be less than 1000 characters." } ] } }, "paymentMethodRef": { "type": "Object", "displayName": "Payment Method Reference", "description": "Reference to the method of this payment", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the payment method", "options": [ { "value": "1", "type": "String", "displayName": "Printed Check", "required": false }, { "value": "3", "type": "String", "displayName": "Credit Card", "required": false }, { "value": "5", "type": "String", "displayName": "EFT", "required": false }, { "value": "6", "type": "String", "displayName": "Cash", "required": false } ], "required": true } }, "required": true }, "reference": { "type": "String", "displayName": "Reference", "description": "A user friendly reference for the payment", "required": false, "validation": { "warnings": [], "information": [ { "field": "Reference", "details": "Can be used to set the Document/Check No. in Sage Intacct." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "Is required if currency is provided." } ] } }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true, "validation": { "warnings": [], "information": [ { "field": "Date", "details": "Must occur after the date the invoice was created." } ] } }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the payment has been sent by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [], "information": [ { "field": "CustomerRef.Id", "details": "Must be an existing customer ID in Sage Intacct." } ] } } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "For undeposited payments use the GL account record number to charge." }, { "field": "AccountRef.Id", "details": "To charge either a savings, checking or credit card account use its associated GL account number." } ] } } }, "required": true }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Amount", "details": "When added together with the sum of the Links.Amount the total must be zero." } ] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Id", "details": "Must be a valid Record No. from accounts receivable of either an invoice for an 'Invoice', adjustment for a 'CreditNote' or an advance for a 'PaymentOnAccount' in Sage Intacct." }, { "field": "Links.Id", "details": "Must be an integer." }, { "field": "Links.Id", "details": "Must related to CustomerRef.Id in Sage Intacct." } ] } }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Type", "details": "Must be one of Invoiceor CreditNoteor PaymentOnAccount." } ] } }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Amount", "details": "Must not be more than the total amount due for an invoice or the available funds in the account to be charged." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Links", "details": "No more than two links can exist when paying for an invoice via a CreditNoteor PaymentOnAccount." }, { "field": "Lines.Links", "details": "Must contain only one Invoice." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines", "details": "Must contain at least one payment line." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Sage Intacct handles allocated payments only." } ] } } }, "Sandbox": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the payment has been sent by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true }, "companyName": { "type": "String", "displayName": "Name", "description": "The name of the customer referenced by the identifier", "required": true } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "paymentMethodRef": { "type": "Object", "displayName": "Payment Method Reference", "description": "Reference to the method of this payment", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the payment method", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the payment method referenced by the identifier", "required": true } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": true }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": true }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "required": true }, "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the currency of the linked transaction", "required": true } }, "required": true }, "allocatedOnDate": { "type": "DateTime", "displayName": "Allocated On Date", "description": "The date the payment was allocated", "required": true } }, "required": true }, "reference": { "type": "String", "displayName": "Reference", "description": "A user friendly reference for the payment", "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the payment has been sent by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true, "validation": { "warnings": [ { "field": "CustomerRef.Id", "details": "Must be a valid GUID." }, { "field": "CustomerRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "CustomerRef.Id", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "CustomerRef", "details": "Must be provided." } ] } }, "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a valid GUID." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Must be either a type of BANK account or enable payments must be switched on." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef", "details": "Must be provided." } ] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must be greater than 0, unless the payment is a credit note allocation." } ], "information": [ { "field": "TotalAmount", "details": "Must be provided and must equal the sum of the link items amount." } ] } }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true, "validation": { "warnings": [], "information": [ { "field": "Date", "details": "Must be provided." } ] } }, "reference": { "type": "String", "displayName": "Reference", "description": "A user friendly reference for the payment", "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": true, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Must be provided." } ] } }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The total amount for the line in the payment currency", "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Amount", "details": "Must be provided." } ] } }, "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true, "validation": { "warnings": [ { "field": "Links.Id", "details": "Must be a valid GUID." } ], "information": [ { "field": "Links.Id", "details": "Invoice and Credit Note ID must be provided in order to allocate a Credit Note to an Invoice." }, { "field": "Links.Id", "details": "Must be provided." } ] } }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Amount", "details": "Must be provided." } ] } }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "value": "Invoice", "type": "String", "displayName": "Invoice", "required": false }, { "value": "CreditNote", "type": "String", "displayName": "CreditNote", "required": false }, { "value": "Payment", "type": "String", "displayName": "Payment", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Links.Type", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines.Links", "details": "Must be provided." } ] } } }, "required": true, "validation": { "warnings": [], "information": [ { "field": "Lines", "details": "Must be provided." } ] } } }, "required": true } }, "Zoho Books": { "value": { "type": "Object", "displayName": "Payment", "description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)", "properties": { "accountRef": { "type": "Object", "displayName": "Nominal Account Reference", "description": "Reference to the nominal account the payment is linked to", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "AccountRef.ID is required when making a payment to an invoice and/or a payment on account" } ], "information": [] } } }, "required": true }, "customerRef": { "type": "Object", "displayName": "Customer Reference", "description": "Reference to the customer the payment has been sent by", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the customer", "required": true } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the payment", "required": true, "validation": { "warnings": [ { "field": "Currency", "details": "must match the currency of any invoices or credit notes" } ], "information": [] } }, "date": { "type": "DateTime", "displayName": "Date", "description": "The date the payment was recorded", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Exchange Rate", "description": "The exchange rate between the currency of the payment and the base currency of the company", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional text based information associated with the payment", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the payment, inclusive of discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "must be greater than or equal to 0" } ], "information": [] } }, "lines": { "type": "Array", "displayName": "Lines", "description": "A collection of payment lines", "properties": { "links": { "type": "Array", "displayName": "Links", "description": "A collection of linked transactions", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity", "required": true, "validation": { "warnings": [ { "field": "Links.Amount", "details": "the sum of all link amounts must equal the negated total amount of the payment" } ], "information": [] } }, "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the referenced transaction", "required": true }, "type": { "type": "String", "displayName": "Link Type", "description": "The type of transaction that is being linked", "options": [ { "type": "Array", "displayName": "Invoice", "required": false }, { "type": "Array", "displayName": "CreditNote", "required": false }, { "type": "Array", "displayName": "PaymentOnAccount", "required": false } ], "required": true } }, "required": true, "validation": { "warnings": [ { "field": "Lines.Links", "details": "if a credit note link is provided, exactly one invoice link must be provided, otherwise unlimited invoice links and one payment on account link are allowed" } ], "information": [] } } }, "required": true } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-payments-model", "description": "The *Get create payment model* endpoint returns the expected data for the request payload when creating a [payment](https://docs.codat.io/accounting-api#/schemas/Payment) for a given company and integration.\n\n[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support creating a payment.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/payments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Payments" ], "summary": "Create payment", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" }, "examples": { "QuickBooks Desktop": { "value": { "customerRef": { "id": "80000002-1674552702", "companyName": "string" }, "accountRef": { "id": "8000002E-1675267199", "name": "Undeposited Funds" }, "paymentMethodRef": { "id": "string", "name": "string" }, "totalAmount": 28, "currency": "USD", "currencyRate": 1, "date": "2023-02-10T11:47:04.792Z", "note": "note 14/02 1147", "lines": [ { "amount": 28, "links": [ { "type": "Invoice", "id": "181-1676374586", "amount": -28, "currencyRate": 1 } ], "allocatedOnDate": "2023-02-11T11:47:04.792Z" } ], "reference": "ref 14/02 1147" } }, "Sage 50 (UK)": { "value": { "customerRef": { "id": "CUST1" }, "accountRef": { "id": "1200", "name": "Bank Current Account" }, "paymentMethodRef": { "id": "4405" }, "totalAmount": 4, "currency": "GBP", "currencyRate": 1, "date": "2023-03-17T11:47:04.792Z", "note": "note 07/03 14.31", "lines": [ { "amount": 4, "links": [ { "type": "Invoice", "id": "INV-31", "amount": -4, "currencyRate": 1 } ], "allocatedOnDate": "2023-02-11T11:47:04.792Z" } ], "reference": "ref" } }, "Sage Business Cloud Accounting": { "value": { "customerRef": { "id": "30444c5bd4964fd787c7f8e2e5301ce1", "companyName": "Stanley test customer" }, "accountRef": { "id": "9a25937b267a11e797950a57719b2edb", "name": "Current" }, "totalAmount": 0.17, "currency": "GBP", "currencyRate": 1, "date": "2023-03-20T11:47:04.792Z", "note": "Need to send products asap.", "lines": [ { "amount": 0.17, "links": [ { "type": "Invoice", "id": "bb85db9226d7450fb99eb83e7fb37505", "amount": -0.17, "currencyRate": 1 } ], "allocatedOnDate": "2023-02-11T11:47:04.792Z" } ], "reference": "normal payment 20/03 17.05" } }, "Sage Intacct": { "value": { "customerRef": { "id": "19" }, "accountRef": { "id": "81" }, "date": "2022-03-12T00:00:00", "totalAmount": 0, "lines": [ { "amount": 0, "links": [ { "id": "246", "type": "Invoice", "amount": -1.1 }, { "id": "280", "type": "CreditNote", "amount": 1.1 } ] } ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentResponse" }, "examples": { "Sage Intacct": { "value": { "data": { "customerRef": { "id": "19" }, "accountRef": { "id": "81" }, "totalAmount": 0, "date": "2022-03-12T00:00:00", "lines": [ { "amount": 0, "links": [ { "type": "Invoice", "id": "246", "amount": -1.1 }, { "type": "CreditNote", "id": "280", "amount": 1.1 } ] } ] }, "dataType": "payments", "companyId": "ffa6368e-fde4-4165-9a0a-4bda1a6f916e", "pushOperationKey": "673f5d97-1c53-41ef-b9c8-cc9a8415d17c", "dataConnectionKey": "bbecdbf3-913a-43ae-9c91-e830b3686657", "requestedOnUtc": "0001-01-01T00:00:00", "status": "Pending", "statusCode": 202 } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create payment* endpoint creates a new [payment](https://docs.codat.io/accounting-api#/schemas/Payment) for a given company's connection.\n\n[Payments](https://docs.codat.io/accounting-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create payment model](https://docs.codat.io/accounting-api#/operations/get-create-payments-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=payments) for integrations that support creating an account.\n", "operationId": "create-payment" } }, "/companies/{companyId}/data/purchaseOrders": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Purchase orders" ], "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrders" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "7f07b584-bebe-450f-aa9e-1d7aed630b66", "purchaseOrderNumber": "ee9b8e00-49a2-4d83-bc33-e2eee59a1c36", "issueDate": "2022-04-27T00:00:00", "paymentDueDate": "2022-09-06T00:00:00", "expectedDeliveryDate": "2022-07-21T00:00:00", "note": "Purchase Order with 2 line items, totaling 10978.05", "shipTo": { "contact": { "name": "Lakin, Schmeler and Kihn", "email": "hello@LakinSchmelerandKihn.co.uk", "phone": "016977 9004" }, "address": { "type": "Billing", "line1": "Apt. 590", "line2": "6901 Elouise Road", "city": "Brisafort", "region": "Scotland", "country": "United Kingdom", "postalCode": "SL27 7CP" } }, "supplierRef": { "id": "7GObELDcsE", "supplierName": "Lakin, Schmeler and Kihn" }, "status": "Open", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 1371.39, "quantity": 7, "discountAmount": 0, "discountPercentage": 0, "subTotal": 9599.73, "taxAmount": 959.97, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 10559.7 }, { "description": "Underground - Drain Bottle Gullies 90 degree Rectangular", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "6", "name": "Back Inlet Roddable Gully 90� Outlet Rectangular Grid" }, "trackingCategoryRefs": [], "unitAmount": 95.08, "quantity": 4, "discountAmount": 0, "discountPercentage": 0, "subTotal": 380.32, "taxAmount": 38.03, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 418.35 } ], "totalDiscount": 0, "subTotal": 9980.05, "totalTaxAmount": 998, "totalAmount": 10978.05, "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2023-04-14T01:56:02", "metadata": { "isDeleted": false } }, { "id": "9078102a-ae12-4a7e-b672-c81ff1279ea6", "purchaseOrderNumber": "a7c511c3-092e-42d7-81a9-f7b423ebf684", "issueDate": "2022-04-30T00:00:00", "paymentDueDate": "2022-07-12T00:00:00", "expectedDeliveryDate": "2022-07-15T00:00:00", "deliveryDate": "2022-07-05T00:00:00", "note": "Purchase Order with 13 line items, totaling 122769.69", "shipTo": { "contact": { "name": "Ralph Wilderman", "email": "Ralph60@hotmail.com", "phone": "023 2247 6717" }, "address": { "type": "Delivery", "line1": "Apt. 717", "line2": "5205 Schaefer Roads", "city": "Metzton", "region": "England", "country": "United Kingdom", "postalCode": "MS40 8LV" } }, "supplierRef": { "id": "07c9216c-e646-4fac-b5c2-3fc1b61ae395", "supplierName": "Ralph Wilderman" }, "status": "Open", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Underground - Drain Yard Gully", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "00491160-6ee5-4d76-9f34-998f00687481", "name": "Aluminium Silt Bucket" }, "trackingCategoryRefs": [], "unitAmount": 171.21, "quantity": 7, "discountAmount": 0, "discountPercentage": 0, "subTotal": 1198.47, "taxAmount": 119.85, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 1318.32 }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 1371.39, "quantity": 5, "discountAmount": 0, "discountPercentage": 0, "subTotal": 6856.95, "taxAmount": 685.7, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 7542.65 }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 1371.39, "quantity": 9, "discountAmount": 0, "discountPercentage": 0, "subTotal": 12342.51, "taxAmount": 1234.25, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 13576.76 }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 2781.94, "quantity": 8, "discountAmount": 0, "discountPercentage": 0, "subTotal": 22255.52, "taxAmount": 2225.55, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 24481.07 }, { "description": "Underground - Drain Bottle Gullies 90 degree Rectangular", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "6", "name": "Back Inlet Roddable Gully 90� Outlet Rectangular Grid" }, "trackingCategoryRefs": [], "unitAmount": 95.08, "quantity": 5, "discountAmount": 0, "discountPercentage": 0, "subTotal": 475.4, "taxAmount": 47.54, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 522.94 }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "51077072-d5c3-463b-9cb4-7da2e11886f9", "name": "150 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 1251.89, "quantity": 5, "discountAmount": 0, "discountPercentage": 0, "subTotal": 6259.45, "taxAmount": 625.95, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 6885.4 }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 1371.39, "quantity": 7, "discountAmount": 0, "discountPercentage": 0, "subTotal": 9599.73, "taxAmount": 959.97, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 10559.7 }, { "description": "Underground - Trapped Road Gully 450mm x 450mm", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "3abf0883-03f7-44c6-bc15-1372522d25e1", "name": "Heavy Duty Hinged Gully Grating" }, "trackingCategoryRefs": [], "unitAmount": 402.89, "quantity": 6, "discountAmount": 0, "discountPercentage": 0, "subTotal": 2417.34, "taxAmount": 241.73, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 2659.07 }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 2781.94, "quantity": 6, "discountAmount": 0, "discountPercentage": 0, "subTotal": 16691.64, "taxAmount": 1669.16, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 18360.8 }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 2781.94, "quantity": 3, "discountAmount": 0, "discountPercentage": 0, "subTotal": 8345.82, "taxAmount": 834.58, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 9180.4 }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 2781.94, "quantity": 7, "discountAmount": 0, "discountPercentage": 0, "subTotal": 19473.58, "taxAmount": 1947.36, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 21420.94 }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "51077072-d5c3-463b-9cb4-7da2e11886f9", "name": "150 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 1251.89, "quantity": 4, "discountAmount": 0, "discountPercentage": 0, "subTotal": 5007.56, "taxAmount": 500.76, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 5508.32 }, { "description": "Underground - Drain Yard Gully", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "00491160-6ee5-4d76-9f34-998f00687481", "name": "Aluminium Silt Bucket" }, "trackingCategoryRefs": [], "unitAmount": 171.21, "quantity": 4, "discountAmount": 0, "discountPercentage": 0, "subTotal": 684.84, "taxAmount": 68.48, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 753.32 } ], "totalDiscount": 0, "subTotal": 111608.81, "totalTaxAmount": 11160.88, "totalAmount": 122769.69, "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2022-09-19T05:51:02", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 116, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/purchaseOrders?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/purchaseOrders" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/purchaseOrders?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "168487", "purchaseOrderNumber": "Purchase Order #PO885", "issueDate": "2022-07-18T00:00:00", "shipTo": { "contact": { "name": "Codat Limited : Codat Europe" }, "address": { "type": "Delivery", "country": "United Kingdom" } }, "supplierRef": { "id": "724", "supplierName": "Vendor A.A.A" }, "status": "Draft", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "844", "name": "Asset account test 2" }, "trackingCategoryRefs": [ { "id": "location-4", "name": "Europe" } ], "unitAmount": 13.23, "quantity": 1, "unitOfMeasurement": "litre", "discountAmount": 0, "discountPercentage": 0, "subTotal": 13.23, "taxAmount": 0, "totalAmount": 13.23 }, { "description": "VAT", "accountRef": { "id": "211", "name": "VAT on Purchases" }, "trackingCategoryRefs": [ { "id": "location-4", "name": "Europe" } ], "unitAmount": 0, "quantity": 0, "discountAmount": 0, "discountPercentage": 0, "subTotal": 0, "taxAmount": 0, "taxRateRef": { "id": "9", "name": "Exempt", "effectiveTaxRate": 0 }, "totalAmount": 0 } ], "totalDiscount": 0, "subTotal": 13.23, "totalTaxAmount": 0, "totalAmount": 13.23, "createdBy": { "firstName": "John", "lastName": "Smith", "email": "john.smith@codat.io" }, "modifiedDate": "2023-01-30T14:46:49Z", "sourceModifiedDate": "2022-07-18T13:50:13" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/purchaseOrders?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/purchaseOrders" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "69D1-1197779848", "purchaseOrderNumber": "6001", "issueDate": "2022-12-01T00:00:00", "paymentDueDate": "2023-12-16T00:00:00", "expectedDeliveryDate": "2022-12-01T00:00:00", "deliveryDate": "2022-12-01T00:00:00", "shipTo": { "contact": { "name": "Vasquez, Anabel:Basement Remodel" }, "address": { "type": "Delivery", "line1": "Anabel Vasquez", "line2": "5601 Legacy Parkway", "city": "San Mateo", "region": "CA", "postalCode": "094 02" } }, "supplierRef": { "id": "800000B4-1197779815", "supplierName": "Vu Contracting" }, "status": "Open", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Install carpeting", "itemRef": { "id": "60000-933272656", "name": "Subs:Carpet" }, "trackingCategoryRefs": [], "unitAmount": 25, "quantity": 7, "discountAmount": 0, "discountPercentage": 0, "subTotal": 175, "taxAmount": 0, "totalAmount": 175 }, { "description": "Install drywall", "itemRef": { "id": "70000-933272656", "name": "Subs:Drywall" }, "trackingCategoryRefs": [], "unitAmount": 25, "quantity": 25, "discountAmount": 0, "discountPercentage": 0, "subTotal": 625, "taxAmount": 0, "totalAmount": 625 }, { "description": "Heating & Air Conditioning Duct Work", "itemRef": { "id": "3C0000-1071513137", "name": "Subs:Duct Work" }, "trackingCategoryRefs": [], "unitAmount": 25, "quantity": 15, "discountAmount": 0, "discountPercentage": 0, "subTotal": 375, "taxAmount": 0, "totalAmount": 375 }, { "description": "Electrical work", "itemRef": { "id": "80000-933272656", "name": "Subs:Electrical" }, "trackingCategoryRefs": [], "unitAmount": 25, "quantity": 10, "discountAmount": 0, "discountPercentage": 0, "subTotal": 250, "taxAmount": 0, "totalAmount": 250 }, { "description": "Install insulation", "itemRef": { "id": "90000-933272656", "name": "Subs:Insulating" }, "trackingCategoryRefs": [], "unitAmount": 25, "quantity": 5, "discountAmount": 0, "discountPercentage": 0, "subTotal": 125, "taxAmount": 0, "totalAmount": 125 }, { "description": "Painting", "itemRef": { "id": "B0000-933272656", "name": "Subs:Painting" }, "trackingCategoryRefs": [], "unitAmount": 25, "quantity": 20, "discountAmount": 0, "discountPercentage": 0, "subTotal": 500, "taxAmount": 0, "totalAmount": 500 } ], "totalDiscount": 0, "subTotal": 2050, "totalTaxAmount": 0, "totalAmount": 2050, "modifiedDate": "2023-04-26T09:13:03Z", "sourceModifiedDate": "2023-12-16T05:06:12", "metadata": { "isDeleted": false } }, { "id": "2A97-1071506491", "purchaseOrderNumber": "6100", "issueDate": "2023-07-15T00:00:00", "paymentDueDate": "2024-08-14T00:00:00", "expectedDeliveryDate": "2023-07-15T00:00:00", "deliveryDate": "2023-07-15T00:00:00", "shipTo": { "address": { "type": "Delivery", "line1": "Rock Castle Construction", "line2": "1735 County Road", "city": "Bayshore", "region": "CA", "postalCode": "94326" } }, "supplierRef": { "id": "C0000-933272656", "supplierName": "Perry Windows & Doors" }, "status": "Open", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "itemRef": { "id": "3A0000-1071506378", "name": "Patio Door" }, "trackingCategoryRefs": [], "unitAmount": 144.75, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 144.75, "taxAmount": 0, "totalAmount": 144.75 } ], "totalDiscount": 0, "subTotal": 144.75, "totalTaxAmount": 0, "totalAmount": 144.75, "modifiedDate": "2023-04-26T09:13:03Z", "sourceModifiedDate": "2023-12-16T05:04:32", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 41, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/purchaseOrders?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/purchaseOrders" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/purchaseOrders?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "3900", "purchaseOrderNumber": "1001", "issueDate": "2020-12-02T00:00:00", "expectedDeliveryDate": "0001-01-01T00:00:00", "shipTo": { "address": { "type": "Unknown", "line1": "Widgets Limited (Production)", "line2": "17 Minstrel Court, Teesdale Close", "city": "LONDON", "country": "LO", "postalCode": "E2 6PQ" } }, "supplierRef": { "id": "6", "supplierName": "Jane Doe" }, "status": "Open", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "expense", "itemRef": { "id": "31", "name": "Consulting Services" }, "trackingCategoryRefs": [], "unitAmount": 100, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 100, "taxAmount": 0, "taxRateRef": { "id": "33_Bills", "name": "TaxTest1 Bills", "effectiveTaxRate": 10 }, "totalAmount": 100 } ], "totalDiscount": 0, "subTotal": 100, "totalTaxAmount": 10, "totalAmount": 110, "modifiedDate": "2023-01-18T11:02:40Z", "sourceModifiedDate": "2020-12-02T12:51:49Z" }, { "id": "3928", "purchaseOrderNumber": "1001", "issueDate": "2020-12-03T00:00:00", "expectedDeliveryDate": "0001-01-01T00:00:00", "shipTo": { "address": { "type": "Unknown", "line1": "Widgets Limited (Production)", "line2": "17 Minstrel Court, Teesdale Close", "city": "LONDON", "country": "LO", "postalCode": "E2 6PQ" } }, "supplierRef": { "id": "6", "supplierName": "Jane Doe" }, "status": "Open", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "expense push pO prod uodate", "itemRef": { "id": "31", "name": "Consulting Services" }, "trackingCategoryRefs": [], "unitAmount": 100, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 100, "taxAmount": 0, "taxRateRef": { "id": "33_Bills", "name": "TaxTest1 Bills", "effectiveTaxRate": 10 }, "totalAmount": 100 } ], "totalDiscount": 0, "subTotal": 100, "totalTaxAmount": 10, "totalAmount": 110, "modifiedDate": "2023-01-18T11:02:40Z", "sourceModifiedDate": "2020-12-08T08:27:53Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 5, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/purchaseOrders?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/purchaseOrders" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/purchaseOrders?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "17", "purchaseOrderNumber": "1002", "issueDate": "2015-12-22T00:00:00", "expectedDeliveryDate": "0001-01-01T00:00:00", "shipTo": { "address": { "type": "Unknown", "line1": "Long for Successful Events -- Sample Company", "line2": "2500 Garcia Ave", "city": "SomeCity", "postalCode": "CR2 6XH" } }, "supplierRef": { "id": "57", "supplierName": "Hall's Promo Items" }, "status": "Closed", "currency": "HKD", "currencyRate": 0.080028, "lineItems": [ { "description": "Water bottles -- generic", "itemRef": { "id": "19", "name": "Water Bottles" }, "trackingCategoryRefs": [], "unitAmount": 66.17, "quantity": 100, "discountAmount": 0, "discountPercentage": 0, "subTotal": 6617.17, "taxAmount": 1323.43, "taxRateRef": { "id": "3_Bills", "name": "20.0% S Bills", "effectiveTaxRate": 20 }, "totalAmount": 6617.17 } ], "totalDiscount": 0, "subTotal": 6617.17, "totalTaxAmount": 1323.43, "totalAmount": 7940.6, "modifiedDate": "2023-04-26T09:35:58Z", "sourceModifiedDate": "2016-09-13T21:18:49Z", "metadata": { "isDeleted": false } }, { "id": "27", "purchaseOrderNumber": "1003", "issueDate": "2015-12-22T00:00:00", "expectedDeliveryDate": "0001-01-01T00:00:00", "shipTo": { "address": { "type": "Unknown", "line1": "Long for Successful Events -- Sample Company", "line2": "2500 Garcia Ave", "city": "SomeCity", "postalCode": "CR2 6XH" } }, "supplierRef": { "id": "57", "supplierName": "Hall's Promo Items" }, "status": "Closed", "currency": "HKD", "currencyRate": 0.080028, "lineItems": [ { "description": "promotional items -- misc engraved items", "itemRef": { "id": "12", "name": "Misc" }, "trackingCategoryRefs": [], "unitAmount": 8.25, "quantity": 75, "discountAmount": 0, "discountPercentage": 0, "subTotal": 618.75, "taxAmount": 123.75, "taxRateRef": { "id": "3_Bills", "name": "20.0% S Bills", "effectiveTaxRate": 20 }, "totalAmount": 618.75 } ], "totalDiscount": 0, "subTotal": 618.75, "totalTaxAmount": 123.75, "totalAmount": 742.5, "modifiedDate": "2023-04-26T09:35:58Z", "sourceModifiedDate": "2016-09-12T16:48:24Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 78, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/purchaseOrders?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/purchaseOrders" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/purchaseOrders?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "1", "purchaseOrderNumber": "", "issueDate": "2021-01-05T00:00:00", "note": "", "shipTo": { "contact": { "name": "Kathy Jordan", "phone": "0191 987 3897" }, "address": { "type": "Delivery", "line1": "Sage House", "line2": "Benton Park Road", "city": "Newcastle Upon Tyne", "region": "", "postalCode": "NE7 7LZ" } }, "supplierRef": { "id": "WIS002", "supplierName": "Wiseman Paper Products" }, "status": "Closed", "currency": "GBP", "currencyRate": 617.39, "lineItems": [ { "description": "Envelope - White (110 x 220) Plain", "accountRef": { "id": "" }, "itemRef": { "id": "ENV001" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "unitAmount": 6, "quantity": 40, "discountAmount": 24, "discountPercentage": 10, "subTotal": 216, "taxAmount": 36.86, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 252.86 }, { "description": "Envelope - Brown (110 x 220) Plain", "accountRef": { "id": "" }, "itemRef": { "id": "ENV003" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "unitAmount": 6.3, "quantity": 20, "discountAmount": 12.6, "discountPercentage": 10, "subTotal": 113.4, "taxAmount": 19.35, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 132.75 }, { "description": "Flip Chart - A1 Pad", "accountRef": { "id": "" }, "itemRef": { "id": "FLIP001" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "unitAmount": 11, "quantity": 20, "discountAmount": 22, "discountPercentage": 10, "subTotal": 198, "taxAmount": 33.78, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 231.78 } ], "totalDiscount": 7694.59, "subTotal": 527.4, "totalTaxAmount": 89.99, "totalAmount": 617.39, "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } }, { "id": "2", "purchaseOrderNumber": "", "issueDate": "2021-01-15T00:00:00", "note": "", "shipTo": { "contact": { "name": "Kathy Jordan", "phone": "0191 987 3897" }, "address": { "type": "Delivery", "line1": "Sage House", "line2": "Benton Park Road", "city": "Newcastle Upon Tyne", "region": "", "postalCode": "NE7 7LZ" } }, "supplierRef": { "id": "WIS002", "supplierName": "Wiseman Paper Products" }, "status": "Closed", "currency": "GBP", "currencyRate": 1041.97, "lineItems": [ { "description": "Flip Chart - A1 Pad (Recycled)", "accountRef": { "id": "" }, "itemRef": { "id": "FLIP002" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "unitAmount": 11, "quantity": 20, "discountAmount": 22, "discountPercentage": 10, "subTotal": 198, "taxAmount": 33.78, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 231.78 }, { "description": "Laminator Pouches - A4", "accountRef": { "id": "" }, "itemRef": { "id": "LAM002" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "unitAmount": 7.5, "quantity": 10, "discountAmount": 7.5, "discountPercentage": 10, "subTotal": 67.5, "taxAmount": 11.52, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 79.02 }, { "description": "Copy Paper - Premium Grade", "accountRef": { "id": "" }, "itemRef": { "id": "PAPER003" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "unitAmount": 1.6, "quantity": 200, "discountAmount": 32, "discountPercentage": 10, "subTotal": 288, "taxAmount": 49.14, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 337.14 }, { "description": "Lasercopy Paper - Standard Grade", "accountRef": { "id": "" }, "itemRef": { "id": "PAPER005" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "unitAmount": 1.8, "quantity": 200, "discountAmount": 36, "discountPercentage": 10, "subTotal": 324, "taxAmount": 55.28, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 379.28 }, { "description": "Adhesive Tape - Brown (50mm x 66m)", "accountRef": { "id": "" }, "itemRef": { "id": "TAPE002" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "unitAmount": 1.4, "quantity": 10, "discountAmount": 1.4, "discountPercentage": 10, "subTotal": 12.6, "taxAmount": 2.15, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 14.75 } ], "totalDiscount": 7694.59, "subTotal": 890.1, "totalTaxAmount": 151.87, "totalAmount": 1041.97, "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 41, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/purchaseOrders?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/purchaseOrders" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/purchaseOrders?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "b9216028-b724-4285-977e-d9e9e7c4375e", "purchaseOrderNumber": "9dcca280-0d2d-41d3-ba41-f945156fd0f0", "issueDate": "2021-07-08T00:00:00", "paymentDueDate": "2022-01-07T00:00:00", "expectedDeliveryDate": "2021-09-27T00:00:00", "deliveryDate": "2021-09-17T00:00:00", "note": "Purchase Order with 1 line items, totaling 12068.23", "shipTo": { "contact": { "name": "Hermiston, Hilpert and Greenholt", "email": "Rafael_Corkery@hotmail.com", "phone": "023 5311 8375" }, "address": { "type": "Delivery", "line1": "Suite 293", "line2": "72376 Markus Streets", "city": "South Ludie", "region": "Scotland", "country": "United Kingdom", "postalCode": "DV3 5ZJ" } }, "supplierRef": { "id": "c39f55e4-9066-407c-8b1d-eb7c484ca5d7", "supplierName": "Hermiston, Hilpert and Greenholt" }, "status": "Draft", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 1371.39, "quantity": 8, "discountAmount": 0, "discountPercentage": 0, "subTotal": 10971.12, "taxAmount": 1097.11, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498" }, "totalAmount": 12068.23 } ], "totalDiscount": 0, "subTotal": 10971.12, "totalTaxAmount": 1097.11, "totalAmount": 12068.23, "modifiedDate": "2022-07-27T17:41:22Z", "sourceModifiedDate": "2021-09-06T19:15:22" }, { "id": "5517be12-af75-42bc-bd99-297386ab833c", "purchaseOrderNumber": "30d0abb1-dbef-452d-b6f4-6defde5fa07f", "issueDate": "2021-07-10T00:00:00", "paymentDueDate": "2022-04-11T00:00:00", "expectedDeliveryDate": "2021-09-18T00:00:00", "note": "Purchase Order with 7 line items, totaling 65825.72", "shipTo": { "contact": { "name": "Quigley-Streich", "email": "Estevan.Adams28@hotmail.com", "phone": "01608 82211" }, "address": { "type": "Delivery", "line1": "Suite 127", "line2": "981 Durgan Forge", "city": "New Mozelleshire", "region": "England", "country": "United Kingdom", "postalCode": "ND18 4YI" } }, "supplierRef": { "id": "950ca763-6a39-4295-b02a-6878bd8328f4", "supplierName": "Quigley-Streich" }, "status": "Open", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Underground - Trapped Road Gully 450mm x 450mm", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "3abf0883-03f7-44c6-bc15-1372522d25e1", "name": "Heavy Duty Hinged Gully Grating" }, "trackingCategoryRefs": [], "unitAmount": 402.89, "quantity": 3, "discountAmount": 0, "discountPercentage": 0, "subTotal": 1208.67, "taxAmount": 120.87, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498" }, "totalAmount": 1329.54 }, { "description": "Underground - Trapped Road Gully 450mm x 450mm", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "3abf0883-03f7-44c6-bc15-1372522d25e1", "name": "Heavy Duty Hinged Gully Grating" }, "trackingCategoryRefs": [], "unitAmount": 402.89, "quantity": 6, "discountAmount": 0, "discountPercentage": 0, "subTotal": 2417.34, "taxAmount": 241.73, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498" }, "totalAmount": 2659.07 }, { "description": "Underground - Trapped Road Gully 450mm x 450mm", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "3abf0883-03f7-44c6-bc15-1372522d25e1", "name": "Heavy Duty Hinged Gully Grating" }, "trackingCategoryRefs": [], "unitAmount": 402.89, "quantity": 9, "discountAmount": 0, "discountPercentage": 0, "subTotal": 3626.01, "taxAmount": 362.6, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498" }, "totalAmount": 3988.61 }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "51077072-d5c3-463b-9cb4-7da2e11886f9", "name": "150 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 1251.89, "quantity": 3, "discountAmount": 0, "discountPercentage": 0, "subTotal": 3755.67, "taxAmount": 375.57, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498" }, "totalAmount": 4131.24 }, { "description": "Underground - Drain Yard Gully", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "00491160-6ee5-4d76-9f34-998f00687481", "name": "Aluminium Silt Bucket" }, "trackingCategoryRefs": [ { "id": "costcode_A13", "name": "Constructionize" } ], "unitAmount": 171.21, "quantity": 9, "discountAmount": 0, "discountPercentage": 0, "subTotal": 1540.89, "taxAmount": 154.09, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498" }, "totalAmount": 1694.98 }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 2781.94, "quantity": 9, "discountAmount": 0, "discountPercentage": 0, "subTotal": 25037.46, "taxAmount": 2503.75, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498" }, "totalAmount": 27541.21 }, { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "22aee6bd-4767-48c4-8a13-fdf85b91fc80", "name": "600 Litre Grease Trap" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "BaseMountainConstruction" }, { "id": "department_3", "name": "MarshallBrotherContracting" } ], "unitAmount": 2781.94, "quantity": 8, "discountAmount": 0, "discountPercentage": 0, "subTotal": 22255.52, "taxAmount": 2225.55, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498" }, "totalAmount": 24481.07 } ], "totalDiscount": 0, "subTotal": 59841.56, "totalTaxAmount": 5984.16, "totalAmount": 65825.72, "modifiedDate": "2022-07-27T17:41:22Z", "sourceModifiedDate": "2021-11-04T01:38:22" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 116, "_links": { "current": { "href": "/companies/f4aae110-ca17-4cd4-8aaa-a3136b1cf0b1/data/purchaseOrders?page=1&pageSize=2" }, "self": { "href": "/companies/f4aae110-ca17-4cd4-8aaa-a3136b1cf0b1/data/purchaseOrders" }, "next": { "href": "/companies/f4aae110-ca17-4cd4-8aaa-a3136b1cf0b1/data/purchaseOrders?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "f53eedd7-402b-41d9-9f70-5e700f5b00af", "purchaseOrderNumber": "PO-0002", "issueDate": "2023-02-05T00:00:00", "expectedDeliveryDate": "2023-02-17T00:00:00", "deliveryDate": "2023-02-07T00:00:00", "note": "Urgent delivery - send directly to Doug (Club Secretary) at the Bayside Club", "shipTo": { "contact": { "name": "Club Secretary", "phone": "02-2024455" }, "address": { "type": "Delivery", "line1": "Bayside Club", "line2": "148 Bay Harbour Road", "city": "Ridge Heights", "region": "Madeupville MA12 VL9", "country": "", "postalCode": "United Kingdom" } }, "supplierRef": { "id": "4b0dd2ab-7cce-4a8a-8bdb-d49c3e2faf97", "supplierName": "Dimples Warehouse" }, "status": "Open", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Golf balls - white single", "accountRef": { "id": "127f3b99-8dc2-4b7e-854c-91ef9bd2757b", "name": "Purchases" }, "itemRef": { "id": "d5b140ac-19bd-41ce-a1f0-dbb637766725", "name": "Golf balls - white single" }, "trackingCategoryRefs": [], "unitAmount": 3.5, "quantity": 100, "discountAmount": 0, "discountPercentage": 0, "subTotal": 350, "taxAmount": 70, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "totalAmount": 420 }, { "description": "Delivery charge", "trackingCategoryRefs": [], "unitAmount": 41.67, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 41.67, "taxAmount": 8.33, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "totalAmount": 50 } ], "totalDiscount": 0, "subTotal": 391.67, "totalTaxAmount": 78.33, "totalAmount": 470, "modifiedDate": "2023-03-15T20:38:11Z", "sourceModifiedDate": "2013-11-21T18:32:06", "metadata": { "isDeleted": false } }, { "id": "5903bad1-9be5-42fe-bd1a-b7f3049d0b44", "purchaseOrderNumber": "PO-0001", "issueDate": "2023-02-07T00:00:00", "expectedDeliveryDate": "2023-02-11T00:00:00", "deliveryDate": "2023-02-11T00:00:00", "note": "Deliver to reception. As agreed, table needs to be assembled prior to delivery.", "shipTo": { "contact": { "name": "FOH", "phone": "800-124578" }, "address": { "type": "Delivery", "line1": "23 Main Street", "line2": "Central City", "city": "Marineville", "region": "MV12 3CC", "country": "", "postalCode": "" } }, "supplierRef": { "id": "699f0091-b127-4796-9f15-41a2f42abeb2", "supplierName": "ABC Furniture" }, "status": "Closed", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Coffee table for reception", "trackingCategoryRefs": [], "unitAmount": 1000, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 1000, "taxAmount": 200, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "totalAmount": 1200 } ], "totalDiscount": 0, "subTotal": 1000, "totalTaxAmount": 200, "totalAmount": 1200, "modifiedDate": "2023-03-15T20:38:11Z", "sourceModifiedDate": "2013-11-21T18:05:48", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 7, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/purchaseOrders?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/purchaseOrders" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/purchaseOrders?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "List purchase orders", "description": "The *List purchase orders* endpoint returns a list of [purchase orders](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) for a given company's connection.\n\n[Purchase orders](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) represent a business's intent to purchase goods or services from a supplier.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-purchase-orders" } }, "/companies/{companyId}/data/purchaseOrders/{purchaseOrderId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/purchaseOrderId" } ], "get": { "tags": [ "Purchase orders" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" }, "examples": { "Clear Books": { "value": { "id": "7f07b584-bebe-450f-aa9e-1d7aed630b66", "purchaseOrderNumber": "ee9b8e00-49a2-4d83-bc33-e2eee59a1c36", "issueDate": "2022-04-27T00:00:00", "paymentDueDate": "2022-09-06T00:00:00", "expectedDeliveryDate": "2022-07-21T00:00:00", "note": "Purchase Order with 2 line items, totaling 10978.05", "shipTo": { "contact": { "name": "Lakin, Schmeler and Kihn", "email": "hello@LakinSchmelerandKihn.co.uk", "phone": "016977 9004" }, "address": { "type": "Billing", "line1": "Apt. 590", "line2": "6901 Elouise Road", "city": "Brisafort", "region": "Scotland", "country": "United Kingdom", "postalCode": "SL27 7CP" } }, "supplierRef": { "id": "7GObELDcsE", "supplierName": "Lakin, Schmeler and Kihn" }, "status": "Open", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 1371.39, "quantity": 7, "discountAmount": 0, "discountPercentage": 0, "subTotal": 9599.73, "taxAmount": 959.97, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 10559.7 }, { "description": "Underground - Drain Bottle Gullies 90 degree Rectangular", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "6", "name": "Back Inlet Roddable Gully 90� Outlet Rectangular Grid" }, "trackingCategoryRefs": [], "unitAmount": 95.08, "quantity": 4, "discountAmount": 0, "discountPercentage": 0, "subTotal": 380.32, "taxAmount": 38.03, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "effectiveTaxRate": 10 }, "totalAmount": 418.35 } ], "totalDiscount": 0, "subTotal": 9980.05, "totalTaxAmount": 998, "totalAmount": 10978.05, "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2023-04-14T01:56:02", "metadata": { "isDeleted": false } } }, "Oracle NetSuite": { "value": { "id": "168487", "purchaseOrderNumber": "Purchase Order #PO885", "issueDate": "2022-07-18T00:00:00", "shipTo": { "contact": { "name": "Codat Limited : Codat Europe" }, "address": { "type": "Delivery", "country": "United Kingdom" } }, "supplierRef": { "id": "724", "supplierName": "Vendor A.A.A" }, "status": "Draft", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "844", "name": "Asset account test 2" }, "trackingCategoryRefs": [ { "id": "location-4", "name": "Europe" } ], "unitAmount": 13.23, "quantity": 1, "unitOfMeasurement": "litre", "discountAmount": 0, "discountPercentage": 0, "subTotal": 13.23, "taxAmount": 0, "totalAmount": 13.23 }, { "description": "VAT", "accountRef": { "id": "211", "name": "VAT on Purchases" }, "trackingCategoryRefs": [ { "id": "location-4", "name": "Europe" } ], "unitAmount": 0, "quantity": 0, "discountAmount": 0, "discountPercentage": 0, "subTotal": 0, "taxAmount": 0, "taxRateRef": { "id": "9", "name": "Exempt", "effectiveTaxRate": 0 }, "totalAmount": 0 } ], "totalDiscount": 0, "subTotal": 13.23, "totalTaxAmount": 0, "totalAmount": 13.23, "createdBy": { "firstName": "John", "lastName": "Smith", "email": "john.smith@codat.io" }, "modifiedDate": "2023-01-30T14:46:49Z", "sourceModifiedDate": "2022-07-18T13:50:13" } }, "QuickBooks Desktop": { "value": { "id": "69D1-1197779848", "purchaseOrderNumber": "6001", "issueDate": "2022-12-01T00:00:00", "paymentDueDate": "2023-12-16T00:00:00", "expectedDeliveryDate": "2022-12-01T00:00:00", "deliveryDate": "2022-12-01T00:00:00", "shipTo": { "contact": { "name": "Vasquez, Anabel:Basement Remodel" }, "address": { "type": "Delivery", "line1": "Anabel Vasquez", "line2": "5601 Legacy Parkway", "city": "San Mateo", "region": "CA", "postalCode": "094 02" } }, "supplierRef": { "id": "800000B4-1197779815", "supplierName": "Vu Contracting" }, "status": "Open", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Install carpeting", "itemRef": { "id": "60000-933272656", "name": "Subs:Carpet" }, "trackingCategoryRefs": [], "unitAmount": 25, "quantity": 7, "discountAmount": 0, "discountPercentage": 0, "subTotal": 175, "taxAmount": 0, "totalAmount": 175 }, { "description": "Install drywall", "itemRef": { "id": "70000-933272656", "name": "Subs:Drywall" }, "trackingCategoryRefs": [], "unitAmount": 25, "quantity": 25, "discountAmount": 0, "discountPercentage": 0, "subTotal": 625, "taxAmount": 0, "totalAmount": 625 }, { "description": "Heating & Air Conditioning Duct Work", "itemRef": { "id": "3C0000-1071513137", "name": "Subs:Duct Work" }, "trackingCategoryRefs": [], "unitAmount": 25, "quantity": 15, "discountAmount": 0, "discountPercentage": 0, "subTotal": 375, "taxAmount": 0, "totalAmount": 375 }, { "description": "Electrical work", "itemRef": { "id": "80000-933272656", "name": "Subs:Electrical" }, "trackingCategoryRefs": [], "unitAmount": 25, "quantity": 10, "discountAmount": 0, "discountPercentage": 0, "subTotal": 250, "taxAmount": 0, "totalAmount": 250 }, { "description": "Install insulation", "itemRef": { "id": "90000-933272656", "name": "Subs:Insulating" }, "trackingCategoryRefs": [], "unitAmount": 25, "quantity": 5, "discountAmount": 0, "discountPercentage": 0, "subTotal": 125, "taxAmount": 0, "totalAmount": 125 }, { "description": "Painting", "itemRef": { "id": "B0000-933272656", "name": "Subs:Painting" }, "trackingCategoryRefs": [], "unitAmount": 25, "quantity": 20, "discountAmount": 0, "discountPercentage": 0, "subTotal": 500, "taxAmount": 0, "totalAmount": 500 } ], "totalDiscount": 0, "subTotal": 2050, "totalTaxAmount": 0, "totalAmount": 2050, "modifiedDate": "2023-04-26T09:13:03Z", "sourceModifiedDate": "2023-12-16T05:06:12", "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "3900", "purchaseOrderNumber": "1001", "issueDate": "2020-12-02T00:00:00", "expectedDeliveryDate": "0001-01-01T00:00:00", "shipTo": { "address": { "type": "Unknown", "line1": "Widgets Limited (Production)", "line2": "17 Minstrel Court, Teesdale Close", "city": "LONDON", "country": "LO", "postalCode": "E2 6PQ" } }, "supplierRef": { "id": "6", "supplierName": "Jane Doe" }, "status": "Open", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "expense", "itemRef": { "id": "31", "name": "Consulting Services" }, "trackingCategoryRefs": [], "unitAmount": 100, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 100, "taxAmount": 0, "taxRateRef": { "id": "33_Bills", "name": "TaxTest1 Bills", "effectiveTaxRate": 10 }, "totalAmount": 100 } ], "totalDiscount": 0, "subTotal": 100, "totalTaxAmount": 10, "totalAmount": 110, "modifiedDate": "2023-01-18T11:02:40Z", "sourceModifiedDate": "2020-12-02T12:51:49Z" } }, "QuickBooks Online Sandbox": { "value": { "id": "17", "purchaseOrderNumber": "1002", "issueDate": "2015-12-22T00:00:00", "expectedDeliveryDate": "0001-01-01T00:00:00", "shipTo": { "address": { "type": "Unknown", "line1": "Long for Successful Events -- Sample Company", "line2": "2500 Garcia Ave", "city": "SomeCity", "postalCode": "CR2 6XH" } }, "supplierRef": { "id": "57", "supplierName": "Hall's Promo Items" }, "status": "Closed", "currency": "HKD", "currencyRate": 0.080028, "lineItems": [ { "description": "Water bottles -- generic", "itemRef": { "id": "19", "name": "Water Bottles" }, "trackingCategoryRefs": [], "unitAmount": 66.17, "quantity": 100, "discountAmount": 0, "discountPercentage": 0, "subTotal": 6617.17, "taxAmount": 1323.43, "taxRateRef": { "id": "3_Bills", "name": "20.0% S Bills", "effectiveTaxRate": 20 }, "totalAmount": 6617.17 } ], "totalDiscount": 0, "subTotal": 6617.17, "totalTaxAmount": 1323.43, "totalAmount": 7940.6, "modifiedDate": "2023-04-26T09:35:58Z", "sourceModifiedDate": "2016-09-13T21:18:49Z", "metadata": { "isDeleted": false } } }, "Sage 50 (UK)": { "value": { "id": "1", "purchaseOrderNumber": "", "issueDate": "2021-01-05T00:00:00", "note": "", "shipTo": { "contact": { "name": "Kathy Jordan", "phone": "0191 987 3897" }, "address": { "type": "Delivery", "line1": "Sage House", "line2": "Benton Park Road", "city": "Newcastle Upon Tyne", "region": "", "postalCode": "NE7 7LZ" } }, "supplierRef": { "id": "WIS002", "supplierName": "Wiseman Paper Products" }, "status": "Closed", "currency": "GBP", "currencyRate": 617.39, "lineItems": [ { "description": "Envelope - White (110 x 220) Plain", "accountRef": { "id": "" }, "itemRef": { "id": "ENV001" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "unitAmount": 6, "quantity": 40, "discountAmount": 24, "discountPercentage": 10, "subTotal": 216, "taxAmount": 36.86, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 252.86 }, { "description": "Envelope - Brown (110 x 220) Plain", "accountRef": { "id": "" }, "itemRef": { "id": "ENV003" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "unitAmount": 6.3, "quantity": 20, "discountAmount": 12.6, "discountPercentage": 10, "subTotal": 113.4, "taxAmount": 19.35, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 132.75 }, { "description": "Flip Chart - A1 Pad", "accountRef": { "id": "" }, "itemRef": { "id": "FLIP001" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "Sales" } ], "unitAmount": 11, "quantity": 20, "discountAmount": 22, "discountPercentage": 10, "subTotal": 198, "taxAmount": 33.78, "taxRateRef": { "id": "1", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 231.78 } ], "totalDiscount": 7694.59, "subTotal": 527.4, "totalTaxAmount": 89.99, "totalAmount": 617.39, "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "metadata": { "isDeleted": false } } }, "Sage Business Cloud Accounting": { "value": { "id": "b9216028-b724-4285-977e-d9e9e7c4375e", "purchaseOrderNumber": "9dcca280-0d2d-41d3-ba41-f945156fd0f0", "issueDate": "2021-07-08T00:00:00", "paymentDueDate": "2022-01-07T00:00:00", "expectedDeliveryDate": "2021-09-27T00:00:00", "deliveryDate": "2021-09-17T00:00:00", "note": "Purchase Order with 1 line items, totaling 12068.23", "shipTo": { "contact": { "name": "Hermiston, Hilpert and Greenholt", "email": "Rafael_Corkery@hotmail.com", "phone": "023 5311 8375" }, "address": { "type": "Delivery", "line1": "Suite 293", "line2": "72376 Markus Streets", "city": "South Ludie", "region": "Scotland", "country": "United Kingdom", "postalCode": "DV3 5ZJ" } }, "supplierRef": { "id": "c39f55e4-9066-407c-8b1d-eb7c484ca5d7", "supplierName": "Hermiston, Hilpert and Greenholt" }, "status": "Draft", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Grease Trap", "accountRef": { "id": "72df89d2-512b-4455-af51-a6b563733842", "name": "Sales" }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "300 Litre Grease Trap" }, "trackingCategoryRefs": [], "unitAmount": 1371.39, "quantity": 8, "discountAmount": 0, "discountPercentage": 0, "subTotal": 10971.12, "taxAmount": 1097.11, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498" }, "totalAmount": 12068.23 } ], "totalDiscount": 0, "subTotal": 10971.12, "totalTaxAmount": 1097.11, "totalAmount": 12068.23, "modifiedDate": "2022-07-27T17:41:22Z", "sourceModifiedDate": "2021-09-06T19:15:22" } }, "Xero": { "value": { "id": "f53eedd7-402b-41d9-9f70-5e700f5b00af", "purchaseOrderNumber": "PO-0002", "issueDate": "2023-02-05T00:00:00", "expectedDeliveryDate": "2023-02-17T00:00:00", "deliveryDate": "2023-02-07T00:00:00", "note": "Urgent delivery - send directly to Doug (Club Secretary) at the Bayside Club", "shipTo": { "contact": { "name": "Club Secretary", "phone": "02-2024455" }, "address": { "type": "Delivery", "line1": "Bayside Club", "line2": "148 Bay Harbour Road", "city": "Ridge Heights", "region": "Madeupville MA12 VL9", "country": "", "postalCode": "United Kingdom" } }, "supplierRef": { "id": "4b0dd2ab-7cce-4a8a-8bdb-d49c3e2faf97", "supplierName": "Dimples Warehouse" }, "status": "Open", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Golf balls - white single", "accountRef": { "id": "127f3b99-8dc2-4b7e-854c-91ef9bd2757b", "name": "Purchases" }, "itemRef": { "id": "d5b140ac-19bd-41ce-a1f0-dbb637766725", "name": "Golf balls - white single" }, "trackingCategoryRefs": [], "unitAmount": 3.5, "quantity": 100, "discountAmount": 0, "discountPercentage": 0, "subTotal": 350, "taxAmount": 70, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "totalAmount": 420 }, { "description": "Delivery charge", "trackingCategoryRefs": [], "unitAmount": 41.67, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 41.67, "taxAmount": 8.33, "taxRateRef": { "id": "INPUT2", "name": "20% (VAT on Expenses)", "effectiveTaxRate": 20 }, "totalAmount": 50 } ], "totalDiscount": 0, "subTotal": 391.67, "totalTaxAmount": 78.33, "totalAmount": 470, "modifiedDate": "2023-03-15T20:38:11Z", "sourceModifiedDate": "2013-11-21T18:32:06", "metadata": { "isDeleted": false } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get purchase order", "description": "The *Get purchase order* endpoint returns a single purchase order for a given purchaseOrderId.\n\n[Purchase orders](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) represent a business's intent to purchase goods or services from a supplier.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=purchaseOrders) for integrations that support getting a specific purchase order.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-purchase-order" } }, "/companies/{companyId}/connections/{connectionId}/options/purchaseOrders": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create/update purchase order model", "tags": [ "Purchase orders" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Oracle NetSuite": { "value": { "type": "Object", "displayName": "Purchase Order", "description": "A purchase order is an official document issued by a buyer to their supplier. It details the types, quantities, and agreed prices of the goods the buyer wishes to purchase", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Supplier that the purchase order is recorded against in the accounting system", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "Date of the purchase order as recorded in the accounting software", "required": true }, "expectedDeliveryDate": { "type": "DateTime", "displayName": "Expected Delivery Date", "description": "Expected delivery date for any goods that have been ordered", "required": false }, "note": { "type": "String", "displayName": "Note", "description": "Any additional information associated with the payment", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the purchase order", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Rate", "description": "Rate for converting the total amount of the purchase order into the base currency for the company", "required": true }, "status": { "type": "String", "displayName": "Status", "description": "Current state of the purchase order", "options": [ { "value": "Open", "type": "String", "displayName": "Open", "required": false } ], "required": true }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "Collection of items that relate to the purchase order", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name for the goods that have been ordered", "required": false }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "Price of each unit of the goods", "required": false }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "Number of units of the goods that have been ordered", "required": false }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.AccountRef", "details": "Should not be a bank account" }, { "field": "LineItems.AccountRef", "details": "Should only be specified when pushing an expense" } ], "information": [] } }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or inventory item to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.ItemRef", "details": "Should only be specified when pushing an item (not an expense)" } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.TaxRateRef", "details": "Should be specified when item type is not 'Discount'" } ], "information": [] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "Reference to the tracking categories to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true } }, "required": false } }, "required": true } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Purchase Order", "description": "A purchase order is an official document issued by a buyer to their supplier. It details the types, quantities, and agreed prices of the goods the buyer wishes to purchase", "properties": { "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Supplier that the purchase order is recorded against in the accounting system", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must match the ID of an existing supplier." } ], "information": [] } } }, "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "Date of the purchase order as recorded in the accounting software", "required": true }, "expectedDeliveryDate": { "type": "DateTime", "displayName": "Expected Delivery Date", "description": "Expected delivery date for any goods that have been ordered", "required": false }, "paymentDueDate": { "type": "DateTime", "displayName": "Payment Due Date", "description": "Date the supplier is due to be paid", "required": false }, "purchaseOrderNumber": { "type": "String", "displayName": "Purchase Order Number", "description": "Friendly reference for the purchase order, commonly generated by the accounting software", "required": false, "validation": { "warnings": [ { "field": "PurchaseOrderNumber", "details": "Max length of 11 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the purchase order", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "Must be a three letter ISO code that matches the currency of the customer" }, { "field": "Currency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "Currency", "details": "If not set, will default to the default currency of the customer" } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Rate", "description": "Rate for converting the total amount of the purchase order into the base currency for the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1." }, { "field": "CurrencyRate", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional information associated with the payment", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Max length of 4000 characters." } ], "information": [] } }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "Total amount of the purchase order, including discounts and tax", "required": true, "validation": { "warnings": [ { "field": "TotalAmount", "details": "Must match the total amount in the line items." } ], "information": [] } }, "status": { "type": "String", "displayName": "Status", "description": "Current state of the purchase order", "options": [ { "value": "Open", "type": "String", "displayName": "Open", "required": false } ], "required": true }, "shipTo": { "type": "Object", "displayName": "Ship To", "description": "Delivery details for any goods that have been ordered", "properties": { "address": { "type": "Object", "displayName": "Address", "description": "Delivery address for any goods that have been ordered", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [ { "field": "Address.Line1", "details": "Max length of 41 characters." } ], "information": [] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false, "validation": { "warnings": [ { "field": "Address.Line2", "details": "Max length of 41 characters." } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [ { "field": "Address.City", "details": "Max length of 31 characters." } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [ { "field": "Address.Region", "details": "Max length of 21 characters." } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Address.Country", "details": "Max length of 31 characters." } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [ { "field": "Address.PostalCode", "details": "Max length of 13 characters." } ], "information": [] } }, "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "options": [ { "value": "Delivery", "type": "String", "displayName": "Delivery Address", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Address.Type", "details": "Only 1 address each of type(s) Delivery may be specified." } ] } } }, "required": false } }, "required": false }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "Collection of items that relate to the purchase order", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name for the goods that have been ordered", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Max length of 4000 characters." } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "Price of each unit of the goods", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "Number of units of the goods that have been ordered", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or inventory item to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true, "validation": { "warnings": [ { "field": "ItemRef.ItemRef", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Only valid for UK or CA versions of QuickBooks Desktop with VAT enabled, will be ignored in US version" }, { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax rate" } ], "information": [] } } }, "required": false }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "Reference to the tracking categories to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.Id", "details": "Must match the ID of an existing tracking category." } ], "information": [] } } }, "required": false } }, "required": true } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Purchase Order", "description": "A purchase order is an official document issued by a buyer to their supplier. It details the types, quantities, and agreed prices of the goods the buyer wishes to purchase", "properties": { "purchaseOrderNumber": { "type": "String", "displayName": "Purchase Order Number", "description": "Friendly reference for the purchase order, commonly generated by the accounting software", "required": false }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Supplier that the purchase order is recorded against in the accounting system", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "shipTo": { "type": "Object", "displayName": "Ship To", "description": "Delivery details for any goods that have been ordered", "required": false }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "Date of the purchase order as recorded in the accounting software", "required": false, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "If the issue date is not supplied, the current date on the server is used" } ] } }, "expectedDeliveryDate": { "type": "DateTime", "displayName": "Expected Delivery Date", "description": "Expected delivery date for any goods that have been ordered", "required": false }, "deliveryDate": { "type": "DateTime", "displayName": "Delivery Date", "description": "Actual delivery date for any goods that have been ordered", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the purchase order", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Required if multi-currency is enabled for the company." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Rate", "description": "Rate for converting the total amount of the purchase order into the base currency for the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "Required if Currency is not the base currency." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional information associated with the payment", "required": false }, "status": { "type": "String", "displayName": "Status", "description": "Current state of the purchase order", "options": [ { "value": "Open", "type": "String", "displayName": "Open", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "QuickBooks Online only supports \"Open\" as a status for new purchase orders." } ] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "Collection of items that relate to the purchase order", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name for the goods that have been ordered", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Should not be longer than 4000 characters." } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "Price of each unit of the goods", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "Number of units of the goods that have been ordered", "required": true }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "Value of any discounts applied", "required": true }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "Percentage rate (from 0 to 100) of any discounts applied to the unit amount", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total", "description": "Amount of the line, inclusive of discounts but exclusive of tax", "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax code." } ], "information": [] } } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": false, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Required if the expense line is account based. If AccountRef is specified, ItemRef must be null." } ] } } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or inventory item to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [ { "field": "ItemRef.Id", "details": "Required if the expense line is item based. If ItemRef is specified, AccountRef must be null." } ] } } }, "required": true } }, "required": true } }, "required": true } }, "QuickBooks Online": { "value": { "type": "Object", "displayName": "Purchase Order", "description": "A purchase order is an official document issued by a buyer to their supplier. It details the types, quantities, and agreed prices of the goods the buyer wishes to purchase", "properties": { "purchaseOrderNumber": { "type": "String", "displayName": "Purchase Order Number", "description": "Friendly reference for the purchase order, commonly generated by the accounting software", "required": false }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Supplier that the purchase order is recorded against in the accounting system", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true } }, "required": true }, "shipTo": { "type": "Object", "displayName": "Ship To", "description": "Delivery details for any goods that have been ordered", "required": false }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "Date of the purchase order as recorded in the accounting software", "required": false, "validation": { "warnings": [], "information": [ { "field": "IssueDate", "details": "If the issue date is not supplied, the current date on the server is used" } ] } }, "expectedDeliveryDate": { "type": "DateTime", "displayName": "Expected Delivery Date", "description": "Expected delivery date for any goods that have been ordered", "required": false }, "deliveryDate": { "type": "DateTime", "displayName": "Delivery Date", "description": "Actual delivery date for any goods that have been ordered", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the purchase order", "required": false, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Required if multi-currency is enabled for the company." } ] } }, "currencyRate": { "type": "Number", "displayName": "Currency Rate", "description": "Rate for converting the total amount of the purchase order into the base currency for the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "Required if Currency is not the base currency." } ] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional information associated with the payment", "required": false }, "status": { "type": "String", "displayName": "Status", "description": "Current state of the purchase order", "options": [ { "value": "Open", "type": "String", "displayName": "Open", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "QuickBooks Online only supports \"Open\" as a status for new purchase orders." } ] } }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "Collection of items that relate to the purchase order", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name for the goods that have been ordered", "required": false, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Should not be longer than 4000 characters." } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "Price of each unit of the goods", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "Number of units of the goods that have been ordered", "required": true }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "Value of any discounts applied", "required": true }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "Percentage rate (from 0 to 100) of any discounts applied to the unit amount", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total", "description": "Amount of the line, inclusive of discounts but exclusive of tax", "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax code." } ], "information": [] } } }, "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": false, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." } ], "information": [ { "field": "AccountRef.Id", "details": "Required if the expense line is account based. If AccountRef is specified, ItemRef must be null." } ] } } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or inventory item to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [ { "field": "ItemRef.Id", "details": "Required if the expense line is item based. If ItemRef is specified, AccountRef must be null." } ] } } }, "required": true } }, "required": true } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Purchase Order", "description": "A purchase order is an official document issued by a buyer to their supplier. It details the types, quantities, and agreed prices of the goods the buyer wishes to purchase", "properties": { "purchaseOrderNumber": { "type": "String", "displayName": "Purchase Order Number", "description": "Friendly reference for the purchase order, commonly generated by the accounting software", "required": true }, "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "Date of the purchase order as recorded in the accounting software", "required": true }, "paymentDueDate": { "type": "DateTime", "displayName": "Payment Due Date", "description": "Date the supplier is due to be paid", "required": true }, "expectedDeliveryDate": { "type": "DateTime", "displayName": "Expected Delivery Date", "description": "Expected delivery date for any goods that have been ordered", "required": true }, "deliveryDate": { "type": "DateTime", "displayName": "Delivery Date", "description": "Actual delivery date for any goods that have been ordered", "required": true }, "note": { "type": "String", "displayName": "Note", "description": "Any additional information associated with the payment", "required": true }, "shipTo": { "type": "Object", "displayName": "Ship To", "description": "Delivery details for any goods that have been ordered", "properties": { "contact": { "type": "Object", "displayName": "Contact", "description": "Details of the named contact at the delivery address", "properties": { "name": { "type": "String", "displayName": "Name", "description": "Name of the contact at the delivery address", "required": true }, "email": { "type": "String", "displayName": "Email", "description": "Email address of the contact at the delivery address", "required": true }, "phone": { "type": "String", "displayName": "Phone", "description": "Phone number of the contact at the delivery address", "required": true } }, "required": true }, "address": { "type": "Object", "displayName": "Address", "description": "Delivery address for any goods that have been ordered", "properties": { "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "required": true }, "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": true }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": true }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": true }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": true }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": true }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": true } }, "required": true } }, "required": true }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Supplier that the purchase order is recorded against in the accounting system", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true }, "supplierName": { "type": "String", "displayName": "Name", "description": "The name of the supplier referenced by the identifier", "required": true } }, "required": true }, "status": { "type": "String", "displayName": "Status", "description": "Current state of the purchase order", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the purchase order", "required": true }, "currencyRate": { "type": "Number", "displayName": "Currency Rate", "description": "Rate for converting the total amount of the purchase order into the base currency for the company", "required": true }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "Collection of items that relate to the purchase order", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name for the goods that have been ordered", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "Name of the account", "required": true } }, "required": true }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or inventory item to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the item referenced by the identifier", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "Reference to the tracking categories to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": true } }, "required": true }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "Price of each unit of the goods", "required": true }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "Number of units of the goods that have been ordered", "required": true }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "Value of any discounts applied", "required": true }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "Percentage rate (from 0 to 100) of any discounts applied to the unit amount", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total", "description": "Amount of the line, inclusive of discounts but exclusive of tax", "required": true }, "taxAmount": { "type": "Number", "displayName": "Tax Amount", "description": "Amount of tax for the line", "required": true }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": true }, "name": { "type": "String", "displayName": "Name", "description": "The name of the tax rate referenced by the identifier", "required": true }, "effectiveTaxRate": { "type": "Number", "displayName": "Effective Tax Rate", "description": "The total applied tax percentage, including compounding details", "required": true } }, "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "The total amount of the line, inclusive of discounts and tax", "required": true } }, "required": true }, "totalDiscount": { "type": "Number", "displayName": "Total Discount", "description": "Total value of any discounts applied to the purchase order", "required": true }, "subTotal": { "type": "Number", "displayName": "Sub Total", "description": "Total amount of the purchase order, including discounts but excluding tax", "required": true }, "totalTaxAmount": { "type": "Number", "displayName": "Total Tax Amount", "description": "Total amount of tax included in the purchase order", "required": true }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "Total amount of the purchase order, including discounts and tax", "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Purchase Order", "description": "A purchase order is an official document issued by a buyer to their supplier. It details the types, quantities, and agreed prices of the goods the buyer wishes to purchase", "properties": { "issueDate": { "type": "DateTime", "displayName": "Issue Date", "description": "Date of the purchase order as recorded in the accounting software", "required": false }, "deliveryDate": { "type": "DateTime", "displayName": "Delivery Date", "description": "Actual delivery date for any goods that have been ordered", "required": false }, "totalAmount": { "type": "Number", "displayName": "Total Amount", "description": "Total amount of the purchase order, including discounts and tax", "required": false }, "expectedDeliveryDate": { "type": "DateTime", "displayName": "Expected Delivery Date", "description": "Expected delivery date for any goods that have been ordered", "required": false, "validation": { "warnings": [ { "field": "ExpectedDeliveryDate", "details": "Can only be provided for Purchase Orders with an Open status." } ], "information": [] } }, "supplierRef": { "type": "Object", "displayName": "Supplier Reference", "description": "Supplier that the purchase order is recorded against in the accounting system", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the supplier", "required": true, "validation": { "warnings": [ { "field": "SupplierRef.Id", "details": "Must be a valid GUID." }, { "field": "SupplierRef.Id", "details": "Must match the ID of an existing Supplier." }, { "field": "SupplierRef.Id", "details": "Must be provided." } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "SupplierRef", "details": "Must be provided." } ], "information": [] } }, "status": { "type": "String", "displayName": "Status", "description": "Current state of the purchase order", "options": [ { "value": "Draft", "type": "String", "displayName": "Draft", "required": false }, { "value": "Open", "type": "String", "displayName": "Open", "required": false }, { "value": "Closed", "type": "String", "displayName": "Closed", "required": false } ], "required": true, "validation": { "warnings": [ { "field": "Status", "details": "ExpectedDeliveryDate can only be provided for Purchase Orders with an Open status." }, { "field": "Status", "details": "Must be provided." } ], "information": [] } }, "purchaseOrderNumber": { "type": "String", "displayName": "Purchase Order Number", "description": "Friendly reference for the purchase order, commonly generated by the accounting software", "required": false, "validation": { "warnings": [ { "field": "PurchaseOrderNumber", "details": "Must be unique." } ], "information": [] } }, "note": { "type": "String", "displayName": "Note", "description": "Any additional information associated with the payment", "required": false, "validation": { "warnings": [ { "field": "Note", "details": "Must not exceed 500 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the purchase order", "required": false }, "currencyRate": { "type": "Number", "displayName": "Currency Rate", "description": "Rate for converting the total amount of the purchase order into the base currency for the company", "required": false, "validation": { "warnings": [], "information": [ { "field": "CurrencyRate", "details": "If no rate is specified, the Xero day rate will be applied.", "ref": "https://central.xero.com/s/#CurrencySettings$Rates" } ] } }, "totalDiscount": { "type": "Number", "displayName": "Total Discount", "description": "Total value of any discounts applied to the purchase order", "required": false }, "subTotal": { "type": "Number", "displayName": "Sub Total", "description": "Total amount of the purchase order, including discounts but excluding tax", "required": false }, "shipTo": { "type": "Object", "displayName": "Ship To", "description": "Delivery details for any goods that have been ordered", "properties": { "address": { "type": "Object", "displayName": "Address", "description": "Delivery address for any goods that have been ordered", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false } }, "required": false }, "contact": { "type": "Object", "displayName": "Contact", "description": "Details of the named contact at the delivery address", "properties": { "name": { "type": "String", "displayName": "Name", "description": "Name of the contact at the delivery address", "required": false }, "phone": { "type": "String", "displayName": "Phone", "description": "Phone number of the contact at the delivery address", "required": false } }, "required": false } }, "required": false }, "lineItems": { "type": "Array", "displayName": "Line Items", "description": "Collection of items that relate to the purchase order", "properties": { "description": { "type": "String", "displayName": "Description", "description": "Friendly name for the goods that have been ordered", "required": true, "validation": { "warnings": [ { "field": "LineItems.Description", "details": "Must not exceed 4000 characters." } ], "information": [] } }, "quantity": { "type": "Number", "displayName": "Quantity", "description": "Number of units of the goods that have been ordered", "required": true, "validation": { "warnings": [ { "field": "LineItems.Quantity", "details": "Must not be negative" } ], "information": [] } }, "unitAmount": { "type": "Number", "displayName": "Unit Amount", "description": "Price of each unit of the goods", "required": true }, "discountAmount": { "type": "Number", "displayName": "Discount Amount", "description": "Value of any discounts applied", "required": false, "validation": { "warnings": [ { "field": "LineItems.DiscountAmount", "details": "Must match DiscountPercentage if supplied" } ], "information": [] } }, "discountPercentage": { "type": "Number", "displayName": "Discount Percentage", "description": "Percentage rate (from 0 to 100) of any discounts applied to the unit amount", "required": false, "validation": { "warnings": [ { "field": "LineItems.DiscountPercentage", "details": "Must match DiscountAmount if supplied" } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the account to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Account ID", "description": "The identifier for the account", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must be a valid GUID." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing account." }, { "field": "AccountRef.Id", "details": "Must be provided." } ], "information": [] } } }, "required": true, "validation": { "warnings": [ { "field": "LineItems.AccountRef", "details": "Must be provided." } ], "information": [] } }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "Reference to the tracking categories to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.Id", "details": "Must be provided." } ], "information": [] } } }, "required": false, "validation": { "warnings": [ { "field": "LineItems.TrackingCategoryRefs", "details": "Tracking categories must not have the same parent tracking category." }, { "field": "LineItems.TrackingCategoryRefs", "details": "Maximum of 2 Tracking Categories." } ], "information": [] } }, "taxRateRef": { "type": "Object", "displayName": "Tax Rate Reference", "description": "Reference to the tax rate to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the tax rate", "required": false, "validation": { "warnings": [ { "field": "TaxRateRef.Id", "details": "Must match the ID of an existing tax rate." } ], "information": [] } } }, "required": false }, "itemRef": { "type": "Object", "displayName": "Item Reference", "description": "Reference to the product or inventory item to which the line item is linked", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the item", "required": false, "validation": { "warnings": [ { "field": "ItemRef.Id", "details": "Must be a valid GUID." }, { "field": "ItemRef.Id", "details": "Must match the ID of an existing item." } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [ { "field": "LineItems", "details": "Must be provided and must not be empty" } ], "information": [] } } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-update-purchaseOrders-model", "description": "The *Get create/update purchase order model* endpoint returns the expected data for the request payload when creating and updating a [purchase order](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) for a given company and integration.\n\n[Purchase orders](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) represent a business's intent to purchase goods or services from a supplier.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=purchaseOrders) for integrations that support creating and updating a purchase order.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/purchaseOrders": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Purchase orders" ], "summary": "Create purchase order", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create purchase order* endpoint creates a new [purchase order](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) for a given company's connection.\n\n[Purchase orders](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) represent a business's intent to purchase goods or services from a supplier.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update purchase order model](https://docs.codat.io/accounting-api#/operations/get-create-update-purchaseOrders-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=purchaseOrders) for integrations that support creating an account.\n", "operationId": "create-purchase-order" } }, "/companies/{companyId}/connections/{connectionId}/push/purchaseOrders/{purchaseOrderId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/purchaseOrderId" } ], "put": { "tags": [ "Purchase orders" ], "summary": "Update purchase order", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/forceUpdate" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePurchaseOrderResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Update purchase order* endpoint updates an existing [purchase order](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) for a given company's connection.\n\n[Purchase orders](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) represent a business's intent to purchase goods or services from a supplier.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update purchase order model](https://docs.codat.io/accounting-api#/operations/get-create-update-purchaseOrders-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=purchaseOrders) for integrations that support creating an account.\n", "operationId": "update-purchase-order" } }, "/companies/{companyId}/data/purchaseOrders/{purchaseOrderId}/pdf": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Purchase orders" ], "parameters": [ { "$ref": "#/components/parameters/purchaseOrderId" } ], "responses": { "200": { "description": "Success", "content": { "application/pdf": { "schema": { "title": "Data", "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Download purchase order as PDF", "description": "The *Download purchase order as PDF* endpoint downloads the purchase order as a PDF for a given `purchaseOrderId`.\n\n[Purchase Orders](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) represent a business's intent to purchase goods or services from a supplier.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=purchaseOrders) for integrations that support getting a purchase order as PDF.", "operationId": "download-purchase-order-pdf" } }, "/companies/{companyId}/connections/{connectionId}/data/purchaseOrders/{purchaseOrderId}/attachments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "tags": [ "Purchase orders" ], "parameters": [ { "$ref": "#/components/parameters/purchaseOrderId" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentsDataset" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "List purchase order attachments", "description": "The *List purchase order attachments* endpoint returns a list of attachments available to download for a given `purchaseOrderId`.\n\n[Purchase Orders](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) represent a business's intent to purchase goods or services from a supplier.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=purchaseOrders) for integrations that support listing purchase order attachments.\n", "operationId": "list-purchase-order-attachments" } }, "/companies/{companyId}/connections/{connectionId}/data/purchaseOrders/{purchaseOrderId}/attachments/{attachmentId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "tags": [ "Purchase orders" ], "parameters": [ { "$ref": "#/components/parameters/purchaseOrderId" }, { "$ref": "#/components/parameters/attachmentId" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get purchase order attachment", "description": "The *Get purchase order attachment* endpoint returns a specific attachment for a given `purchaseOrderId` and `attachmentId`.\n\n[Purchase Orders](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) represent a business's intent to purchase goods or services from a supplier.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=purchaseOrders) for integrations that support getting a purchase order attachment.\n", "operationId": "get-purchase-order-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/purchaseOrders/{purchaseOrderId}/attachments/{attachmentId}/download": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "tags": [ "Purchase orders" ], "parameters": [ { "$ref": "#/components/parameters/purchaseOrderId" }, { "$ref": "#/components/parameters/attachmentId" } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "title": "Data", "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Download purchase order attachment", "description": "The *Download purchase order attachment* endpoint downloads a specific attachment for a given `purchaseOrderId` and `attachmentId`.\n\n[Purchase Orders](https://docs.codat.io/accounting-api#/schemas/PurchaseOrder) represent a business's intent to purchase goods or services from a supplier.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=purchaseOrders) for integrations that support downloading a purchase order attachment.\n", "operationId": "download-purchase-order-attachment" } }, "/companies/{companyId}/data/salesOrders": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Sales orders" ], "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrders" }, "examples": { "Oracle NetSuite": { "value": { "results": [ { "id": "183518", "salesOrderNumber": "Sales Order #SO24", "issueDate": "2022-07-27T00:00:00", "expectedDeliveryDate": "2022-07-27T00:00:00", "customerRef": { "id": "172722", "companyName": "1248 European Company" }, "status": "Open", "invoicingStatus": "NotInvoiced", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "190", "name": "New Item" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" } ] }, "unitAmount": 1, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 1, "taxAmount": 0, "totalAmount": 1 }, { "description": "VAT", "accountRef": { "id": "210", "name": "VAT on Sales" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" } ] }, "unitAmount": 0, "quantity": 0, "discountAmount": 0, "discountPercentage": 0, "subTotal": 0, "taxAmount": 0.2, "taxRateRef": { "id": "6", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 0.2 } ], "totalDiscount": 0, "subTotal": 1, "totalTaxAmount": 0.2, "totalAmount": 1.2, "modifiedDate": "2023-01-30T14:47:08Z", "sourceModifiedDate": "2022-07-27T14:30:01", "metadata": {} } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/salesOrders?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/salesOrders" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "List sales orders", "description": "The *List sales orders* endpoint returns a list of [sales orders](https://docs.codat.io/accounting-api#/schemas/SalesOrder) for a given company's connection.\n\n[Sales orders](https://docs.codat.io/accounting-api#/schemas/SalesOrder) represent a customer's intention to purchase goods or services from the SMB.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-sales-orders" } }, "/companies/{companyId}/data/salesOrders/{salesOrderId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/salesOrderId" } ], "get": { "tags": [ "Sales orders" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrder" }, "examples": { "Oracle NetSuite": { "value": { "id": "183518", "salesOrderNumber": "Sales Order #SO24", "issueDate": "2022-07-27T00:00:00", "expectedDeliveryDate": "2022-07-27T00:00:00", "customerRef": { "id": "172722", "companyName": "1248 European Company" }, "status": "Open", "invoicingStatus": "NotInvoiced", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "accountRef": { "id": "54", "name": "Sales" }, "itemRef": { "id": "190", "name": "New Item" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" } ] }, "unitAmount": 1, "quantity": 1, "discountAmount": 0, "discountPercentage": 0, "subTotal": 1, "taxAmount": 0, "totalAmount": 1 }, { "description": "VAT", "accountRef": { "id": "210", "name": "VAT on Sales" }, "tracking": { "recordRefs": [ { "id": "location-4", "dataType": "trackingCategories" } ] }, "unitAmount": 0, "quantity": 0, "discountAmount": 0, "discountPercentage": 0, "subTotal": 0, "taxAmount": 0.2, "taxRateRef": { "id": "6", "name": "Standard rate", "effectiveTaxRate": 20 }, "totalAmount": 0.2 } ], "totalDiscount": 0, "subTotal": 1, "totalTaxAmount": 0.2, "totalAmount": 1.2, "modifiedDate": "2023-01-30T14:47:08Z", "sourceModifiedDate": "2022-07-27T14:30:01", "metadata": {} } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get sales order", "description": "The *Get sales order* endpoint returns a single sales order for a given salesOrderId.\n\n[Sales orders](https://docs.codat.io/accounting-api#/schemas/SalesOrder) represent a customer's intention to purchase goods or services from the SMB.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=salesOrders) for integrations that support getting a specific sales order.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-sales-order" } }, "/companies/{companyId}/data/suppliers": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Suppliers" ], "summary": "List suppliers", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Suppliers" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "owQ2Gqgj9f", "supplierName": "Abshire - Kshlerin", "contactName": "Faye Hansen", "emailAddress": "hello@Abshire-Kshlerin.info", "phone": "01338 858162", "addresses": [ { "type": "Delivery", "line1": "Suite 431", "line2": "289 Giles Lake", "city": "Cesarmouth", "region": "Northern Ireland", "country": "United Kingdom", "postalCode": "BG40 9GP" } ], "registrationNumber": "VYL1XZXR", "taxNumber": "1396267523.0914588", "status": "Active", "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "1660-11-28T23:18:00", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } }, { "id": "FyUkHbZxhn", "supplierName": "Arjun Kuvalis", "contactName": "Werner Langworth", "emailAddress": "Arjun34@hotmail.com", "phone": "0116 796 3163", "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" } ], "registrationNumber": "NI7JEJVM", "taxNumber": "7505220209.583549", "status": "Active", "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "0177-04-27T11:56:00", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 100, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "78623f13-931e-eb11-bbf8-0022481b3585", "supplierName": "", "contactName": "", "emailAddress": "", "phone": "", "addresses": [ { "type": "Billing", "line1": "", "line2": "", "city": "", "region": "", "country": "GB", "postalCode": "" } ], "taxNumber": "", "status": "Active", "modifiedDate": "2023-03-27T14:21:12Z", "sourceModifiedDate": "2020-11-04T11:44:22Z", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } }, { "id": "be49ec62-6754-ed11-946f-0022481b67d1", "supplierName": "", "contactName": "", "emailAddress": "", "phone": "", "addresses": [ { "type": "Billing", "line1": "", "line2": "", "city": "", "region": "", "country": "GB", "postalCode": "" } ], "taxNumber": "", "status": "Active", "modifiedDate": "2023-03-27T14:21:12Z", "sourceModifiedDate": "2022-10-25T13:17:36Z", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 31, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "3150917c-1d92-4d77-9018-31b5c4758ca9", "supplierName": "Abe", "contactName": "Kelly's Contact Name", "emailAddress": "sales@kellysupplies.com", "phone": "07999 999999", "addresses": [ { "type": "Billing", "line1": "Unit 51", "city": "Bakersfield", "region": "California", "country": "US", "postalCode": "933081" } ], "registrationNumber": "8409314368", "status": "Active", "modifiedDate": "2022-10-26T13:32:05Z", "sourceModifiedDate": "2022-07-15T12:01:15Z", "defaultCurrency": "EUR" }, { "id": "00014c12-2616-481a-a2e8-31bdf2497775", "supplierName": "Ann's test supplier 2", "contactName": "Ann's contact name", "emailAddress": "anna@anna888888.com", "phone": "55555555", "addresses": [ { "type": "Billing", "line1": "line1", "line2": "line2", "city": "city", "region": "region", "country": "RU", "postalCode": "postal" } ], "registrationNumber": "55566677788899944455", "taxNumber": "RU4444444", "status": "Active", "modifiedDate": "2022-10-26T13:32:05Z", "sourceModifiedDate": "2021-06-09T12:04:08Z", "defaultCurrency": "USD" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 73, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "0185fea2-0298-445b-909a-0db685118a9e", "supplierName": "a", "addresses": [ { "type": "Billing", "country": "GB" } ], "status": "Active", "modifiedDate": "2022-10-26T13:33:13Z", "sourceModifiedDate": "2017-08-02T10:58:54Z", "defaultCurrency": "GBP" }, { "id": "64ae712f-4155-48bb-9fce-98232c51d979", "supplierName": "aa", "addresses": [ { "type": "Billing", "country": "GB" } ], "status": "Active", "modifiedDate": "2022-10-26T13:33:13Z", "sourceModifiedDate": "2020-05-01T14:05:46Z", "defaultCurrency": "GBP" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 118, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "11526230", "supplierName": "-", "contactName": "Test 1", "addresses": [ { "type": "Billing", "line1": "1 Place House", "line2": "", "city": "London", "country": "United Kingdom", "postalCode": "WC1X 1AH" } ], "status": "Active", "modifiedDate": "2023-04-25T14:19:08Z", "sourceModifiedDate": "2023-04-17T06:02:46", "metadata": { "isDeleted": false } }, { "id": "9677150", "supplierName": "-", "contactName": "Test 1", "addresses": [ { "type": "Billing", "line1": "1 Place House", "line2": "", "city": "London", "country": "United Kingdom", "postalCode": "WC1X 1AH" } ], "status": "Active", "modifiedDate": "2023-04-25T14:19:08Z", "sourceModifiedDate": "2023-04-24T06:19:23", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 159, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "api vendor", "supplierName": "api vendor", "addresses": [], "status": "Active", "modifiedDate": "2023-03-24T16:07:25Z", "metadata": { "isDeleted": false } }, { "id": "DUndsRykrmy8kFsc+FvYk29YkJze4zSjGecoF4YcUEhVU7auJ5JkQA0VjXptZ7XQ+D4n6WoxFIkaGY2V/t4flA==", "supplierName": "Chekko Test merchant 100 - Test Very long name: ORIG CO NAME:AMERICAN EXPRESS ORIG ID:9493560001 DESC DATE:220307 CO ENTRY DESCR:ACH PMT SEC:CCD TRACE#:021000023255482 EED:220307 IND ID:A4670 IND NAME:Rick Sanchez", "addresses": [], "status": "Active", "modifiedDate": "2023-03-24T16:07:25Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 7, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=2&pageSize=2" } } } }, "KashFlow": { "value": { "results": [ { "id": "6202387", "supplierName": "Dell", "contactName": "", "emailAddress": "", "phone": "", "addresses": [], "taxNumber": "", "status": "Unknown", "modifiedDate": "2022-09-30T10:29:15Z", "sourceModifiedDate": "2017-05-09T00:00:00" }, { "id": "9338173", "supplierName": "Home", "contactName": "", "emailAddress": "", "phone": "", "addresses": [], "taxNumber": "", "status": "Unknown", "modifiedDate": "2022-09-30T10:29:15Z", "sourceModifiedDate": "1990-01-01T00:00:00" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 7, "_links": { "current": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers" }, "next": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "779", "supplierName": "Test Vendor", "contactName": "Test Vendor", "emailAddress": "", "phone": "", "addresses": [], "status": "Active", "modifiedDate": "2023-01-30T14:47:02Z", "sourceModifiedDate": "2022-02-04T14:24:43", "defaultCurrency": "GBP" }, { "id": "726", "supplierName": "Vendor -.A", "contactName": "Vendor -.A", "emailAddress": "", "phone": "", "addresses": [], "status": "Active", "modifiedDate": "2023-01-30T14:47:02Z", "sourceModifiedDate": "2021-03-26T09:53:15", "defaultCurrency": "GBP" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 6, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers" }, "next": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "A60000-1197760912", "supplierName": "A Cheung Limited", "contactName": "Angela Cheung", "emailAddress": "AC@CheungLimited.com", "phone": "510 555 5723", "addresses": [ { "type": "Billing", "line1": "A Cheung Limited, Angela Cheung", "line2": "3818 Bear Rd. West", "city": "Berkeley", "region": "CA", "postalCode": "94688" } ], "status": "Active", "modifiedDate": "2023-04-26T09:09:03Z", "sourceModifiedDate": "2023-12-16T05:06:44", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } }, { "id": "A40000-1197774038", "supplierName": "Bank of Anycity", "contactName": "Lisa D. Holzhauser", "emailAddress": "lisah@samplename.com", "phone": "415-555-9135", "addresses": [ { "type": "Billing", "line1": "Bank of Anycity, Lisa Holzhauser", "line2": "1935 Main Street", "city": "Middlefield", "region": "CA", "postalCode": "94482" } ], "status": "Active", "modifiedDate": "2023-04-26T09:09:03Z", "sourceModifiedDate": "2023-12-16T05:06:44", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 54, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "41", "supplierName": "AI Support", "contactName": "AI Support", "addresses": [ { "type": "Billing", "line1": "test", "region": "string", "country": "Djibouti" } ], "status": "Active", "modifiedDate": "2023-01-18T11:02:36Z", "sourceModifiedDate": "2022-12-07T10:48:18Z", "defaultCurrency": "GBP" }, { "id": "42", "supplierName": "AI Support 2", "contactName": "AI Support 2", "addresses": [ { "type": "Billing", "line1": "test", "region": "string", "country": "DJ" } ], "status": "Active", "modifiedDate": "2023-01-18T11:02:36Z", "sourceModifiedDate": "2021-08-31T08:45:02Z", "defaultCurrency": "GBP" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 23, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "129", "supplierName": "Ally Johnson", "contactName": "Miss Smith", "phone": "0728 38474", "addresses": [ { "type": "Billing", "line1": "100 London Road", "line2": "Angel", "city": "London", "region": "Greater London", "country": "England", "postalCode": "EC1M" } ], "status": "Active", "modifiedDate": "2023-04-26T09:35:55Z", "sourceModifiedDate": "2023-04-13T01:51:08Z", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } }, { "id": "88", "supplierName": "Andrew Haberbosch", "addresses": [], "status": "Active", "modifiedDate": "2023-04-26T09:35:55Z", "sourceModifiedDate": "2022-07-06T15:55:28Z", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 64, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "776", "supplierName": "Aaren", "contactName": "", "emailAddress": "", "phone": "", "addresses": [ { "type": "Unknown", "line1": "", "line2": "", "city": "", "region": "", "country": "Great Britain", "postalCode": "" } ], "taxNumber": "", "status": "Archived", "modifiedDate": "2022-10-14T09:35:58Z", "defaultCurrency": "GBP", "metadata": { "isDeleted": true } }, { "id": "914", "supplierName": "Aaren", "contactName": "", "emailAddress": "", "phone": "", "addresses": [ { "type": "Unknown", "line1": "", "line2": "", "city": "", "region": "", "country": "Great Britain", "postalCode": "" } ], "taxNumber": "", "status": "Archived", "modifiedDate": "2022-10-14T09:35:58Z", "defaultCurrency": "GBP", "metadata": { "isDeleted": true } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 943, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "CON001", "supplierName": "Concept Stationery Supplies", "contactName": "Mark Ramsay", "emailAddress": "newbusinessadvice@sage.com", "phone": "0191 643 4343", "addresses": [ { "type": "Delivery", "line1": "66 New Street", "line2": "Ridgeway", "city": "Newcastle Upon Tyne", "region": "", "country": "GB", "postalCode": "NE1 4GF" }, { "type": "Unknown", "line1": "66 New Street", "line2": "Ridgeway", "city": "Newcastle upon Tyne", "region": "", "country": "GB", "postalCode": "NE1 4GF" } ], "taxNumber": "GB988 3453 23", "status": "Active", "modifiedDate": "2023-03-30T14:42:38Z", "sourceModifiedDate": "2022-11-25T09:43:54Z", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } }, { "id": "MCN001", "supplierName": "McNally Computer Supplies", "contactName": "Stuart Lynn", "emailAddress": "newbusinessadvice@sage.com", "phone": "0191 415 3434", "addresses": [ { "type": "Delivery", "line1": "Station Lane Ind Est", "line2": "Birtley", "city": "Chester le Street", "region": "County Durham", "country": "GB", "postalCode": "DH1 3RG" }, { "type": "Unknown", "line1": "Station Lane Ind Est", "line2": "Birtley", "city": "Chester le Street", "region": "County Durham", "country": "GB", "postalCode": "DH1 3RG" } ], "taxNumber": "GB455 2385 34", "status": "Active", "modifiedDate": "2023-03-30T14:42:38Z", "sourceModifiedDate": "2022-12-05T13:37:26Z", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 15, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "65179671e9ef424caff8b9006cd111c8", "supplierName": "5555 Abdul's Test Name", "contactName": "Main Contact", "addresses": [ { "type": "Billing", "country": "United Kingdom (GB)" } ], "status": "Active", "modifiedDate": "2022-10-24T14:52:54Z", "sourceModifiedDate": "2020-02-25T17:23:33Z", "defaultCurrency": "GBP" }, { "id": "cf7f44d693904944a6a7cf3de0887964", "supplierName": "Abdi Supplier", "contactName": "Abdi", "emailAddress": "abdisupplier@company.com", "addresses": [ { "type": "Billing", "line1": "1 Place House", "city": "London", "country": "United Kingdom (GB)", "postalCode": "WC1X 1AH" } ], "status": "Active", "modifiedDate": "2022-10-24T14:52:54Z", "sourceModifiedDate": "2020-02-13T10:38:19Z", "defaultCurrency": "GBP" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 64, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "3", "supplierName": "ADP", "contactName": "Jones, William", "phone": "214-760-9491", "addresses": [ { "type": "Unknown", "line1": "208 S Akard St", "line2": "", "city": "Dallas", "region": "TX", "country": "United States", "postalCode": "75265" } ], "registrationNumber": "", "taxNumber": "85-3678274", "status": "Active", "modifiedDate": "2023-04-04T16:32:20Z", "sourceModifiedDate": "2023-02-16T09:48:27", "defaultCurrency": "USD", "metadata": { "isDeleted": false } }, { "id": "29", "supplierName": "Advisor Printing", "contactName": "Roach, Nathan", "phone": "130-202-4796", "addresses": [ { "type": "Unknown", "line1": "5 Carey Hill", "line2": "", "city": "Drayton Valley", "region": "Alberta", "country": "Canada", "postalCode": "G8V" } ], "registrationNumber": "", "taxNumber": "", "status": "Active", "modifiedDate": "2023-04-04T16:32:20Z", "sourceModifiedDate": "2022-06-15T11:38:29", "defaultCurrency": "CAD", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 77, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers" }, "next": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=2&pageSize=2" } } } }, "Wave": { "value": { "results": [ { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0", "supplierName": "Computer Shop", "contactName": "", "emailAddress": "", "addresses": [], "status": "Active", "modifiedDate": "2022-11-16T18:15:24Z", "sourceModifiedDate": "2020-04-07T13:28:02Z", "defaultCurrency": "GBP" }, { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0NzQx", "supplierName": "Flour Mill", "contactName": "", "emailAddress": "", "addresses": [], "status": "Active", "modifiedDate": "2022-11-16T18:15:24Z", "sourceModifiedDate": "2020-04-07T13:12:40Z", "defaultCurrency": "GBP" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 9, "_links": { "current": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers" }, "next": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "supplierName": "24 Locks", "emailAddress": "", "addresses": [], "status": "Active", "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2023-02-17T18:03:42", "metadata": { "isDeleted": false } }, { "id": "bab779bc-c5fb-42cb-a888-953e8309711c", "supplierName": "7-Eleven", "emailAddress": "", "addresses": [], "status": "Active", "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2023-02-17T18:03:42", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 48, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000001494001", "supplierName": "Acme Corporation", "emailAddress": "", "addresses": [], "status": "Active", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-09-16T13:09:56", "defaultCurrency": "GBP" }, { "id": "104957000000648001", "supplierName": "Cool company", "contactName": "Dre", "emailAddress": "", "addresses": [], "status": "Active", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-06-10T09:07:16", "defaultCurrency": "CAD" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 6, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company's connection.\n\n[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-suppliers" } }, "/companies/{companyId}/data/suppliers/{supplierId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/supplierId" } ], "get": { "tags": [ "Suppliers" ], "summary": "Get supplier", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Supplier" }, "examples": { "Clear Books": { "value": { "id": "owQ2Gqgj9f", "supplierName": "Abshire - Kshlerin", "contactName": "Faye Hansen", "emailAddress": "hello@Abshire-Kshlerin.info", "phone": "01338 858162", "addresses": [ { "type": "Delivery", "line1": "Suite 431", "line2": "289 Giles Lake", "city": "Cesarmouth", "region": "Northern Ireland", "country": "United Kingdom", "postalCode": "BG40 9GP" } ], "registrationNumber": "VYL1XZXR", "taxNumber": "1396267523.0914588", "status": "Active", "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "1660-11-28T23:18:00", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "78623f13-931e-eb11-bbf8-0022481b3585", "supplierName": "", "contactName": "", "emailAddress": "", "phone": "", "addresses": [ { "type": "Billing", "line1": "", "line2": "", "city": "", "region": "", "country": "GB", "postalCode": "" } ], "taxNumber": "", "status": "Active", "modifiedDate": "2023-03-27T14:21:12Z", "sourceModifiedDate": "2020-11-04T11:44:22Z", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } } }, "Exact (Netherlands)": { "value": { "id": "3150917c-1d92-4d77-9018-31b5c4758ca9", "supplierName": "Abe", "contactName": "Kelly's Contact Name", "emailAddress": "sales@kellysupplies.com", "phone": "07999 999999", "addresses": [ { "type": "Billing", "line1": "Unit 51", "city": "Bakersfield", "region": "California", "country": "US", "postalCode": "933081" } ], "registrationNumber": "8409314368", "status": "Active", "modifiedDate": "2022-10-26T13:32:05Z", "sourceModifiedDate": "2022-07-15T12:01:15Z", "defaultCurrency": "EUR" } }, "Exact (UK)": { "value": { "id": "0185fea2-0298-445b-909a-0db685118a9e", "supplierName": "a", "addresses": [ { "type": "Billing", "country": "GB" } ], "status": "Active", "modifiedDate": "2022-10-26T13:33:13Z", "sourceModifiedDate": "2017-08-02T10:58:54Z", "defaultCurrency": "GBP" } }, "FreeAgent": { "value": { "id": "11526230", "supplierName": "-", "contactName": "Test 1", "addresses": [ { "type": "Billing", "line1": "1 Place House", "line2": "", "city": "London", "country": "United Kingdom", "postalCode": "WC1X 1AH" } ], "status": "Active", "modifiedDate": "2023-04-25T14:19:08Z", "sourceModifiedDate": "2023-04-17T06:02:46", "metadata": { "isDeleted": false } } }, "FreshBooks": { "value": { "id": "api vendor", "supplierName": "api vendor", "addresses": [], "status": "Active", "modifiedDate": "2023-03-24T16:07:25Z", "metadata": { "isDeleted": false } } }, "KashFlow": { "value": { "id": "6202387", "supplierName": "Dell", "contactName": "", "emailAddress": "", "phone": "", "addresses": [], "taxNumber": "", "status": "Unknown", "modifiedDate": "2022-09-30T10:29:15Z", "sourceModifiedDate": "2017-05-09T00:00:00" } }, "Oracle NetSuite": { "value": { "id": "779", "supplierName": "Test Vendor", "contactName": "Test Vendor", "emailAddress": "", "phone": "", "addresses": [], "status": "Active", "modifiedDate": "2023-01-30T14:47:02Z", "sourceModifiedDate": "2022-02-04T14:24:43", "defaultCurrency": "GBP" } }, "QuickBooks Desktop": { "value": { "id": "A60000-1197760912", "supplierName": "A Cheung Limited", "contactName": "Angela Cheung", "emailAddress": "AC@CheungLimited.com", "phone": "510 555 5723", "addresses": [ { "type": "Billing", "line1": "A Cheung Limited, Angela Cheung", "line2": "3818 Bear Rd. West", "city": "Berkeley", "region": "CA", "postalCode": "94688" } ], "status": "Active", "modifiedDate": "2023-04-26T09:09:03Z", "sourceModifiedDate": "2023-12-16T05:06:44", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "41", "supplierName": "AI Support", "contactName": "AI Support", "addresses": [ { "type": "Billing", "line1": "test", "region": "string", "country": "Djibouti" } ], "status": "Active", "modifiedDate": "2023-01-18T11:02:36Z", "sourceModifiedDate": "2022-12-07T10:48:18Z", "defaultCurrency": "GBP" } }, "QuickBooks Online Sandbox": { "value": { "id": "129", "supplierName": "Ally Johnson", "contactName": "Miss Smith", "phone": "0728 38474", "addresses": [ { "type": "Billing", "line1": "100 London Road", "line2": "Angel", "city": "London", "region": "Greater London", "country": "England", "postalCode": "EC1M" } ], "status": "Active", "modifiedDate": "2023-04-26T09:35:55Z", "sourceModifiedDate": "2023-04-13T01:51:08Z", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } } }, "Sage 200cloud": { "value": { "id": "776", "supplierName": "Aaren", "contactName": "", "emailAddress": "", "phone": "", "addresses": [ { "type": "Unknown", "line1": "", "line2": "", "city": "", "region": "", "country": "Great Britain", "postalCode": "" } ], "taxNumber": "", "status": "Archived", "modifiedDate": "2022-10-14T09:35:58Z", "defaultCurrency": "GBP", "metadata": { "isDeleted": true } } }, "Sage 50 (UK)": { "value": { "id": "CON001", "supplierName": "Concept Stationery Supplies", "contactName": "Mark Ramsay", "emailAddress": "newbusinessadvice@sage.com", "phone": "0191 643 4343", "addresses": [ { "type": "Delivery", "line1": "66 New Street", "line2": "Ridgeway", "city": "Newcastle Upon Tyne", "region": "", "country": "GB", "postalCode": "NE1 4GF" }, { "type": "Unknown", "line1": "66 New Street", "line2": "Ridgeway", "city": "Newcastle upon Tyne", "region": "", "country": "GB", "postalCode": "NE1 4GF" } ], "taxNumber": "GB988 3453 23", "status": "Active", "modifiedDate": "2023-03-30T14:42:38Z", "sourceModifiedDate": "2022-11-25T09:43:54Z", "defaultCurrency": "GBP", "metadata": { "isDeleted": false } } }, "Sage Business Cloud Accounting": { "value": { "id": "65179671e9ef424caff8b9006cd111c8", "supplierName": "5555 Abdul's Test Name", "contactName": "Main Contact", "addresses": [ { "type": "Billing", "country": "United Kingdom (GB)" } ], "status": "Active", "modifiedDate": "2022-10-24T14:52:54Z", "sourceModifiedDate": "2020-02-25T17:23:33Z", "defaultCurrency": "GBP" } }, "Sage Intacct": { "value": { "id": "3", "supplierName": "ADP", "contactName": "Jones, William", "phone": "214-760-9491", "addresses": [ { "type": "Unknown", "line1": "208 S Akard St", "line2": "", "city": "Dallas", "region": "TX", "country": "United States", "postalCode": "75265" } ], "registrationNumber": "", "taxNumber": "85-3678274", "status": "Active", "modifiedDate": "2023-04-04T16:32:20Z", "sourceModifiedDate": "2023-02-16T09:48:27", "defaultCurrency": "USD", "metadata": { "isDeleted": false } } }, "Wave": { "value": { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0", "supplierName": "Computer Shop", "contactName": "", "emailAddress": "", "addresses": [], "status": "Active", "modifiedDate": "2022-11-16T18:15:24Z", "sourceModifiedDate": "2020-04-07T13:28:02Z", "defaultCurrency": "GBP" } }, "Xero": { "value": { "id": "e4c9d0e2-c285-4e85-b579-6d28b180c730", "supplierName": "24 Locks", "emailAddress": "", "addresses": [], "status": "Active", "modifiedDate": "2023-03-15T20:36:09Z", "sourceModifiedDate": "2023-02-17T18:03:42", "metadata": { "isDeleted": false } } }, "Zoho Books": { "value": { "id": "104957000001494001", "supplierName": "Acme Corporation", "emailAddress": "", "addresses": [], "status": "Active", "modifiedDate": "2022-10-03T08:40:37Z", "sourceModifiedDate": "2022-09-16T13:09:56", "defaultCurrency": "GBP" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get supplier* endpoint returns a single supplier for a given supplierId.\n\n[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a specific supplier.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-supplier" } }, "/companies/{companyId}/connections/{connectionId}/options/suppliers": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create/update supplier model", "tags": [ "Suppliers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Exact (Netherlands)": { "value": { "type": "Object", "displayName": "Supplier", "description": "A Supplier is a person or organisation that provides a product or service", "properties": { "supplierName": { "type": "String", "displayName": "Supplier Name", "description": "The name for the supplier, typically a company name", "required": true }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred email address the supplier should be contacted on", "required": false }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the supplier should be contacted on", "required": false }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the supplier", "required": false }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The supplier's registration number", "required": false, "validation": { "warnings": [ { "field": "RegistrationNumber", "details": "Only for Exact Netherlands, if provided, must be exactly 20 characters in length" } ], "information": [] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The supplier's tax number", "required": false }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the supplier", "required": false }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the supplier", "properties": { "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Must be a 2-letter country code" } ], "information": [] } }, "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses", "details": "Only the first address provided will be considered, all other entries will be not be recorded" } ] } } }, "required": true } }, "Exact (UK)": { "value": { "type": "Object", "displayName": "Supplier", "description": "A Supplier is a person or organisation that provides a product or service", "properties": { "supplierName": { "type": "String", "displayName": "Supplier Name", "description": "The name for the supplier, typically a company name", "required": true }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred email address the supplier should be contacted on", "required": false }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the supplier should be contacted on", "required": false }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the supplier", "required": false }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The supplier's registration number", "required": false, "validation": { "warnings": [ { "field": "RegistrationNumber", "details": "Only for Exact Netherlands, if provided, must be exactly 20 characters in length" } ], "information": [] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The supplier's tax number", "required": false }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the supplier", "required": false }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the supplier", "properties": { "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Must be a 2-letter country code" } ], "information": [] } }, "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses", "details": "Only the first address provided will be considered, all other entries will be not be recorded" } ] } } }, "required": true } }, "FreeAgent": { "value": { "type": "Object", "displayName": "Supplier", "description": "A Supplier is a person or organisation that provides a product or service", "properties": { "supplierName": { "type": "String", "displayName": "Supplier Name", "description": "The name for the supplier, typically a company name", "required": true }, "status": { "type": "String", "displayName": "Supplier Status", "description": "The current state of the supplier", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the supplier", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": true }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses", "details": "Only one address may be specified" } ] } }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the supplier", "required": false }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred email address the supplier should be contacted on", "required": false }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The supplier's tax number", "required": false } }, "required": true } }, "MYOB AccountRight and Essentials": { "value": { "type": "Object", "displayName": "Supplier", "description": "A Supplier is a person or organisation that provides a product or service", "properties": { "supplierName": { "type": "String", "displayName": "Supplier Name", "description": "The name for the supplier, typically a company name", "required": true, "validation": { "warnings": [ { "field": "SupplierName", "details": "Must not have the part after the first name longer than 30 characters." }, { "field": "SupplierName", "details": "Must not have its first part (i.e. the first name) longer than 20 characters." } ], "information": [ { "field": "SupplierName", "details": "Must be provided and must contain a First and Last name separated by a ' '(space)." } ] } }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred email address the supplier should be contacted on", "required": false, "validation": { "warnings": [], "information": [ { "field": "EmailAddress", "details": "Must not be longer than 255 characters." } ] } }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the supplier should be contacted on", "required": false, "validation": { "warnings": [], "information": [ { "field": "Phone", "details": "Must not be longer than 21 characters." } ] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The supplier's tax number", "required": false, "validation": { "warnings": [], "information": [ { "field": "TaxNumber", "details": "Must not be longer than 19 characters." } ] } }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The supplier's registration number", "required": false, "validation": { "warnings": [], "information": [ { "field": "RegistrationNumber", "details": "Must not be longer than 14 characters." } ] } }, "status": { "type": "String", "displayName": "Supplier Status", "description": "The current state of the supplier", "options": [ { "value": "Active", "type": "String", "required": false }, { "value": "Unknown", "type": "String", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Status", "details": "Must be provided." } ] } }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the supplier", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses.Line1", "details": "Must not be longer than 127 characters." } ] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses.Line2", "details": "Must not be longer than 127 characters." } ] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses.City", "details": "Must not be longer than 255 characters." } ] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses.Region", "details": "Must not be longer than 255 characters." } ] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses.PostalCode", "details": "Must not be longer than 11 characters." } ] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses.Country", "details": "Must not be longer than 255 characters." } ] } } }, "required": true, "validation": { "warnings": [ { "field": "Addresses", "details": "Must only have 5 address entries at most." } ], "information": [ { "field": "Addresses", "details": "Must be provided." } ] } } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "Supplier", "description": "A Supplier is a person or organisation that provides a product or service", "properties": { "supplierName": { "type": "String", "displayName": "Supplier Name", "description": "The name for the supplier, typically a company name", "required": true }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred email address the supplier should be contacted on", "required": false }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the supplier", "required": false }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the supplier should be contacted on", "required": false }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The supplier's tax number", "required": false }, "status": { "type": "String", "displayName": "Supplier Status", "description": "The current state of the supplier", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the supplier", "properties": { "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "options": [ { "value": "Billing", "type": "String", "displayName": "Billing", "required": false }, { "value": "Delivery", "type": "String", "displayName": "Delivery", "required": false }, { "value": "Unknown", "type": "String", "displayName": "Unknown", "required": false } ], "required": true }, "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": true, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Must be a two letter Country ISO code" } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false } }, "required": false, "validation": { "warnings": [ { "field": "Addresses", "details": "Only one each of Billing and Delivery addresses can be provided" } ], "information": [ { "field": "Addresses", "details": "Multiple addresses of Unknown type may be provided" } ] } } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Supplier", "description": "A Supplier is a person or organisation that provides a product or service", "properties": { "supplierName": { "type": "String", "displayName": "Supplier Name", "description": "The name for the supplier, typically a company name", "required": true, "validation": { "warnings": [ { "field": "SupplierName", "details": "Max length of 41 characters." } ], "information": [] } }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the supplier", "required": false, "validation": { "warnings": [ { "field": "ContactName", "details": "Max length of 25 characters for first and last names" } ], "information": [] } }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the supplier should be contacted on", "required": false }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred email address the supplier should be contacted on", "required": false }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The supplier's registration number", "required": false }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The supplier's tax number", "required": false, "validation": { "warnings": [ { "field": "TaxNumber", "details": "Max length of 30 characters." } ], "information": [] } }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the supplier", "required": false, "validation": { "warnings": [ { "field": "DefaultCurrency", "details": "Must be a three letter ISO code that matches an existing, active currency in the QuickBooks Desktop company" }, { "field": "DefaultCurrency", "details": "Can only be set if Multicurrency is enabled within the QuickBooks Desktop company" } ], "information": [ { "field": "DefaultCurrency", "details": "If not set, will default to the base currency of the QuickBooks Desktop company" } ] } }, "status": { "type": "String", "displayName": "Supplier Status", "description": "The current state of the supplier", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the supplier", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line1", "details": "Max length of 41 characters." } ], "information": [] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line2", "details": "Max length of 41 characters." } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [ { "field": "Addresses.City", "details": "Max length of 31 characters." } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [ { "field": "Addresses.Region", "details": "Max length of 21 characters." } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Max length of 31 characters." } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.PostalCode", "details": "Max length of 13 characters." } ], "information": [] } }, "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "options": [ { "value": "Billing", "type": "String", "displayName": "Billing Address", "required": false }, { "value": "Delivery", "type": "String", "displayName": "Delivery Address", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "Addresses.Type", "details": "Only 1 address each of type(s) Billing/Delivery may be specified." } ] } } }, "required": false } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Supplier", "description": "A Supplier is a person or organisation that provides a product or service", "properties": { "supplierName": { "type": "String", "displayName": "Supplier Name", "description": "The name for the supplier, typically a company name", "required": true }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the supplier should be contacted on", "required": false, "validation": { "warnings": [ { "field": "Phone", "details": "Country, area, and number are space separated" } ], "information": [] } }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred email address the supplier should be contacted on", "required": false }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The supplier's registration number", "required": false }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The supplier's tax number", "required": false }, "status": { "type": "String", "displayName": "Supplier Status", "description": "The current state of the supplier", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the supplier", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line1", "details": "Max length of 500 characters." } ], "information": [] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line2", "details": "Max length of 500 characters." } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [ { "field": "Addresses.City", "details": "Max length of 255 characters." } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [ { "field": "Addresses.Region", "details": "Max length of 255 characters." } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Max length of 50 characters." } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.PostalCode", "details": "Only English alphabet characters are permitted." }, { "field": "Addresses.PostalCode", "details": "Max length of 50 characters." } ], "information": [] } }, "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "options": [ { "value": "Billing", "type": "String", "displayName": "Billing Address", "required": false } ], "required": true } }, "required": false }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the supplier", "required": false } }, "required": true } }, "QuickBooks Online": { "value": { "type": "Object", "displayName": "Supplier", "description": "A Supplier is a person or organisation that provides a product or service", "properties": { "supplierName": { "type": "String", "displayName": "Supplier Name", "description": "The name for the supplier, typically a company name", "required": true }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the supplier should be contacted on", "required": false, "validation": { "warnings": [ { "field": "Phone", "details": "Country, area, and number are space separated" } ], "information": [] } }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred email address the supplier should be contacted on", "required": false }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The supplier's registration number", "required": false }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The supplier's tax number", "required": false }, "status": { "type": "String", "displayName": "Supplier Status", "description": "The current state of the supplier", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the supplier", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line1", "details": "Max length of 500 characters." } ], "information": [] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line2", "details": "Max length of 500 characters." } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [ { "field": "Addresses.City", "details": "Max length of 255 characters." } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [ { "field": "Addresses.Region", "details": "Max length of 255 characters." } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Max length of 50 characters." } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.PostalCode", "details": "Only English alphabet characters are permitted." }, { "field": "Addresses.PostalCode", "details": "Max length of 50 characters." } ], "information": [] } }, "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "options": [ { "value": "Billing", "type": "String", "displayName": "Billing Address", "required": false } ], "required": true } }, "required": false }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the supplier", "required": false } }, "required": true } }, "Sage 50 (UK)": { "value": { "type": "Object", "displayName": "Supplier", "description": "A Supplier is a person or organisation that provides a product or service", "properties": { "id": { "type": "String", "displayName": "Id", "description": "ID of the supplier.", "required": true, "validation": { "warnings": [ { "field": "id", "details": "The supplier ID must be unique, contain no spaces and have a maximum of 8 characters." } ], "information": [ { "field": "id", "details": "The supplier ID must be all Uppercase, if it is not, it will be converted to Uppercase before pushing." } ] } }, "supplierName": { "type": "String", "displayName": "Name", "description": "Name of the supplier.", "required": true, "validation": { "warnings": [ { "field": "supplierName", "details": "The supplier name can have a maximum of 60 characters" } ], "information": [] } }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the supplier.", "required": false, "validation": { "warnings": [ { "field": "contactName", "details": "The contact name can have a maximum of 30 characters" } ], "information": [] } }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The email address that the supplier may be contacted on.", "required": false }, "phone": { "type": "String", "displayName": "Telephone", "description": "The telephone number that the supplier may be contacted on.", "required": false }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "If not provided, the currency will default to the company's base currency.", "required": false }, "status": { "type": "String", "displayName": "Status", "description": "The status of the supplier.", "options": [ { "value": "Active", "type": "String", "displayName": "Active Status", "required": false } ], "required": false }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "Contact addresses for the supplier.", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "Line 1 of the supplier address.", "required": true }, "line2": { "type": "String", "displayName": "Line 2", "description": "Line 2 of the supplier address.", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The city of the supplier address.", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The region of the supplier address.", "required": false }, "postalCode": { "type": "String", "displayName": "Postal code", "description": "Post or Zip code for the address.", "required": false }, "type": { "type": "String", "displayName": "Type", "description": "The type of address as it related to the supplier.", "options": [ { "value": "Unknown", "type": "String", "displayName": "Unknown Address", "required": false } ], "required": false, "validation": { "warnings": [], "information": [ { "field": "addresses.type", "details": "If Address type is not specified, it will default to type ''Unknown''" } ] } } }, "required": false, "validation": { "warnings": [ { "field": "addresses", "details": "Only one address can be included in the Addresses array." } ], "information": [] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "Legal company registration identifier.", "required": false } }, "required": true, "validation": { "warnings": [], "information": [ { "details": "Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company." } ] } } }, "Sage Business Cloud Accounting": { "value": { "type": "Object", "displayName": "Supplier", "description": "A Supplier is a person or organisation that provides a product or service", "properties": { "supplierName": { "type": "String", "displayName": "Supplier Name", "description": "The name for the supplier, typically a company name", "required": true }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the supplier", "required": false }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred email address the supplier should be contacted on", "required": false }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the supplier should be contacted on", "required": false }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The supplier's tax number", "required": false }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the supplier", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": true, "validation": { "warnings": [ { "field": "Addresses.Line1", "details": "If you're adding an address for this Supplier, you must also include the first line" } ], "information": [] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "options": [ { "value": "Afghanistan (AF)", "type": "String", "displayName": "Afghanistan (AF)", "required": false }, { "value": "Albania (AL)", "type": "String", "displayName": "Albania (AL)", "required": false }, { "value": "Algeria (DZ)", "type": "String", "displayName": "Algeria (DZ)", "required": false }, { "value": "Andorra (AD)", "type": "String", "displayName": "Andorra (AD)", "required": false }, { "value": "Angola (AO)", "type": "String", "displayName": "Angola (AO)", "required": false }, { "value": "Argentina (AR)", "type": "String", "displayName": "Argentina (AR)", "required": false }, { "value": "Armenia (AM)", "type": "String", "displayName": "Armenia (AM)", "required": false }, { "value": "Aruba (AW)", "type": "String", "displayName": "Aruba (AW)", "required": false }, { "value": "Australia (AU)", "type": "String", "displayName": "Australia (AU)", "required": false }, { "value": "Austria (AT)", "type": "String", "displayName": "Austria (AT)", "required": false }, { "value": "Azerbaijan (AZ)", "type": "String", "displayName": "Azerbaijan (AZ)", "required": false }, { "value": "Bahamas (BS)", "type": "String", "displayName": "Bahamas (BS)", "required": false }, { "value": "Bahrain (BH)", "type": "String", "displayName": "Bahrain (BH)", "required": false }, { "value": "Bangladesh (BD)", "type": "String", "displayName": "Bangladesh (BD)", "required": false }, { "value": "Barbados (BB)", "type": "String", "displayName": "Barbados (BB)", "required": false }, { "value": "Belarus (BY)", "type": "String", "displayName": "Belarus (BY)", "required": false }, { "value": "Belgium (BE)", "type": "String", "displayName": "Belgium (BE)", "required": false }, { "value": "Belize (BZ)", "type": "String", "displayName": "Belize (BZ)", "required": false }, { "value": "Benin (BJ)", "type": "String", "displayName": "Benin (BJ)", "required": false }, { "value": "Bermuda (BM)", "type": "String", "displayName": "Bermuda (BM)", "required": false }, { "value": "Bhutan (BT)", "type": "String", "displayName": "Bhutan (BT)", "required": false }, { "value": "Bolivia (BO)", "type": "String", "displayName": "Bolivia (BO)", "required": false }, { "value": "Bosnia and Herzegovina (BA)", "type": "String", "displayName": "Bosnia and Herzegovina (BA)", "required": false }, { "value": "Botswana (BW)", "type": "String", "displayName": "Botswana (BW)", "required": false }, { "value": "Brazil (BR)", "type": "String", "displayName": "Brazil (BR)", "required": false }, { "value": "British Virgin Islands (VG)", "type": "String", "displayName": "British Virgin Islands (VG)", "required": false }, { "value": "Brunei Darussalam (BN)", "type": "String", "displayName": "Brunei Darussalam (BN)", "required": false }, { "value": "Bulgaria (BG)", "type": "String", "displayName": "Bulgaria (BG)", "required": false }, { "value": "Burkina Faso (BF)", "type": "String", "displayName": "Burkina Faso (BF)", "required": false }, { "value": "Burundi (BI)", "type": "String", "displayName": "Burundi (BI)", "required": false }, { "value": "Cambodia (KH)", "type": "String", "displayName": "Cambodia (KH)", "required": false }, { "value": "Cameroon (CM)", "type": "String", "displayName": "Cameroon (CM)", "required": false }, { "value": "Canada (CA)", "type": "String", "displayName": "Canada (CA)", "required": false }, { "value": "Cape Verde (CV)", "type": "String", "displayName": "Cape Verde (CV)", "required": false }, { "value": "Cayman Islands (KY)", "type": "String", "displayName": "Cayman Islands (KY)", "required": false }, { "value": "Central African Republic (CF)", "type": "String", "displayName": "Central African Republic (CF)", "required": false }, { "value": "Chad (TD)", "type": "String", "displayName": "Chad (TD)", "required": false }, { "value": "Chile (CL)", "type": "String", "displayName": "Chile (CL)", "required": false }, { "value": "China (CN)", "type": "String", "displayName": "China (CN)", "required": false }, { "value": "Colombia (CO)", "type": "String", "displayName": "Colombia (CO)", "required": false }, { "value": "Comoros (KM)", "type": "String", "displayName": "Comoros (KM)", "required": false }, { "value": "Congo (CG)", "type": "String", "displayName": "Congo (CG)", "required": false }, { "value": "Costa Rica (CR)", "type": "String", "displayName": "Costa Rica (CR)", "required": false }, { "value": "Croatia (HR)", "type": "String", "displayName": "Croatia (HR)", "required": false }, { "value": "Cuba (CU)", "type": "String", "displayName": "Cuba (CU)", "required": false }, { "value": "Cura�ao (CW)", "type": "String", "displayName": "Cura�ao (CW)", "required": false }, { "value": "Cyprus (CY)", "type": "String", "displayName": "Cyprus (CY)", "required": false }, { "value": "Czech Republic (CZ)", "type": "String", "displayName": "Czech Republic (CZ)", "required": false }, { "value": "Democratic Republic of the Congo (CD)", "type": "String", "displayName": "Democratic Republic of the Congo (CD)", "required": false }, { "value": "Denmark (DK)", "type": "String", "displayName": "Denmark (DK)", "required": false }, { "value": "Djibouti (DJ)", "type": "String", "displayName": "Djibouti (DJ)", "required": false }, { "value": "Dominica (DM)", "type": "String", "displayName": "Dominica (DM)", "required": false }, { "value": "Dominican Republic (DO)", "type": "String", "displayName": "Dominican Republic (DO)", "required": false }, { "value": "East Timor (TP)", "type": "String", "displayName": "East Timor (TP)", "required": false }, { "value": "Ecuador (EC)", "type": "String", "displayName": "Ecuador (EC)", "required": false }, { "value": "Egypt (EG)", "type": "String", "displayName": "Egypt (EG)", "required": false }, { "value": "El Salvador (SV)", "type": "String", "displayName": "El Salvador (SV)", "required": false }, { "value": "Equatorial Guinea (GQ)", "type": "String", "displayName": "Equatorial Guinea (GQ)", "required": false }, { "value": "Eritrea (ER)", "type": "String", "displayName": "Eritrea (ER)", "required": false }, { "value": "Estonia (EE)", "type": "String", "displayName": "Estonia (EE)", "required": false }, { "value": "Ethiopia (ET)", "type": "String", "displayName": "Ethiopia (ET)", "required": false }, { "value": "Falkland Islands (Malvinas) (FK)", "type": "String", "displayName": "Falkland Islands (Malvinas) (FK)", "required": false }, { "value": "Federated States of Micronesia (FM)", "type": "String", "displayName": "Federated States of Micronesia (FM)", "required": false }, { "value": "Fiji (FJ)", "type": "String", "displayName": "Fiji (FJ)", "required": false }, { "value": "Finland (FI)", "type": "String", "displayName": "Finland (FI)", "required": false }, { "value": "France (FR)", "type": "String", "displayName": "France (FR)", "required": false }, { "value": "French Polynesia (PF)", "type": "String", "displayName": "French Polynesia (PF)", "required": false }, { "value": "Gabon (GA)", "type": "String", "displayName": "Gabon (GA)", "required": false }, { "value": "Gambia (GM)", "type": "String", "displayName": "Gambia (GM)", "required": false }, { "value": "Georgia (GE)", "type": "String", "displayName": "Georgia (GE)", "required": false }, { "value": "Germany (DE)", "type": "String", "displayName": "Germany (DE)", "required": false }, { "value": "Ghana (GH)", "type": "String", "displayName": "Ghana (GH)", "required": false }, { "value": "Gibraltar (GI)", "type": "String", "displayName": "Gibraltar (GI)", "required": false }, { "value": "Greece (GR)", "type": "String", "displayName": "Greece (GR)", "required": false }, { "value": "Greenland (GL)", "type": "String", "displayName": "Greenland (GL)", "required": false }, { "value": "Grenada (GD)", "type": "String", "displayName": "Grenada (GD)", "required": false }, { "value": "Guadaloupe (GP)", "type": "String", "displayName": "Guadaloupe (GP)", "required": false }, { "value": "Guam (GU)", "type": "String", "displayName": "Guam (GU)", "required": false }, { "value": "Guatemala (GT)", "type": "String", "displayName": "Guatemala (GT)", "required": false }, { "value": "Guernsey (GG)", "type": "String", "displayName": "Guernsey (GG)", "required": false }, { "value": "Guinea (GN)", "type": "String", "displayName": "Guinea (GN)", "required": false }, { "value": "Guinea-Bissau (GW)", "type": "String", "displayName": "Guinea-Bissau (GW)", "required": false }, { "value": "Guyana (GY)", "type": "String", "displayName": "Guyana (GY)", "required": false }, { "value": "Haiti (HT)", "type": "String", "displayName": "Haiti (HT)", "required": false }, { "value": "Honduras (HN)", "type": "String", "displayName": "Honduras (HN)", "required": false }, { "value": "Hong Kong (HK)", "type": "String", "displayName": "Hong Kong (HK)", "required": false }, { "value": "Hungary (HU)", "type": "String", "displayName": "Hungary (HU)", "required": false }, { "value": "Iceland (IS)", "type": "String", "displayName": "Iceland (IS)", "required": false }, { "value": "India (IN)", "type": "String", "displayName": "India (IN)", "required": false }, { "value": "Indonesia (ID)", "type": "String", "displayName": "Indonesia (ID)", "required": false }, { "value": "Iran (IR)", "type": "String", "displayName": "Iran (IR)", "required": false }, { "value": "Iraq (IQ)", "type": "String", "displayName": "Iraq (IQ)", "required": false }, { "value": "Ireland (IE)", "type": "String", "displayName": "Ireland (IE)", "required": false }, { "value": "Israel (IL)", "type": "String", "displayName": "Israel (IL)", "required": false }, { "value": "Italy (IT)", "type": "String", "displayName": "Italy (IT)", "required": false }, { "value": "Ivory Coast (CI)", "type": "String", "displayName": "Ivory Coast (CI)", "required": false }, { "value": "Jamaica (JM)", "type": "String", "displayName": "Jamaica (JM)", "required": false }, { "value": "Japan (JP)", "type": "String", "displayName": "Japan (JP)", "required": false }, { "value": "Jersey (JE)", "type": "String", "displayName": "Jersey (JE)", "required": false }, { "value": "Jordan (JO)", "type": "String", "displayName": "Jordan (JO)", "required": false }, { "value": "Kazakhstan (KZ)", "type": "String", "displayName": "Kazakhstan (KZ)", "required": false }, { "value": "Kenya (KE)", "type": "String", "displayName": "Kenya (KE)", "required": false }, { "value": "Kuwait (KW)", "type": "String", "displayName": "Kuwait (KW)", "required": false }, { "value": "Kyrgyzstan (KG)", "type": "String", "displayName": "Kyrgyzstan (KG)", "required": false }, { "value": "Laos (LA)", "type": "String", "displayName": "Laos (LA)", "required": false }, { "value": "Latvia (LV)", "type": "String", "displayName": "Latvia (LV)", "required": false }, { "value": "Lebanon (LB)", "type": "String", "displayName": "Lebanon (LB)", "required": false }, { "value": "Lesotho (LS)", "type": "String", "displayName": "Lesotho (LS)", "required": false }, { "value": "Liberia (LR)", "type": "String", "displayName": "Liberia (LR)", "required": false }, { "value": "Libya (LY)", "type": "String", "displayName": "Libya (LY)", "required": false }, { "value": "Liechtenstein (LI)", "type": "String", "displayName": "Liechtenstein (LI)", "required": false }, { "value": "Lithuania (LT)", "type": "String", "displayName": "Lithuania (LT)", "required": false }, { "value": "Luxembourg (LU)", "type": "String", "displayName": "Luxembourg (LU)", "required": false }, { "value": "Macau (MO)", "type": "String", "displayName": "Macau (MO)", "required": false }, { "value": "Macedonia (MK)", "type": "String", "displayName": "Macedonia (MK)", "required": false }, { "value": "Madagascar (MG)", "type": "String", "displayName": "Madagascar (MG)", "required": false }, { "value": "Malawi (MW)", "type": "String", "displayName": "Malawi (MW)", "required": false }, { "value": "Malaysia (MY)", "type": "String", "displayName": "Malaysia (MY)", "required": false }, { "value": "Maldives (MV)", "type": "String", "displayName": "Maldives (MV)", "required": false }, { "value": "Mali (ML)", "type": "String", "displayName": "Mali (ML)", "required": false }, { "value": "Malta (MT)", "type": "String", "displayName": "Malta (MT)", "required": false }, { "value": "Mauritania (MR)", "type": "String", "displayName": "Mauritania (MR)", "required": false }, { "value": "Mauritius (MU)", "type": "String", "displayName": "Mauritius (MU)", "required": false }, { "value": "Mexico (MX)", "type": "String", "displayName": "Mexico (MX)", "required": false }, { "value": "Moldova (MD)", "type": "String", "displayName": "Moldova (MD)", "required": false }, { "value": "Monaco (MC)", "type": "String", "displayName": "Monaco (MC)", "required": false }, { "value": "Mongolia (MN)", "type": "String", "displayName": "Mongolia (MN)", "required": false }, { "value": "Montenegro (ME)", "type": "String", "displayName": "Montenegro (ME)", "required": false }, { "value": "Morocco (MA)", "type": "String", "displayName": "Morocco (MA)", "required": false }, { "value": "Mozambique (MZ)", "type": "String", "displayName": "Mozambique (MZ)", "required": false }, { "value": "Myanmar (MM)", "type": "String", "displayName": "Myanmar (MM)", "required": false }, { "value": "Namibia (NA)", "type": "String", "displayName": "Namibia (NA)", "required": false }, { "value": "Nepal (NP)", "type": "String", "displayName": "Nepal (NP)", "required": false }, { "value": "Netherlands (NL)", "type": "String", "displayName": "Netherlands (NL)", "required": false }, { "value": "Netherlands Antilles (AN)", "type": "String", "displayName": "Netherlands Antilles (AN)", "required": false }, { "value": "New Caledonia (NC)", "type": "String", "displayName": "New Caledonia (NC)", "required": false }, { "value": "New Zealand (NZ)", "type": "String", "displayName": "New Zealand (NZ)", "required": false }, { "value": "Nicaragua (NI)", "type": "String", "displayName": "Nicaragua (NI)", "required": false }, { "value": "Niger (NE)", "type": "String", "displayName": "Niger (NE)", "required": false }, { "value": "Nigeria (NG)", "type": "String", "displayName": "Nigeria (NG)", "required": false }, { "value": "North Korea (KP)", "type": "String", "displayName": "North Korea (KP)", "required": false }, { "value": "Norway (NO)", "type": "String", "displayName": "Norway (NO)", "required": false }, { "value": "Oman (OM)", "type": "String", "displayName": "Oman (OM)", "required": false }, { "value": "Pakistan (PK)", "type": "String", "displayName": "Pakistan (PK)", "required": false }, { "value": "Panama (PA)", "type": "String", "displayName": "Panama (PA)", "required": false }, { "value": "Papua New Guinea (PG)", "type": "String", "displayName": "Papua New Guinea (PG)", "required": false }, { "value": "Paraguay (PY)", "type": "String", "displayName": "Paraguay (PY)", "required": false }, { "value": "Peru (PE)", "type": "String", "displayName": "Peru (PE)", "required": false }, { "value": "Philippines (PH)", "type": "String", "displayName": "Philippines (PH)", "required": false }, { "value": "Poland (PL)", "type": "String", "displayName": "Poland (PL)", "required": false }, { "value": "Portugal (PT)", "type": "String", "displayName": "Portugal (PT)", "required": false }, { "value": "Puerto Rico (PR)", "type": "String", "displayName": "Puerto Rico (PR)", "required": false }, { "value": "Qatar (QA)", "type": "String", "displayName": "Qatar (QA)", "required": false }, { "value": "Romania (RO)", "type": "String", "displayName": "Romania (RO)", "required": false }, { "value": "Russia (RU)", "type": "String", "displayName": "Russia (RU)", "required": false }, { "value": "Rwanda (RW)", "type": "String", "displayName": "Rwanda (RW)", "required": false }, { "value": "Saint Kitts and Nevis (KN)", "type": "String", "displayName": "Saint Kitts and Nevis (KN)", "required": false }, { "value": "Saint Pierre and Miquelon (PM)", "type": "String", "displayName": "Saint Pierre and Miquelon (PM)", "required": false }, { "value": "Samoa (WS)", "type": "String", "displayName": "Samoa (WS)", "required": false }, { "value": "San Marino (SM)", "type": "String", "displayName": "San Marino (SM)", "required": false }, { "value": "Sao Tome and Principe (ST)", "type": "String", "displayName": "Sao Tome and Principe (ST)", "required": false }, { "value": "Saudi Arabia (SA)", "type": "String", "displayName": "Saudi Arabia (SA)", "required": false }, { "value": "Senegal (SN)", "type": "String", "displayName": "Senegal (SN)", "required": false }, { "value": "Serbia (RS)", "type": "String", "displayName": "Serbia (RS)", "required": false }, { "value": "Seychelles (SC)", "type": "String", "displayName": "Seychelles (SC)", "required": false }, { "value": "Sierra Leone (SL)", "type": "String", "displayName": "Sierra Leone (SL)", "required": false }, { "value": "Singapore (SG)", "type": "String", "displayName": "Singapore (SG)", "required": false }, { "value": "Slovakia (SK)", "type": "String", "displayName": "Slovakia (SK)", "required": false }, { "value": "Slovenia (SI)", "type": "String", "displayName": "Slovenia (SI)", "required": false }, { "value": "Solomon Islands (SB)", "type": "String", "displayName": "Solomon Islands (SB)", "required": false }, { "value": "Somalia (SO)", "type": "String", "displayName": "Somalia (SO)", "required": false }, { "value": "South Africa (ZA)", "type": "String", "displayName": "South Africa (ZA)", "required": false }, { "value": "South Korea (KR)", "type": "String", "displayName": "South Korea (KR)", "required": false }, { "value": "Spain (ES)", "type": "String", "displayName": "Spain (ES)", "required": false }, { "value": "Sri Lanka (LK)", "type": "String", "displayName": "Sri Lanka (LK)", "required": false }, { "value": "St. Lucia (LC)", "type": "String", "displayName": "St. Lucia (LC)", "required": false }, { "value": "Sudan (SD)", "type": "String", "displayName": "Sudan (SD)", "required": false }, { "value": "Surinam (SR)", "type": "String", "displayName": "Surinam (SR)", "required": false }, { "value": "Swaziland (SZ)", "type": "String", "displayName": "Swaziland (SZ)", "required": false }, { "value": "Sweden (SE)", "type": "String", "displayName": "Sweden (SE)", "required": false }, { "value": "Switzerland (CH)", "type": "String", "displayName": "Switzerland (CH)", "required": false }, { "value": "Syria (SY)", "type": "String", "displayName": "Syria (SY)", "required": false }, { "value": "Taiwan (TW)", "type": "String", "displayName": "Taiwan (TW)", "required": false }, { "value": "Tajikistan (TJ)", "type": "String", "displayName": "Tajikistan (TJ)", "required": false }, { "value": "Tanzania (TZ)", "type": "String", "displayName": "Tanzania (TZ)", "required": false }, { "value": "Thailand (TH)", "type": "String", "displayName": "Thailand (TH)", "required": false }, { "value": "Togo (TG)", "type": "String", "displayName": "Togo (TG)", "required": false }, { "value": "Tonga (TO)", "type": "String", "displayName": "Tonga (TO)", "required": false }, { "value": "Trinidad and Tobago (TT)", "type": "String", "displayName": "Trinidad and Tobago (TT)", "required": false }, { "value": "Tunisia (TN)", "type": "String", "displayName": "Tunisia (TN)", "required": false }, { "value": "Turkey (TR)", "type": "String", "displayName": "Turkey (TR)", "required": false }, { "value": "Turkmenistan (TM)", "type": "String", "displayName": "Turkmenistan (TM)", "required": false }, { "value": "Tuvalu (TV)", "type": "String", "displayName": "Tuvalu (TV)", "required": false }, { "value": "Uganda (UG)", "type": "String", "displayName": "Uganda (UG)", "required": false }, { "value": "Ukraine (UA)", "type": "String", "displayName": "Ukraine (UA)", "required": false }, { "value": "United Arab Emirates (AE)", "type": "String", "displayName": "United Arab Emirates (AE)", "required": false }, { "value": "United Kingdom (GB)", "type": "String", "displayName": "United Kingdom (GB)", "required": false }, { "value": "United States (US)", "type": "String", "displayName": "United States (US)", "required": false }, { "value": "Uruguay (UY)", "type": "String", "displayName": "Uruguay (UY)", "required": false }, { "value": "Uzbekistan (UZ)", "type": "String", "displayName": "Uzbekistan (UZ)", "required": false }, { "value": "Vanuatu (VU)", "type": "String", "displayName": "Vanuatu (VU)", "required": false }, { "value": "Venezuela (VE)", "type": "String", "displayName": "Venezuela (VE)", "required": false }, { "value": "Vietnam (VN)", "type": "String", "displayName": "Vietnam (VN)", "required": false }, { "value": "Virgin Islands U.S. (VI)", "type": "String", "displayName": "Virgin Islands U.S. (VI)", "required": false }, { "value": "Western Sahara (EH)", "type": "String", "displayName": "Western Sahara (EH)", "required": false }, { "value": "Yemen (YE)", "type": "String", "displayName": "Yemen (YE)", "required": false }, { "value": "Zaire (ZR)", "type": "String", "displayName": "Zaire (ZR)", "required": false }, { "value": "Zambia (ZM)", "type": "String", "displayName": "Zambia (ZM)", "required": false }, { "value": "Zimbabwe (ZW)", "type": "String", "displayName": "Zimbabwe (ZW)", "required": false } ], "required": false } }, "required": false, "validation": { "warnings": [], "information": [ { "field": "Addresses", "details": "Can contain a maximum of one address" } ] } } }, "required": true } }, "Sage Intacct": { "value": { "type": "Object", "displayName": "Supplier", "description": "A Supplier is a person or organisation that provides a product or service", "properties": { "supplierName": { "type": "String", "displayName": "Supplier Name", "description": "The name for the supplier, typically a company name", "required": true, "validation": { "warnings": [ { "field": "SupplierName", "details": "Must be between 1 and 100 characters" } ], "information": [] } }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the supplier", "required": true, "validation": { "warnings": [ { "field": "ContactName", "details": "Must be between 1 and 200 characters" } ], "information": [] } }, "status": { "type": "String", "displayName": "Supplier Status", "description": "The current state of the supplier", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "Archived", "type": "String", "displayName": "Archived", "required": false } ], "required": true }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the supplier should be contacted on", "required": false, "validation": { "warnings": [ { "field": "Phone", "details": "Must be no greater than 30 characters" } ], "information": [] } }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred email address the supplier should be contacted on", "required": false, "validation": { "warnings": [ { "field": "EmailAddress", "details": "Must be no greater than 200 characters" } ], "information": [] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The supplier's tax number", "required": false, "validation": { "warnings": [ { "field": "TaxNumber", "details": "Must be no greater than 20 characters" } ], "information": [] } }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The supplier's registration number", "required": false, "validation": { "warnings": [ { "field": "RegistrationNumber", "details": "Must be no greater than 100 characters" } ], "information": [] } }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the supplier", "options": [ { "value": "AUD", "type": "String", "displayName": "Australian Dollar", "required": false }, { "value": "CAD", "type": "String", "displayName": "Canadian Dollar", "required": false }, { "value": "GBP", "type": "String", "displayName": "Pound Sterling", "required": false }, { "value": "USD", "type": "String", "displayName": "US Dollar", "required": false }, { "value": "ZAR", "type": "String", "displayName": "Rand", "required": false } ], "required": false }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the supplier", "properties": { "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line1", "details": "Must be no greater than 200 characters" } ], "information": [] } }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.Line2", "details": "Must be no greater than 200 characters" } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": false, "validation": { "warnings": [ { "field": "Addresses.City", "details": "Must be no greater than 80 characters" } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": false, "validation": { "warnings": [ { "field": "Addresses.Region", "details": "Must be no greater than 40 characters" } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": false, "validation": { "warnings": [ { "field": "Addresses.PostalCode", "details": "Must be no greater than 30 characters" } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "options": [ { "value": "United States", "type": "String", "displayName": "United States", "required": false }, { "value": "Afghanistan", "type": "String", "displayName": "Afghanistan", "required": false }, { "value": "Aland Islands", "type": "String", "displayName": "Aland Islands", "required": false }, { "value": "Albania", "type": "String", "displayName": "Albania", "required": false }, { "value": "Algeria", "type": "String", "displayName": "Algeria", "required": false }, { "value": "American Samoa", "type": "String", "displayName": "American Samoa", "required": false }, { "value": "Andorra", "type": "String", "displayName": "Andorra", "required": false }, { "value": "Angola", "type": "String", "displayName": "Angola", "required": false }, { "value": "Anguilla", "type": "String", "displayName": "Anguilla", "required": false }, { "value": "Antarctica", "type": "String", "displayName": "Antarctica", "required": false }, { "value": "Antigua and Barbuda", "type": "String", "displayName": "Antigua and Barbuda", "required": false }, { "value": "Argentina", "type": "String", "displayName": "Argentina", "required": false }, { "value": "Armenia", "type": "String", "displayName": "Armenia", "required": false }, { "value": "Aruba", "type": "String", "displayName": "Aruba", "required": false }, { "value": "Australia", "type": "String", "displayName": "Australia", "required": false }, { "value": "Austria", "type": "String", "displayName": "Austria", "required": false }, { "value": "Azerbaijan", "type": "String", "displayName": "Azerbaijan", "required": false }, { "value": "Bahamas", "type": "String", "displayName": "Bahamas", "required": false }, { "value": "Bahrain", "type": "String", "displayName": "Bahrain", "required": false }, { "value": "Bangladesh", "type": "String", "displayName": "Bangladesh", "required": false }, { "value": "Barbados", "type": "String", "displayName": "Barbados", "required": false }, { "value": "Belarus", "type": "String", "displayName": "Belarus", "required": false }, { "value": "Belgium", "type": "String", "displayName": "Belgium", "required": false }, { "value": "Belize", "type": "String", "displayName": "Belize", "required": false }, { "value": "Benin", "type": "String", "displayName": "Benin", "required": false }, { "value": "Bermuda", "type": "String", "displayName": "Bermuda", "required": false }, { "value": "Bhutan", "type": "String", "displayName": "Bhutan", "required": false }, { "value": "Bolivia", "type": "String", "displayName": "Bolivia", "required": false }, { "value": "Bonaire, Sint Eustatius and Saba", "type": "String", "displayName": "Bonaire, Sint Eustatius and Saba", "required": false }, { "value": "Bosnia and Herzegovina", "type": "String", "displayName": "Bosnia and Herzegovina", "required": false }, { "value": "Botswana", "type": "String", "displayName": "Botswana", "required": false }, { "value": "Bouvet Island", "type": "String", "displayName": "Bouvet Island", "required": false }, { "value": "Brazil", "type": "String", "displayName": "Brazil", "required": false }, { "value": "British Indian Ocean Territory", "type": "String", "displayName": "British Indian Ocean Territory", "required": false }, { "value": "Brunei Darussalam", "type": "String", "displayName": "Brunei Darussalam", "required": false }, { "value": "Bulgaria", "type": "String", "displayName": "Bulgaria", "required": false }, { "value": "Burkina Faso", "type": "String", "displayName": "Burkina Faso", "required": false }, { "value": "Burundi", "type": "String", "displayName": "Burundi", "required": false }, { "value": "Cambodia", "type": "String", "displayName": "Cambodia", "required": false }, { "value": "Cameroon", "type": "String", "displayName": "Cameroon", "required": false }, { "value": "Canada", "type": "String", "displayName": "Canada", "required": false }, { "value": "Cape Verde", "type": "String", "displayName": "Cape Verde", "required": false }, { "value": "Cayman Islands", "type": "String", "displayName": "Cayman Islands", "required": false }, { "value": "Central African Republic", "type": "String", "displayName": "Central African Republic", "required": false }, { "value": "Chad", "type": "String", "displayName": "Chad", "required": false }, { "value": "Chile", "type": "String", "displayName": "Chile", "required": false }, { "value": "China", "type": "String", "displayName": "China", "required": false }, { "value": "Christmas Island", "type": "String", "displayName": "Christmas Island", "required": false }, { "value": "Cocos (Keeling) Islands", "type": "String", "displayName": "Cocos (Keeling) Islands", "required": false }, { "value": "Colombia", "type": "String", "displayName": "Colombia", "required": false }, { "value": "Comoros", "type": "String", "displayName": "Comoros", "required": false }, { "value": "Congo", "type": "String", "displayName": "Congo", "required": false }, { "value": "Congo, Democratic Republic", "type": "String", "displayName": "Congo, Democratic Republic", "required": false }, { "value": "Cook Islands", "type": "String", "displayName": "Cook Islands", "required": false }, { "value": "Costa Rica", "type": "String", "displayName": "Costa Rica", "required": false }, { "value": "C�te d'Ivoire", "type": "String", "displayName": "C�te d'Ivoire", "required": false }, { "value": "Croatia", "type": "String", "displayName": "Croatia", "required": false }, { "value": "Cuba", "type": "String", "displayName": "Cuba", "required": false }, { "value": "Cura�ao", "type": "String", "displayName": "Cura�ao", "required": false }, { "value": "Cyprus", "type": "String", "displayName": "Cyprus", "required": false }, { "value": "Czech Republic", "type": "String", "displayName": "Czech Republic", "required": false }, { "value": "Denmark", "type": "String", "displayName": "Denmark", "required": false }, { "value": "Djibouti", "type": "String", "displayName": "Djibouti", "required": false }, { "value": "Dominica", "type": "String", "displayName": "Dominica", "required": false }, { "value": "Dominican Republic", "type": "String", "displayName": "Dominican Republic", "required": false }, { "value": "Ecuador", "type": "String", "displayName": "Ecuador", "required": false }, { "value": "Egypt", "type": "String", "displayName": "Egypt", "required": false }, { "value": "El Salvador", "type": "String", "displayName": "El Salvador", "required": false }, { "value": "Equatorial Guinea", "type": "String", "displayName": "Equatorial Guinea", "required": false }, { "value": "Eritrea", "type": "String", "displayName": "Eritrea", "required": false }, { "value": "Estonia", "type": "String", "displayName": "Estonia", "required": false }, { "value": "Eswatini", "type": "String", "displayName": "Eswatini", "required": false }, { "value": "Ethiopia", "type": "String", "displayName": "Ethiopia", "required": false }, { "value": "Falkland Islands (Malvinas", "type": "String", "displayName": "Falkland Islands (Malvinas", "required": false }, { "value": "Faroe Islands", "type": "String", "displayName": "Faroe Islands", "required": false }, { "value": "Fiji", "type": "String", "displayName": "Fiji", "required": false }, { "value": "Finland", "type": "String", "displayName": "Finland", "required": false }, { "value": "France", "type": "String", "displayName": "France", "required": false }, { "value": "French Guiana", "type": "String", "displayName": "French Guiana", "required": false }, { "value": "French Polynesia", "type": "String", "displayName": "French Polynesia", "required": false }, { "value": "French Southern Territories", "type": "String", "displayName": "French Southern Territories", "required": false }, { "value": "Gabon", "type": "String", "displayName": "Gabon", "required": false }, { "value": "Gambia", "type": "String", "displayName": "Gambia", "required": false }, { "value": "Georgia", "type": "String", "displayName": "Georgia", "required": false }, { "value": "Germany", "type": "String", "displayName": "Germany", "required": false }, { "value": "Ghana", "type": "String", "displayName": "Ghana", "required": false }, { "value": "Gibraltar", "type": "String", "displayName": "Gibraltar", "required": false }, { "value": "Greece", "type": "String", "displayName": "Greece", "required": false }, { "value": "Greenland", "type": "String", "displayName": "Greenland", "required": false }, { "value": "Grenada", "type": "String", "displayName": "Grenada", "required": false }, { "value": "Guadeloupe", "type": "String", "displayName": "Guadeloupe", "required": false }, { "value": "Guam", "type": "String", "displayName": "Guam", "required": false }, { "value": "Guatemala", "type": "String", "displayName": "Guatemala", "required": false }, { "value": "Guernsey", "type": "String", "displayName": "Guernsey", "required": false }, { "value": "Guinea", "type": "String", "displayName": "Guinea", "required": false }, { "value": "Guinea-Bissau", "type": "String", "displayName": "Guinea-Bissau", "required": false }, { "value": "Guyana", "type": "String", "displayName": "Guyana", "required": false }, { "value": "Haiti", "type": "String", "displayName": "Haiti", "required": false }, { "value": "Heard Is. & Mcdonald Islands", "type": "String", "displayName": "Heard Is. & Mcdonald Islands", "required": false }, { "value": "Honduras", "type": "String", "displayName": "Honduras", "required": false }, { "value": "Hong Kong", "type": "String", "displayName": "Hong Kong", "required": false }, { "value": "Hungary", "type": "String", "displayName": "Hungary", "required": false }, { "value": "Iceland", "type": "String", "displayName": "Iceland", "required": false }, { "value": "India", "type": "String", "displayName": "India", "required": false }, { "value": "Indonesia", "type": "String", "displayName": "Indonesia", "required": false }, { "value": "Iran, Islamic Republic of", "type": "String", "displayName": "Iran, Islamic Republic of", "required": false }, { "value": "Iraq", "type": "String", "displayName": "Iraq", "required": false }, { "value": "Ireland", "type": "String", "displayName": "Ireland", "required": false }, { "value": "Isle of Man", "type": "String", "displayName": "Isle of Man", "required": false }, { "value": "Israel", "type": "String", "displayName": "Israel", "required": false }, { "value": "Italy", "type": "String", "displayName": "Italy", "required": false }, { "value": "Jamaica", "type": "String", "displayName": "Jamaica", "required": false }, { "value": "Japan", "type": "String", "displayName": "Japan", "required": false }, { "value": "Jersey", "type": "String", "displayName": "Jersey", "required": false }, { "value": "Jordan", "type": "String", "displayName": "Jordan", "required": false }, { "value": "Kazakhstan", "type": "String", "displayName": "Kazakhstan", "required": false }, { "value": "Kenya", "type": "String", "displayName": "Kenya", "required": false }, { "value": "Kiribati", "type": "String", "displayName": "Kiribati", "required": false }, { "value": "Korea, Republic of", "type": "String", "displayName": "Korea, Republic of", "required": false }, { "value": "Korea, Demo. People's Rep", "type": "String", "displayName": "Korea, Demo. People's Rep", "required": false }, { "value": "Kosovo", "type": "String", "displayName": "Kosovo", "required": false }, { "value": "Kuwait", "type": "String", "displayName": "Kuwait", "required": false }, { "value": "Kyrgyzstan", "type": "String", "displayName": "Kyrgyzstan", "required": false }, { "value": "Lao", "type": "String", "displayName": "Lao", "required": false }, { "value": "Latvia", "type": "String", "displayName": "Latvia", "required": false }, { "value": "Lebanon", "type": "String", "displayName": "Lebanon", "required": false }, { "value": "Lesotho", "type": "String", "displayName": "Lesotho", "required": false }, { "value": "Liberia", "type": "String", "displayName": "Liberia", "required": false }, { "value": "Libyan Arab Jamahiriya", "type": "String", "displayName": "Libyan Arab Jamahiriya", "required": false }, { "value": "Liechtenstein", "type": "String", "displayName": "Liechtenstein", "required": false }, { "value": "Lithuania", "type": "String", "displayName": "Lithuania", "required": false }, { "value": "Luxembourg", "type": "String", "displayName": "Luxembourg", "required": false }, { "value": "Macao", "type": "String", "displayName": "Macao", "required": false }, { "value": "Macedonia", "type": "String", "displayName": "Macedonia", "required": false }, { "value": "Madagascar", "type": "String", "displayName": "Madagascar", "required": false }, { "value": "Malawi", "type": "String", "displayName": "Malawi", "required": false }, { "value": "Malaysia", "type": "String", "displayName": "Malaysia", "required": false }, { "value": "Maldives", "type": "String", "displayName": "Maldives", "required": false }, { "value": "Mali", "type": "String", "displayName": "Mali", "required": false }, { "value": "Malta", "type": "String", "displayName": "Malta", "required": false }, { "value": "Marshall Islands", "type": "String", "displayName": "Marshall Islands", "required": false }, { "value": "Martinique", "type": "String", "displayName": "Martinique", "required": false }, { "value": "Mauritania", "type": "String", "displayName": "Mauritania", "required": false }, { "value": "Mauritius", "type": "String", "displayName": "Mauritius", "required": false }, { "value": "Mayotte", "type": "String", "displayName": "Mayotte", "required": false }, { "value": "Mexico", "type": "String", "displayName": "Mexico", "required": false }, { "value": "Micronesia", "type": "String", "displayName": "Micronesia", "required": false }, { "value": "Moldova, Republic of", "type": "String", "displayName": "Moldova, Republic of", "required": false }, { "value": "Monaco", "type": "String", "displayName": "Monaco", "required": false }, { "value": "Mongolia", "type": "String", "displayName": "Mongolia", "required": false }, { "value": "Montenegro", "type": "String", "displayName": "Montenegro", "required": false }, { "value": "Montserrat", "type": "String", "displayName": "Montserrat", "required": false }, { "value": "Morocco", "type": "String", "displayName": "Morocco", "required": false }, { "value": "Mozambique", "type": "String", "displayName": "Mozambique", "required": false }, { "value": "Myanmar", "type": "String", "displayName": "Myanmar", "required": false }, { "value": "Namibia", "type": "String", "displayName": "Namibia", "required": false }, { "value": "Nauru", "type": "String", "displayName": "Nauru", "required": false }, { "value": "Nepal", "type": "String", "displayName": "Nepal", "required": false }, { "value": "Netherlands", "type": "String", "displayName": "Netherlands", "required": false }, { "value": "Netherlands Antilles", "type": "String", "displayName": "Netherlands Antilles", "required": false }, { "value": "New Caledonia", "type": "String", "displayName": "New Caledonia", "required": false }, { "value": "New Zealand", "type": "String", "displayName": "New Zealand", "required": false }, { "value": "Nicaragua", "type": "String", "displayName": "Nicaragua", "required": false }, { "value": "Niger", "type": "String", "displayName": "Niger", "required": false }, { "value": "Nigeria", "type": "String", "displayName": "Nigeria", "required": false }, { "value": "Niue", "type": "String", "displayName": "Niue", "required": false }, { "value": "Norfolk Island", "type": "String", "displayName": "Norfolk Island", "required": false }, { "value": "Northern Mariana Islands", "type": "String", "displayName": "Northern Mariana Islands", "required": false }, { "value": "Norway", "type": "String", "displayName": "Norway", "required": false }, { "value": "Oman", "type": "String", "displayName": "Oman", "required": false }, { "value": "Pakistan", "type": "String", "displayName": "Pakistan", "required": false }, { "value": "Palau", "type": "String", "displayName": "Palau", "required": false }, { "value": "Palestinian Territory, Occupied", "type": "String", "displayName": "Palestinian Territory, Occupied", "required": false }, { "value": "Panama", "type": "String", "displayName": "Panama", "required": false }, { "value": "Papua New Guinea", "type": "String", "displayName": "Papua New Guinea", "required": false }, { "value": "Paraguay", "type": "String", "displayName": "Paraguay", "required": false }, { "value": "Peru", "type": "String", "displayName": "Peru", "required": false }, { "value": "Philippines", "type": "String", "displayName": "Philippines", "required": false }, { "value": "Pitcairn", "type": "String", "displayName": "Pitcairn", "required": false }, { "value": "Poland", "type": "String", "displayName": "Poland", "required": false }, { "value": "Portugal", "type": "String", "displayName": "Portugal", "required": false }, { "value": "Puerto Rico", "type": "String", "displayName": "Puerto Rico", "required": false }, { "value": "Qatar", "type": "String", "displayName": "Qatar", "required": false }, { "value": "Reunion", "type": "String", "displayName": "Reunion", "required": false }, { "value": "Romania", "type": "String", "displayName": "Romania", "required": false }, { "value": "Russian Federation", "type": "String", "displayName": "Russian Federation", "required": false }, { "value": "Rwanda", "type": "String", "displayName": "Rwanda", "required": false }, { "value": "Saint Barthelemy", "type": "String", "displayName": "Saint Barthelemy", "required": false }, { "value": "Saint Helena", "type": "String", "displayName": "Saint Helena", "required": false }, { "value": "Saint Kitts and Nevis", "type": "String", "displayName": "Saint Kitts and Nevis", "required": false }, { "value": "Saint Lucia", "type": "String", "displayName": "Saint Lucia", "required": false }, { "value": "Saint Martin", "type": "String", "displayName": "Saint Martin", "required": false }, { "value": "Saint Pierre and Miquelon", "type": "String", "displayName": "Saint Pierre and Miquelon", "required": false }, { "value": "Saint Vincent and the Grenadines", "type": "String", "displayName": "Saint Vincent and the Grenadines", "required": false }, { "value": "Samoa", "type": "String", "displayName": "Samoa", "required": false }, { "value": "San Marino", "type": "String", "displayName": "San Marino", "required": false }, { "value": "Sao Tome and Principe", "type": "String", "displayName": "Sao Tome and Principe", "required": false }, { "value": "Saudi Arabia", "type": "String", "displayName": "Saudi Arabia", "required": false }, { "value": "Senegal", "type": "String", "displayName": "Senegal", "required": false }, { "value": "Serbia", "type": "String", "displayName": "Serbia", "required": false }, { "value": "Seychelles", "type": "String", "displayName": "Seychelles", "required": false }, { "value": "Sierra Leone", "type": "String", "displayName": "Sierra Leone", "required": false }, { "value": "Singapore", "type": "String", "displayName": "Singapore", "required": false }, { "value": "Sint Maarten", "type": "String", "displayName": "Sint Maarten", "required": false }, { "value": "Slovakia", "type": "String", "displayName": "Slovakia", "required": false }, { "value": "Slovenia", "type": "String", "displayName": "Slovenia", "required": false }, { "value": "Solomon Islands", "type": "String", "displayName": "Solomon Islands", "required": false }, { "value": "Somalia", "type": "String", "displayName": "Somalia", "required": false }, { "value": "South Africa", "type": "String", "displayName": "South Africa", "required": false }, { "value": "S. Georgia & S. Sandwich Is", "type": "String", "displayName": "S. Georgia & S. Sandwich Is", "required": false }, { "value": "Spain", "type": "String", "displayName": "Spain", "required": false }, { "value": "Sri Lanka", "type": "String", "displayName": "Sri Lanka", "required": false }, { "value": "Sudan", "type": "String", "displayName": "Sudan", "required": false }, { "value": "South Sudan", "type": "String", "displayName": "South Sudan", "required": false }, { "value": "Suriname", "type": "String", "displayName": "Suriname", "required": false }, { "value": "Svalbard and Jan Mayen", "type": "String", "displayName": "Svalbard and Jan Mayen", "required": false }, { "value": "Sweden", "type": "String", "displayName": "Sweden", "required": false }, { "value": "Switzerland", "type": "String", "displayName": "Switzerland", "required": false }, { "value": "Syrian Arab Republic", "type": "String", "displayName": "Syrian Arab Republic", "required": false }, { "value": "Taiwan", "type": "String", "displayName": "Taiwan", "required": false }, { "value": "Tajikistan", "type": "String", "displayName": "Tajikistan", "required": false }, { "value": "Tanzania, United Republic of", "type": "String", "displayName": "Tanzania, United Republic of", "required": false }, { "value": "Thailand", "type": "String", "displayName": "Thailand", "required": false }, { "value": "Timor-Leste", "type": "String", "displayName": "Timor-Leste", "required": false }, { "value": "Togo", "type": "String", "displayName": "Togo", "required": false }, { "value": "Tokelau", "type": "String", "displayName": "Tokelau", "required": false }, { "value": "Tonga", "type": "String", "displayName": "Tonga", "required": false }, { "value": "Trinidad and Tobago", "type": "String", "displayName": "Trinidad and Tobago", "required": false }, { "value": "Tunisia", "type": "String", "displayName": "Tunisia", "required": false }, { "value": "Turkey", "type": "String", "displayName": "Turkey", "required": false }, { "value": "Turkmenistan", "type": "String", "displayName": "Turkmenistan", "required": false }, { "value": "Turks and Caicos Islands", "type": "String", "displayName": "Turks and Caicos Islands", "required": false }, { "value": "Tuvalu", "type": "String", "displayName": "Tuvalu", "required": false }, { "value": "Uganda", "type": "String", "displayName": "Uganda", "required": false }, { "value": "Ukraine", "type": "String", "displayName": "Ukraine", "required": false }, { "value": "United Arab Emirates", "type": "String", "displayName": "United Arab Emirates", "required": false }, { "value": "United Kingdom", "type": "String", "displayName": "United Kingdom", "required": false }, { "value": "US Minor Outlying Islands", "type": "String", "displayName": "US Minor Outlying Islands", "required": false }, { "value": "Uruguay", "type": "String", "displayName": "Uruguay", "required": false }, { "value": "Uzbekistan", "type": "String", "displayName": "Uzbekistan", "required": false }, { "value": "Vanuatu", "type": "String", "displayName": "Vanuatu", "required": false }, { "value": "Vatican City State", "type": "String", "displayName": "Vatican City State", "required": false }, { "value": "Venezuela", "type": "String", "displayName": "Venezuela", "required": false }, { "value": "Vietnam", "type": "String", "displayName": "Vietnam", "required": false }, { "value": "Virgin Islands, British", "type": "String", "displayName": "Virgin Islands, British", "required": false }, { "value": "Virgin Islands, U.S", "type": "String", "displayName": "Virgin Islands, U.S", "required": false }, { "value": "Wallis and Futuna", "type": "String", "displayName": "Wallis and Futuna", "required": false }, { "value": "Western Sahara", "type": "String", "displayName": "Western Sahara", "required": false }, { "value": "Yemen", "type": "String", "displayName": "Yemen", "required": false }, { "value": "Zambia", "type": "String", "displayName": "Zambia", "required": false }, { "value": "Zimbabwe", "type": "String", "displayName": "Zimbabwe", "required": false } ], "required": false, "validation": { "warnings": [ { "field": "Addresses.Country", "details": "Required if TaxNumber is supplied" } ], "information": [] } } }, "required": false, "validation": { "warnings": [ { "field": "Addresses", "details": "If supplied, must contain only 1 address" }, { "field": "Addresses", "details": "If TaxNumber is supplied, an Address with a Country is required" } ], "information": [] } } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Supplier", "description": "A Supplier is a person or organisation that provides a product or service", "properties": { "supplierName": { "type": "String", "displayName": "Supplier Name", "description": "The name for the supplier, typically a company name", "required": true }, "contactName": { "type": "String", "displayName": "Contact Name", "description": "The name of the main contact for the supplier", "required": true }, "emailAddress": { "type": "String", "displayName": "Email Address", "description": "The preferred email address the supplier should be contacted on", "required": true }, "phone": { "type": "String", "displayName": "Phone", "description": "The preferred phone number the supplier should be contacted on", "required": true }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "A collection of addresses associated to the supplier", "properties": { "type": { "type": "String", "displayName": "Address Type", "description": "The type of the address", "required": true }, "line1": { "type": "String", "displayName": "Line 1", "description": "The first line of the address", "required": true }, "line2": { "type": "String", "displayName": "Line 2", "description": "The second line of the address", "required": true }, "city": { "type": "String", "displayName": "City", "description": "The third line of the address, or city", "required": true }, "region": { "type": "String", "displayName": "Region", "description": "The fourth line of the address, or region", "required": true }, "country": { "type": "String", "displayName": "Country", "description": "The country for the address", "required": true }, "postalCode": { "type": "String", "displayName": "Postal/Zip Code", "description": "The postal (or zip) code for the address", "required": true } }, "required": true }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "The supplier's registration number", "required": true }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "The supplier's tax number", "required": true }, "status": { "type": "String", "displayName": "Supplier Status", "description": "The current state of the supplier", "required": true }, "defaultCurrency": { "type": "String", "displayName": "Default Currency", "description": "The default currency for transactions recorded against the supplier", "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Suppliers", "description": "An accounts payable contact that supplies good or services, also referred to as a vendor.", "properties": { "supplierName": { "type": "String", "displayName": "Name", "description": "Name of the supplier.", "required": true }, "phone": { "type": "String", "displayName": "Phone", "description": "Main contact phone number for the supplier.", "required": false, "validation": { "warnings": [ { "field": "phone", "details": "Country, area, and number are space separated" } ], "information": [] } }, "emailAddress": { "type": "String", "displayName": "Email", "description": "Main contact email for the supplier.", "required": false }, "registrationNumber": { "type": "String", "displayName": "Registration Number", "description": "Legal company registration identifier.", "required": false, "validation": { "warnings": [ { "field": "registrationNumber", "details": "Max length of 50 characters" } ], "information": [] } }, "taxNumber": { "type": "String", "displayName": "Tax Number", "description": "Legal tax registration identifier.", "required": false }, "status": { "type": "String", "displayName": "Status", "description": "Status of the supplier account.", "options": [ { "value": "Active", "type": "String", "displayName": "Active", "required": false }, { "value": "InActive", "type": "String", "displayName": "Inactive", "required": false } ], "required": false }, "addresses": { "type": "Array", "displayName": "Addresses", "description": "Contact addresses for the supplier.", "properties": { "line1": { "type": "String", "displayName": "Address Line 1", "description": "First line of the address.", "required": false, "validation": { "warnings": [ { "field": "addresses.line1", "details": "Max length of 500 characters." } ], "information": [] } }, "line2": { "type": "String", "displayName": "Address Line 2", "description": "Second line of the address.", "required": false, "validation": { "warnings": [ { "field": "addresses.line2", "details": "Max length of 500 characters." } ], "information": [] } }, "city": { "type": "String", "displayName": "City", "description": "Local city for the address.", "required": false, "validation": { "warnings": [ { "field": "addresses.city", "details": "Max length of 255 characters." } ], "information": [] } }, "region": { "type": "String", "displayName": "Region", "description": "Region the address is located in.", "required": false, "validation": { "warnings": [ { "field": "addresses.region", "details": "Max length of 255 characters." } ], "information": [] } }, "country": { "type": "String", "displayName": "Country", "description": "Country for the address.", "required": false, "validation": { "warnings": [ { "field": "addresses.country", "details": "Max length of 50 characters." } ], "information": [] } }, "postalCode": { "type": "String", "displayName": "Postal code", "description": "Post or Zip code for the address.", "required": false, "validation": { "warnings": [ { "field": "addresses.postalCode", "details": "Only English alphabet characters are permitted." }, { "field": "addresses.postalCode", "details": "Max length of 50 characters." } ], "information": [] } }, "type": { "type": "String", "displayName": "Type", "description": "The type of address as it related to the supplier.", "options": [ { "value": "Billing", "type": "String", "displayName": "Billing Address", "required": false }, { "value": "Delivery", "type": "String", "displayName": "Delivery Address", "required": false } ], "required": true, "validation": { "warnings": [ { "field": "addresses.type", "details": "Billing = POBOX, Delivery/Unknown = DELIVERY" } ], "information": [] } } }, "required": false } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-update-suppliers-model", "description": "The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company and integration.\r\n\r\n[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n\r\n**Integration-specific behaviour**\r\n\r\nSee the *response examples* for integration-specific indicative models.\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating and updating a supplier.\r\n" } }, "/companies/{companyId}/connections/{connectionId}/push/suppliers": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Suppliers" ], "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Supplier" }, "examples": { "Sage Intacct": { "value": { "id": "73593", "supplierName": "test 20230420 1004", "contactName": "Joe Bloggs", "status": "Active" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSupplierResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Create supplier", "description": "The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company's connection.\r\n\r\n[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n\r\n**Integration-specific behaviour**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/accounting-api#/operations/get-create-update-suppliers-model).\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account.\r\n", "operationId": "create-supplier" } }, "/companies/{companyId}/connections/{connectionId}/push/suppliers/{supplierId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/supplierId" } ], "put": { "tags": [ "Suppliers" ], "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/forceUpdate" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Supplier" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSupplierResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Update supplier", "description": "The *Update supplier* endpoint updates an existing [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company's connection.\r\n\r\n[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n\r\n**Integration-specific behaviour**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/accounting-api#/operations/get-create-update-suppliers-model).\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating an account.\r\n", "operationId": "update-supplier" } }, "/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/supplierId" } ], "get": { "tags": [ "Suppliers" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentsDataset" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "List supplier attachments", "description": "The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`.\n\n[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support listing supplier attachments.\n", "operationId": "list-supplier-attachments" } }, "/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/supplierId" }, { "$ref": "#/components/parameters/attachmentId" } ], "get": { "tags": [ "Suppliers" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Get supplier attachment", "description": "The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`.\n\n[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a supplier attachment.\n", "operationId": "get-supplier-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}/download": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/supplierId" }, { "$ref": "#/components/parameters/attachmentId" } ], "get": { "tags": [ "Suppliers" ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "title": "Data", "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Download supplier attachment", "description": "The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`.\n\n[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support downloading a supplier attachment.\n", "operationId": "download-supplier-attachment" } }, "/companies/{companyId}/data/taxRates": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Tax rates" ], "summary": "List all tax rates", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRates" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "code": "110", "status": "Active", "effectiveTaxRate": 10, "totalTaxRate": 10, "components": [ { "name": "10%", "rate": 10, "isCompound": false } ], "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2023-10-06T13:04:00", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "31f5f7a5-cf8e-4452-9979-c8b43997a6f2", "name": "Sales Tax 15%", "code": "115", "status": "Active", "effectiveTaxRate": 15, "totalTaxRate": 15, "temp_IsAutomaticRate": false, "temp_IsTaxable": true, "components": [ { "name": "15%", "rate": 15, "isCompound": false } ], "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2024-01-20T13:04:00", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 5, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/taxRates" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/taxRates?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "code": " - ", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "-", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-03-27T14:21:18Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "DirectIncome.LineItems.TaxRateRef.Id" ] } ], "metadata": { "isDeleted": false } }, { "id": "1170560b-5519-ed11-90eb-00224800a11d", "name": "", "code": " - DOMESTIC", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "- DOMESTIC", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-03-27T14:21:18Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "DirectIncome.LineItems.TaxRateRef.Id" ] } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 21, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/taxRates" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/taxRates?page=2&pageSize=2" } } } }, "Exact (Netherlands)": { "value": { "results": [ { "id": "9b131726-71cc-432c-b7eb-8dd9f6a6c2b3", "name": "Geen BTW", "code": "0", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "0", "rate": 0, "isCompound": false } ], "modifiedDate": "2022-10-26T13:31:58Z", "sourceModifiedDate": "2019-10-22T14:09:25Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id", "CreditNote.LineItems.TaxRateRef.Id", "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ] }, { "id": "146106e9-85f7-46bc-bc90-4210cde500b9", "name": "Geen BTW", "code": "0-1", "status": "Active", "effectiveTaxRate": 15, "totalTaxRate": 15, "components": [ { "name": "0-1", "rate": 15, "isCompound": false } ], "modifiedDate": "2022-10-26T13:31:58Z", "sourceModifiedDate": "2022-07-21T09:54:15Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id", "CreditNote.LineItems.TaxRateRef.Id", "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 32, "_links": { "current": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/taxRates" }, "next": { "href": "/companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/taxRates?page=2&pageSize=2" } } } }, "Exact (UK)": { "value": { "results": [ { "id": "3b9b05b2-2a70-4750-88e8-5d35009175e5", "name": "UK sales VAT 0%", "code": "00", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "00", "rate": 0, "isCompound": false } ], "modifiedDate": "2022-10-26T13:33:07Z", "sourceModifiedDate": "2017-07-12T02:28:23Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id", "CreditNote.LineItems.TaxRateRef.Id" ] } ] }, { "id": "92c01056-0b5e-44f8-81df-83b6f2a41dbd", "name": "UK sales standard rate", "code": "01", "status": "Active", "effectiveTaxRate": 20, "totalTaxRate": 20, "components": [ { "name": "01", "rate": 20, "isCompound": false } ], "modifiedDate": "2022-10-26T13:33:07Z", "sourceModifiedDate": "2017-07-12T02:28:23Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id", "CreditNote.LineItems.TaxRateRef.Id" ] } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 22, "_links": { "current": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/taxRates" }, "next": { "href": "/companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/taxRates?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "1", "name": "VAT (20%)", "code": "1", "status": "Active", "effectiveTaxRate": 20, "totalTaxRate": 20, "components": [ { "name": "VAT (20%)", "rate": 20, "isCompound": false } ], "modifiedDate": "2023-04-25T14:19:11Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "2", "name": "VAT (5%)", "code": "2", "status": "Active", "effectiveTaxRate": 5, "totalTaxRate": 5, "components": [ { "name": "VAT (5%)", "rate": 5, "isCompound": false } ], "modifiedDate": "2023-04-25T14:19:11Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 3, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/taxRates" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/taxRates?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "19255", "name": "helloabdul", "code": "111", "status": "Active", "effectiveTaxRate": 32, "totalTaxRate": 32, "components": [ { "name": "helloabdul", "rate": 32, "isCompound": false } ], "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2021-02-11T09:05:45", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "19255-19257", "name": "helloabdul and hello2", "code": "111", "status": "Active", "effectiveTaxRate": 131, "totalTaxRate": 131, "components": [ { "name": "helloabdul", "rate": 32, "isCompound": false }, { "name": "hello2", "rate": 99, "isCompound": false } ], "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2021-02-25T07:27:36", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 105, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/taxRates" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/taxRates?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "209", "name": "<Not Used>", "code": ".", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "GST CA_E", "rate": 0, "isCompound": false }, { "name": "PST_CA_E", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-01-30T14:47:01Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id", "CreditNote.LineItems.TaxRateRef.Id", "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ] }, { "id": "208", "name": "CA-E", "code": "CA-E", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "GST CA_E", "rate": 0, "isCompound": false }, { "name": "PST_CA_E", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-01-30T14:47:01Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id", "CreditNote.LineItems.TaxRateRef.Id", "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 48, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/taxRates" }, "next": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/taxRates?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "20000-999022286", "name": "Non-Taxable Sales", "code": "Non", "status": "Active", "temp_IsTaxable": false, "components": [], "modifiedDate": "2023-04-26T09:12:08Z", "sourceModifiedDate": "2001-08-28T19:11:26", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "10000-999022286", "name": "Taxable Sales", "code": "Tax", "status": "Active", "temp_IsTaxable": true, "components": [], "modifiedDate": "2023-04-26T09:12:08Z", "sourceModifiedDate": "2001-08-28T19:11:26", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/taxRates" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "5_Bills", "name": "0.0% ECG Bills", "code": "0.0% ECG", "status": "Archived", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "ECPGZR", "rate": 0, "isCompound": false }, { "name": "ECZP", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-01-18T11:02:40Z", "sourceModifiedDate": "2019-05-18T10:17:57Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ] }, { "id": "5_Invoices", "name": "0.0% ECG Invoices", "code": "0.0% ECG", "status": "Archived", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "EGS-ECGS", "rate": 0, "isCompound": false }, { "name": "EGS-ECSS", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-01-18T11:02:40Z", "sourceModifiedDate": "2019-05-18T10:17:57Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id" ] } ] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 87, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/taxRates" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/taxRates?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "5_Bills", "name": "0.0% ECG Bills", "code": "0.0% ECG", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "ECZP", "rate": 0, "isCompound": false }, { "name": "ECPGZR", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-04-26T09:35:58Z", "sourceModifiedDate": "2016-09-08T21:12:44Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ], "metadata": { "isDeleted": false } }, { "id": "5_Invoices", "name": "0.0% ECG Invoices", "code": "0.0% ECG", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "EGS-ECGS", "rate": 0, "isCompound": false }, { "name": "EGS-ECSS", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-04-26T09:35:58Z", "sourceModifiedDate": "2016-09-08T21:12:44Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id" ] } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 35, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/taxRates" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/taxRates?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "1728", "name": "Zero rated", "code": "0", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "Zero rated", "rate": 0, "isCompound": false } ], "modifiedDate": "2022-10-14T09:35:51Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "validDatatypeLinks": [] }, { "id": "1729", "name": "Standard rate", "code": "1", "status": "Active", "effectiveTaxRate": 20, "totalTaxRate": 20, "components": [ { "name": "Standard rate", "rate": 20, "isCompound": false } ], "modifiedDate": "2022-10-14T09:35:51Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 19, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/taxRates" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/taxRates?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "0", "name": "Zero rated", "code": "T0", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "T0", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-03-30T14:42:37Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "1", "name": "Standard rate", "code": "T1", "status": "Active", "effectiveTaxRate": 20, "totalTaxRate": 20, "components": [ { "name": "T1", "rate": 20, "isCompound": false } ], "modifiedDate": "2023-03-30T14:42:37Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 21, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/taxRates" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/taxRates?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "GB_EXEMPT", "name": "Exempt 0.00%", "code": "EXEMPT", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "Exempt 0.00%", "rate": 0, "isCompound": false } ], "modifiedDate": "2022-10-24T14:52:49Z", "sourceModifiedDate": "2021-07-01T16:49:32Z", "validDatatypeLinks": [] }, { "id": "GB_LOWER", "name": "Lower Rate 5.00%", "code": "LOWER", "status": "Active", "effectiveTaxRate": 5, "totalTaxRate": 5, "components": [ { "name": "Lower Rate 5.00%", "rate": 5, "isCompound": false } ], "modifiedDate": "2022-10-24T14:52:49Z", "sourceModifiedDate": "2021-07-01T16:49:32Z", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 5, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/taxRates" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/data/taxRates?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "109", "name": "Devbox test tax detail", "code": "DevboxTax", "status": "Active", "effectiveTaxRate": 5, "totalTaxRate": 5, "components": [ { "name": "Devbox test tax detail", "rate": 5, "isCompound": false } ], "modifiedDate": "2023-04-04T16:31:30Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } }, { "id": "44", "name": "EC Purchase Goods Exempt Rate", "code": "EC Purchase Goods Exempt Rate", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [], "modifiedDate": "2023-04-04T16:31:30Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 66, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/taxRates" }, "next": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/taxRates?page=2&pageSize=2" } } } }, "Wave": { "value": { "results": [ { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1NhbGVzVGF4OjE2NjUyNTc5ODU=", "name": "Abdul's new Tax", "code": "ANT", "status": "Active", "effectiveTaxRate": 11, "totalTaxRate": 11, "components": [ { "name": "Abdul's new Tax", "rate": 11, "isCompound": true } ], "modifiedDate": "2022-11-16T18:15:25Z", "validDatatypeLinks": [] }, { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1NhbGVzVGF4OjE1NDA5NjM0Mzg=", "name": "FederalABC", "code": "FederalABC", "status": "Active", "effectiveTaxRate": 5, "totalTaxRate": 5, "components": [ { "name": "FederalABC", "rate": 5, "isCompound": false } ], "modifiedDate": "2022-11-16T18:15:25Z", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 4, "_links": { "current": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/taxRates" }, "next": { "href": "/companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/taxRates?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "ECACQUISITIONS", "name": "EC Acquisitions (20%)", "code": "ECACQUISITIONS", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "VAT", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-03-15T20:35:09Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id", "CreditNote.LineItems.TaxRateRef.Id", "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ], "metadata": { "isDeleted": false } }, { "id": "ECZRACQUISITIONS", "name": "EC Acquisitions (Zero Rated)", "code": "ECZRACQUISITIONS", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "VAT", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-03-15T20:35:09Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id", "CreditNote.LineItems.TaxRateRef.Id", "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ], "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 17, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/taxRates" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/taxRates?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000033027", "name": "Standard Rate", "code": "104957000000033027", "status": "Active", "effectiveTaxRate": 20, "totalTaxRate": 20, "components": [ { "name": "Standard Rate", "rate": 20, "isCompound": false } ], "modifiedDate": "2022-10-03T08:40:37Z", "validDatatypeLinks": [] }, { "id": "104957000000033031", "name": "Reduced Rate", "code": "104957000000033031", "status": "Active", "effectiveTaxRate": 5, "totalTaxRate": 5, "components": [ { "name": "Reduced Rate", "rate": 5, "isCompound": false } ], "modifiedDate": "2022-10-03T08:40:37Z", "validDatatypeLinks": [] } ], "pageNumber": 1, "pageSize": 2, "totalResults": 6, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/taxRates?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/taxRates" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/taxRates?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List tax rates* endpoint returns a list of [tax rates](https://docs.codat.io/accounting-api#/schemas/TaxRate) for a given company's connection.\n\n[Tax rates](https://docs.codat.io/accounting-api#/schemas/TaxRate) are a set of taxes and associated rates within the SMB's accounting software.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-tax-rates" } }, "/companies/{companyId}/data/taxRates/{taxRateId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/taxRateId" } ], "get": { "tags": [ "Tax rates" ], "summary": "Get tax rate", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRate" }, "examples": { "Clear Books": { "value": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "Sales Tax (10%)", "code": "110", "status": "Active", "effectiveTaxRate": 10, "totalTaxRate": 10, "components": [ { "name": "10%", "rate": 10, "isCompound": false } ], "modifiedDate": "2023-04-26T12:38:17Z", "sourceModifiedDate": "2023-10-06T13:04:00", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "cc81fea8-2917-ed11-90eb-002248009df3", "name": "", "code": " - ", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "-", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-03-27T14:21:18Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "DirectIncome.LineItems.TaxRateRef.Id" ] } ], "metadata": { "isDeleted": false } } }, "Exact (Netherlands)": { "value": { "id": "9b131726-71cc-432c-b7eb-8dd9f6a6c2b3", "name": "Geen BTW", "code": "0", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "0", "rate": 0, "isCompound": false } ], "modifiedDate": "2022-10-26T13:31:58Z", "sourceModifiedDate": "2019-10-22T14:09:25Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id", "CreditNote.LineItems.TaxRateRef.Id", "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ] } }, "Exact (UK)": { "value": { "id": "3b9b05b2-2a70-4750-88e8-5d35009175e5", "name": "UK sales VAT 0%", "code": "00", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "00", "rate": 0, "isCompound": false } ], "modifiedDate": "2022-10-26T13:33:07Z", "sourceModifiedDate": "2017-07-12T02:28:23Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id", "CreditNote.LineItems.TaxRateRef.Id" ] } ] } }, "FreeAgent": { "value": { "id": "1", "name": "VAT (20%)", "code": "1", "status": "Active", "effectiveTaxRate": 20, "totalTaxRate": 20, "components": [ { "name": "VAT (20%)", "rate": 20, "isCompound": false } ], "modifiedDate": "2023-04-25T14:19:11Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } }, "FreshBooks": { "value": { "id": "19255", "name": "helloabdul", "code": "111", "status": "Active", "effectiveTaxRate": 32, "totalTaxRate": 32, "components": [ { "name": "helloabdul", "rate": 32, "isCompound": false } ], "modifiedDate": "2023-03-24T16:07:23Z", "sourceModifiedDate": "2021-02-11T09:05:45", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } }, "Oracle NetSuite": { "value": { "id": "209", "name": "<Not Used>", "code": ".", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "GST CA_E", "rate": 0, "isCompound": false }, { "name": "PST_CA_E", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-01-30T14:47:01Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id", "CreditNote.LineItems.TaxRateRef.Id", "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ] } }, "QuickBooks Desktop": { "value": { "id": "20000-999022286", "name": "Non-Taxable Sales", "code": "Non", "status": "Active", "temp_IsTaxable": false, "components": [], "modifiedDate": "2023-04-26T09:12:08Z", "sourceModifiedDate": "2001-08-28T19:11:26", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "5_Bills", "name": "0.0% ECG Bills", "code": "0.0% ECG", "status": "Archived", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "ECPGZR", "rate": 0, "isCompound": false }, { "name": "ECZP", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-01-18T11:02:40Z", "sourceModifiedDate": "2019-05-18T10:17:57Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ] } }, "QuickBooks Online Sandbox": { "value": { "id": "5_Bills", "name": "0.0% ECG Bills", "code": "0.0% ECG", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "ECZP", "rate": 0, "isCompound": false }, { "name": "ECPGZR", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-04-26T09:35:58Z", "sourceModifiedDate": "2016-09-08T21:12:44Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ], "metadata": { "isDeleted": false } } }, "Sage 200cloud": { "value": { "id": "1728", "name": "Zero rated", "code": "0", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "Zero rated", "rate": 0, "isCompound": false } ], "modifiedDate": "2022-10-14T09:35:51Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "validDatatypeLinks": [] } }, "Sage 50 (UK)": { "value": { "id": "0", "name": "Zero rated", "code": "T0", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "T0", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-03-30T14:42:37Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } }, "Sage Business Cloud Accounting": { "value": { "id": "GB_EXEMPT", "name": "Exempt 0.00%", "code": "EXEMPT", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "Exempt 0.00%", "rate": 0, "isCompound": false } ], "modifiedDate": "2022-10-24T14:52:49Z", "sourceModifiedDate": "2021-07-01T16:49:32Z", "validDatatypeLinks": [] } }, "Sage Intacct": { "value": { "id": "109", "name": "Devbox test tax detail", "code": "DevboxTax", "status": "Active", "effectiveTaxRate": 5, "totalTaxRate": 5, "components": [ { "name": "Devbox test tax detail", "rate": 5, "isCompound": false } ], "modifiedDate": "2023-04-04T16:31:30Z", "validDatatypeLinks": [], "metadata": { "isDeleted": false } } }, "Wave": { "value": { "id": "QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1NhbGVzVGF4OjE2NjUyNTc5ODU=", "name": "Abdul's new Tax", "code": "ANT", "status": "Active", "effectiveTaxRate": 11, "totalTaxRate": 11, "components": [ { "name": "Abdul's new Tax", "rate": 11, "isCompound": true } ], "modifiedDate": "2022-11-16T18:15:25Z", "validDatatypeLinks": [] } }, "Xero": { "value": { "id": "ECACQUISITIONS", "name": "EC Acquisitions (20%)", "code": "ECACQUISITIONS", "status": "Active", "effectiveTaxRate": 0, "totalTaxRate": 0, "components": [ { "name": "VAT", "rate": 0, "isCompound": false } ], "modifiedDate": "2023-03-15T20:35:09Z", "validDatatypeLinks": [ { "property": "Id", "links": [ "Invoice.LineItems.TaxRateRef.Id", "CreditNote.LineItems.TaxRateRef.Id", "Bill.LineItems.TaxRateRef.Id", "BillCreditNote.LineItems.TaxRateRef.Id" ] } ], "metadata": { "isDeleted": false } } }, "Zoho Books": { "value": { "id": "104957000000033027", "name": "Standard Rate", "code": "104957000000033027", "status": "Active", "effectiveTaxRate": 20, "totalTaxRate": 20, "components": [ { "name": "Standard Rate", "rate": 20, "isCompound": false } ], "modifiedDate": "2022-10-03T08:40:37Z", "validDatatypeLinks": [] } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get tax rate* endpoint returns a single tax rate for a given taxRateId.\n\n[Tax rates](https://docs.codat.io/accounting-api#/schemas/TaxRate) are a set of taxes and associated rates within the SMB's accounting software.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=taxRates) for integrations that support getting a specific tax rate.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-tax-rate" } }, "/companies/{companyId}/data/trackingCategories": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Tracking categories" ], "summary": "List tracking categories", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackingCategories" }, "examples": { "Dynamics 365 Business Central": { "value": { "results": [ { "id": "9e1dea89-1e34-ed11-97e8-000d3a872db9", "parentId": "d1391864-77cf-eb11-9f0a-0022481b404b", "modifiedDate": "2023-03-27T14:21:18Z", "sourceModifiedDate": "2022-09-14T11:19:28Z", "name": "A-000-A-Hundreds", "hasChildren": false, "status": "Active" }, { "id": "ffc4c780-77cf-eb11-9f0a-0022481b404b", "parentId": "d1391864-77cf-eb11-9f0a-0022481b404b", "modifiedDate": "2023-03-27T14:21:18Z", "sourceModifiedDate": "2021-06-17T14:25:28Z", "name": "A-100-A-100 Name", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 36, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/trackingCategories" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/trackingCategories?page=2&pageSize=2" } } } }, "FreshBooks": { "value": { "results": [ { "id": "5389667", "parentId": "4370491", "modifiedDate": "2023-03-24T16:07:24Z", "sourceModifiedDate": "2021-05-19T11:09:40", "name": "ABCustomCategory", "hasChildren": false, "status": "Active" }, { "id": "4370499", "parentId": "4370496", "modifiedDate": "2023-03-24T16:07:24Z", "sourceModifiedDate": "2021-07-26T09:42:18", "name": "Accident Insurance", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 82, "_links": { "current": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/trackingCategories" }, "next": { "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/trackingCategories?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "CostEstimateType-AVGCOST", "modifiedDate": "2023-01-30T14:46:52Z", "name": "Average Cost", "hasChildren": false, "status": "Active" }, { "id": "classification-1", "modifiedDate": "2023-01-30T14:46:52Z", "sourceModifiedDate": "2022-11-17T11:47:34", "name": "Class 1", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 18, "_links": { "current": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/trackingCategories" }, "next": { "href": "/companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/trackingCategories?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "80000008-1734278594", "modifiedDate": "2023-04-26T09:12:46Z", "sourceModifiedDate": "2024-12-15T16:03:14", "name": "ClassWithSub", "hasChildren": true, "status": "Active" }, { "id": "8000000A-1734278615", "modifiedDate": "2023-04-26T09:12:46Z", "sourceModifiedDate": "2024-12-15T16:09:02", "name": "Incative", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 6, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/trackingCategories" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/trackingCategories?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "CLASS_5100000000000014491", "parentId": "CLASSES", "modifiedDate": "2023-04-26T09:35:57Z", "sourceModifiedDate": "2022-03-07T08:28:32Z", "name": "A", "hasChildren": false, "status": "Active" }, { "id": "CLASS_200200000000000009374", "parentId": "CLASSES", "modifiedDate": "2023-04-26T09:35:57Z", "sourceModifiedDate": "2016-11-04T09:28:00Z", "name": "Australia (deleted)", "hasChildren": false, "status": "Archived" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 23, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/trackingCategories" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/trackingCategories?page=2&pageSize=2" } } } }, "Sage 200cloud": { "value": { "results": [ { "id": "__DEPARTMENTS/3", "parentId": "__DEPARTMENTS", "modifiedDate": "2022-10-14T09:35:52Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "name": "Accounts", "hasChildren": false, "status": "Active" }, { "id": "__DEPARTMENTS/4", "parentId": "__DEPARTMENTS", "modifiedDate": "2022-10-14T09:35:52Z", "sourceModifiedDate": "2020-02-28T14:23:46Z", "name": "Admin", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 24, "_links": { "current": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/trackingCategories" }, "next": { "href": "/companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/trackingCategories?page=2&pageSize=2" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "department_10", "parentId": "DEPARTMENTS", "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "name": "", "hasChildren": false, "status": "Active" }, { "id": "department_100", "parentId": "DEPARTMENTS", "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "name": "", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 1022, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/trackingCategories" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/trackingCategories?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "department_0", "modifiedDate": "2022-07-27T17:41:22Z", "sourceModifiedDate": "2022-03-22T15:33:21", "name": "BallparkContracting", "hasChildren": false, "status": "Active" }, { "id": "department_1", "modifiedDate": "2022-07-27T17:41:22Z", "sourceModifiedDate": "2021-06-23T15:33:21", "name": "BaseMountainConstruction", "hasChildren": true, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 15, "_links": { "current": { "href": "/companies/f4aae110-ca17-4cd4-8aaa-a3136b1cf0b1/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/f4aae110-ca17-4cd4-8aaa-a3136b1cf0b1/data/trackingCategories" }, "next": { "href": "/companies/f4aae110-ca17-4cd4-8aaa-a3136b1cf0b1/data/trackingCategories?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "WAREHOUSE-2", "parentId": "WAREHOUSE", "modifiedDate": "2023-04-04T16:32:02Z", "sourceModifiedDate": "2020-04-26T05:26:46", "name": "200", "hasChildren": false, "status": "Active" }, { "id": "WAREHOUSE-3", "parentId": "WAREHOUSE", "modifiedDate": "2023-04-04T16:32:02Z", "sourceModifiedDate": "2021-08-10T13:41:01", "name": "300", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 757, "_links": { "current": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/trackingCategories" }, "next": { "href": "/companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/trackingCategories?page=2&pageSize=2" } } } }, "Xero": { "value": { "results": [ { "id": "dba3d4da-f9ed-4eee-8e0b-452d11fdb1fa", "parentId": "9d8ad8f6-0d0f-41e0-8851-ef47e8b54ae6", "modifiedDate": "2023-03-15T20:37:11Z", "name": "Eastside", "hasChildren": false, "status": "Active" }, { "id": "34b9b859-07a9-451a-b4d3-effc9946634a", "parentId": "9d8ad8f6-0d0f-41e0-8851-ef47e8b54ae6", "modifiedDate": "2023-03-15T20:37:11Z", "name": "North", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 5, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/trackingCategories" }, "next": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/data/trackingCategories?page=2&pageSize=2" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000000323-104957000001510028", "parentId": "104957000000000323", "modifiedDate": "2022-10-03T08:40:39Z", "name": "Down", "hasChildren": false, "status": "Active" }, { "id": "104957000000000323-104957000001510024", "parentId": "104957000000000323", "modifiedDate": "2022-10-03T08:40:39Z", "name": "East", "hasChildren": false, "status": "Active" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 11, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/trackingCategories?page=1&pageSize=2" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/trackingCategories" }, "next": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/trackingCategories?page=2&pageSize=2" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List tracking categories* endpoint returns a list of [tracking categories](https://docs.codat.io/accounting-api#/schemas/TrackingCategory) for a given company's connection.\n\n[Tracking categories](https://docs.codat.io/accounting-api#/schemas/TrackingCategory) are used to monitor cost centres and control budgets that sit outside the standard set of accounts.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-tracking-categories" } }, "/companies/{companyId}/data/trackingCategories/{trackingCategoryId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/trackingCategoryId" } ], "get": { "tags": [ "Tracking categories" ], "summary": "Get tracking categories", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackingCategoryTree" }, "examples": { "Dynamics 365 Business Central": { "value": { "subCategories": [], "id": "9e1dea89-1e34-ed11-97e8-000d3a872db9", "parentId": "d1391864-77cf-eb11-9f0a-0022481b404b", "modifiedDate": "2023-03-27T14:21:18Z", "sourceModifiedDate": "2022-09-14T11:19:28Z", "name": "A-000-A-Hundreds", "hasChildren": false, "status": "Active" } }, "FreshBooks": { "value": { "subCategories": [], "id": "5389667", "parentId": "4370491", "modifiedDate": "2023-03-24T16:07:24Z", "sourceModifiedDate": "2021-05-19T11:09:40", "name": "ABCustomCategory", "hasChildren": false, "status": "Active" } }, "Oracle NetSuite": { "value": { "subCategories": [], "id": "CostEstimateType-AVGCOST", "modifiedDate": "2023-01-30T14:46:52Z", "name": "Average Cost", "hasChildren": false, "status": "Active" } }, "QuickBooks Desktop": { "value": { "subCategories": [ { "subCategories": [], "id": "80000009-1734278606", "parentId": "80000008-1734278594", "modifiedDate": "2023-04-26T09:12:46", "sourceModifiedDate": "2024-12-15T16:03:26", "name": "Subclass", "hasChildren": false, "status": "Active" } ], "id": "80000008-1734278594", "modifiedDate": "2023-04-26T09:12:46Z", "sourceModifiedDate": "2024-12-15T16:03:14", "name": "ClassWithSub", "hasChildren": true, "status": "Active" } }, "QuickBooks Online Sandbox": { "value": { "subCategories": [], "id": "CLASS_5100000000000014491", "parentId": "CLASSES", "modifiedDate": "2023-04-26T09:35:57Z", "sourceModifiedDate": "2022-03-07T08:28:32Z", "name": "A", "hasChildren": false, "status": "Active" } }, "Sage 50 (UK)": { "value": { "subCategories": [], "id": "department_10", "parentId": "DEPARTMENTS", "modifiedDate": "2023-03-30T14:42:37Z", "sourceModifiedDate": "2022-11-25T09:43:54", "name": "", "hasChildren": false, "status": "Active" } }, "Sage Business Cloud Accounting": { "value": { "subCategories": [], "id": "department_0", "modifiedDate": "2022-07-27T17:41:22Z", "sourceModifiedDate": "2022-03-22T15:33:21", "name": "BallparkContracting", "hasChildren": false, "status": "Active" } }, "Sage Intacct": { "value": { "subCategories": [], "id": "WAREHOUSE-2", "parentId": "WAREHOUSE", "modifiedDate": "2023-04-04T16:32:02Z", "sourceModifiedDate": "2020-04-26T05:26:46", "name": "200", "hasChildren": false, "status": "Active" } }, "Xero": { "value": { "subCategories": [], "id": "dba3d4da-f9ed-4eee-8e0b-452d11fdb1fa", "parentId": "9d8ad8f6-0d0f-41e0-8851-ef47e8b54ae6", "modifiedDate": "2023-03-15T20:37:11Z", "name": "Eastside", "hasChildren": false, "status": "Active" } }, "Zoho Books": { "value": { "subCategories": [], "id": "104957000000000323-104957000001510028", "parentId": "104957000000000323", "modifiedDate": "2022-10-03T08:40:39Z", "name": "Down", "hasChildren": false, "status": "Active" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get tracking category* endpoint returns a single tracking category for a given trackingCategoryId.\n\n[Tracking categories](https://docs.codat.io/accounting-api#/schemas/TrackingCategory) are used to monitor cost centres and control budgets that sit outside the standard set of accounts.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=trackingCategories) for integrations that support getting a specific tracking category.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-tracking-category" } }, "/companies/{companyId}/connections/{connectionId}/data/transfers": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "tags": [ "Transfers" ], "summary": "List transfers", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transfers" }, "examples": { "Clear Books": { "value": { "results": [ { "id": "0bd2f801-6f02-44d6-a2ab-5431553d16f9", "description": "depositing 16531.08 into Current Account", "contactRef": { "id": "e4baf949-cb1d-4341-8452-200a93baa3fa", "dataType": "customers" }, "date": "2022-04-25T07:20:00", "from": { "accountRef": { "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 16531.08, "status": "Unknown" }, "to": { "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 16531.08, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [ { "id": "fc253cca-0dfe-46e8-b75f-c7fb3db760b2", "dataType": "directIncomes" } ], "modifiedDate": "2023-04-26T12:38:18", "sourceModifiedDate": "2022-04-25T07:20:00", "metadata": { "isDeleted": false } }, { "id": "78373000-29e1-4ef4-a2e6-9b573ed656e4", "description": "depositing 188.33 into Current Account", "contactRef": { "id": "51f03576-f6b0-40d5-9fba-81a490411c03", "dataType": "customers" }, "date": "2022-04-25T07:20:00", "from": { "accountRef": { "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 188.33, "status": "Unknown" }, "to": { "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 188.33, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [ { "id": "38e8c917-0afc-4583-8ffe-1b53ad601197", "dataType": "directIncomes" } ], "modifiedDate": "2023-04-26T12:38:18", "sourceModifiedDate": "2022-04-25T07:20:00", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 357, "_links": { "current": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=1&pageSize=2" }, "self": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers" }, "next": { "href": "/companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=2&pageSize=2" } } } }, "Dynamics 365 Business Central": { "value": { "results": [ { "id": "G00001", "date": "2020-11-26T00:00:00", "from": { "accountRef": { "id": "cf1417b3-89d1-ea11-bbaa-000d3a2b9185", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 20, "status": "Unknown" }, "to": { "accountRef": { "id": "ce1417b3-89d1-ea11-bbaa-000d3a2b9185", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 20, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2023-03-27T14:21:26", "sourceModifiedDate": "2020-11-26T12:16:44Z", "metadata": { "isDeleted": false } }, { "id": "TST-001", "date": "2022-10-25T00:00:00", "from": { "accountRef": { "id": "8277672c-b8e6-ec11-82f8-0022481a77f0", "dataType": "bankAccounts" }, "currency": "USD", "amount": 3.6, "status": "Unknown" }, "to": { "accountRef": { "id": "8982e7d8-cb19-eb11-bbf9-0022481ad2f4", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 2.34, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2023-03-27T14:21:26", "sourceModifiedDate": "2022-10-25T15:47:48Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 10, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=1&pageSize=2" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers" }, "next": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=2&pageSize=2" } } } }, "FreeAgent": { "value": { "results": [ { "id": "307335275", "description": "Transfer from Savings Account to Freeagent Test12", "date": "2018-06-14T00:00:00", "from": { "accountRef": { "id": "532100", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 0.69, "status": "Unknown" }, "to": { "accountRef": { "id": "708504", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 0.69, "status": "Unknown" }, "trackingCategoryRefs": [ { "id": "761" } ], "depositedRecordRefs": [], "modifiedDate": "2023-04-25T14:21:36", "sourceModifiedDate": "2022-03-23T15:55:58Z", "metadata": { "isDeleted": false } }, { "id": "308682395", "description": "Transfer from Business Current Account to Nic Test11", "date": "2019-12-23T00:00:00", "from": { "accountRef": { "id": "469976", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 250, "status": "Unknown" }, "to": { "accountRef": { "id": "691393", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 250, "status": "Unknown" }, "trackingCategoryRefs": [ { "id": "761" } ], "depositedRecordRefs": [], "modifiedDate": "2023-04-25T14:21:36", "sourceModifiedDate": "2022-03-31T16:09:27Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 99, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=1&pageSize=2" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=2&pageSize=2" } } } }, "Oracle NetSuite": { "value": { "results": [ { "id": "2-1", "contactRef": { "id": "417", "dataType": "customers" }, "date": "2021-03-10T00:00:00", "from": { "accountRef": { "id": "122", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 90, "status": "Unknown" }, "to": { "accountRef": { "id": "513", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 90, "status": "Unknown" }, "trackingCategoryRefs": [ { "id": "location-1" } ], "depositedRecordRefs": [ { "id": "428", "dataType": "payments" } ], "modifiedDate": "2022-09-20T08:16:26", "sourceModifiedDate": "2022-04-28T13:36:47" }, { "id": "2-11822", "contactRef": { "id": "417", "dataType": "customers" }, "date": "2022-04-28T00:00:00", "from": { "accountRef": { "id": "513", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 1200, "status": "Unknown" }, "to": { "accountRef": { "id": "122", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 1200, "status": "Unknown" }, "trackingCategoryRefs": [ { "id": "location-1" } ], "depositedRecordRefs": [ { "id": "7526", "dataType": "payments" } ], "modifiedDate": "2022-09-20T08:16:26", "sourceModifiedDate": "2022-04-28T14:14:33" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 47, "_links": { "current": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=1&pageSize=2" }, "self": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers" }, "next": { "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=2&pageSize=2" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "4B1-933288922", "description": "Funds Transfer", "date": "2024-10-14T00:00:00", "from": { "accountRef": { "id": "30000-933270541", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 15000, "status": "Unknown" }, "to": { "accountRef": { "id": "20000-933270541", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 15000, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2023-04-26T09:13:45", "sourceModifiedDate": "2023-12-16T05:03:58", "metadata": { "isDeleted": false } }, { "id": "C2A-933780606", "description": "Funds Transfer", "date": "2024-11-25T00:00:00", "from": { "accountRef": { "id": "20000-933270541", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 42300, "status": "Unknown" }, "to": { "accountRef": { "id": "30000-933270541", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 42300, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2023-04-26T09:13:45", "sourceModifiedDate": "2023-12-16T05:04:07", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 4, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=1&pageSize=2" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=2&pageSize=2" } } } }, "QuickBooks Online Sandbox": { "value": { "results": [ { "id": "646", "date": "2020-08-21T00:00:00", "from": { "accountRef": { "id": "102", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 73.41, "status": "Unknown" }, "to": { "accountRef": { "id": "108", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 73.41, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2023-04-26T09:36:33", "sourceModifiedDate": "2020-08-26T11:41:20Z", "metadata": { "isDeleted": false } }, { "id": "678", "date": "2020-08-22T00:00:00", "from": { "accountRef": { "id": "124", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 66.66, "status": "Unknown" }, "to": { "accountRef": { "id": "109", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 66.66, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2023-04-26T09:36:33", "sourceModifiedDate": "2020-08-29T00:01:20Z", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 442, "_links": { "current": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=1&pageSize=2" }, "self": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers" }, "next": { "href": "/companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=2&pageSize=2" } } } }, "QuickBooks Online": { "value": { "results": [ { "id": "1881", "date": "2020-08-29T00:00:00", "from": { "accountRef": { "id": "60", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 86.19, "status": "Unknown" }, "to": { "accountRef": { "id": "61", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 86.19, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2023-01-18T11:03:00", "sourceModifiedDate": "2020-09-03T11:19:54Z" }, { "id": "1885", "date": "2020-09-02T00:00:00", "from": { "accountRef": { "id": "60", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 45.73, "status": "Unknown" }, "to": { "accountRef": { "id": "61", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 45.73, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2023-01-18T11:03:00", "sourceModifiedDate": "2020-09-03T11:23:44Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 18, "_links": { "current": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=1&pageSize=2" }, "self": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers" }, "next": { "href": "/companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=2&pageSize=2" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "434bce57215a11e8b45c025132dab352", "description": "Some cheque", "date": "2018-03-06T00:00:00", "from": { "accountRef": { "id": "9a3f0ed6267a11e797950a57719b2edb", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 1000, "status": "Unknown" }, "to": { "accountRef": { "id": "9a2c3770267a11e797950a57719b2edb", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 1000, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2022-10-24T14:54:11", "sourceModifiedDate": "2018-03-06T16:20:19Z" }, { "id": "73d909a4215a11e8b45c025132dab352", "description": "Some cash", "date": "2018-03-06T00:00:00", "from": { "accountRef": { "id": "9a3f0ed6267a11e797950a57719b2edb", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 465, "status": "Unknown" }, "to": { "accountRef": { "id": "9a2c3770267a11e797950a57719b2edb", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 465, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2022-10-24T14:54:11", "sourceModifiedDate": "2018-03-06T16:21:40Z" } ], "pageNumber": 1, "pageSize": 2, "totalResults": 646, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=1&pageSize=2" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers" }, "next": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=2&pageSize=2" } } } }, "Sage Intacct": { "value": { "results": [ { "id": "4844", "description": "Description", "date": "2022-03-10T00:00:00", "from": { "accountRef": { "id": "CHECKINGACCOUNT:12", "dataType": "bankAccounts" }, "currency": "ZAR", "amount": 418.27, "status": "Unknown" }, "to": { "accountRef": { "id": "CHECKINGACCOUNT:9", "dataType": "bankAccounts" }, "currency": "CAD", "amount": 35.45, "status": "Unknown" }, "trackingCategoryRefs": [ { "id": "LOCATION-10", "name": "South Africa" } ], "depositedRecordRefs": [], "modifiedDate": "2023-02-23T14:18:48", "sourceModifiedDate": "2022-03-10T12:38:23", "metadata": { "isDeleted": false } }, { "id": "18828", "description": "From bank account '700_CHK' to bank account 'Test Savings Account'", "date": "2022-10-05T00:00:00", "from": { "accountRef": { "id": "CHECKINGACCOUNT:12", "dataType": "bankAccounts" }, "currency": "ZAR", "amount": 4040.62, "status": "Unknown" }, "to": { "accountRef": { "id": "SAVINGSACCOUNT:17", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 200, "status": "Unknown" }, "trackingCategoryRefs": [ { "id": "LOCATION-10", "name": "South Africa" } ], "depositedRecordRefs": [], "modifiedDate": "2023-02-23T14:18:48", "sourceModifiedDate": "2022-10-05T15:28:15", "metadata": { "isDeleted": false } } ], "pageNumber": 1, "pageSize": 2, "totalResults": 2, "_links": { "current": { "href": "/companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers?page=1&pageSize=2" }, "self": { "href": "/companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company's connection.\n\n[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-transfers" } }, "/companies/{companyId}/connections/{connectionId}/push/transfers/{transferId}/attachment": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/transferId" } ], "post": { "tags": [ "Transfers" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AttachmentUpload" } } } }, "responses": { "200": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "summary": "Upload transfer attachment", "description": "The *Upload transfer attachment* endpoint uploads an attachment and assigns it against a specific `transferId`.\n\n[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) are issued by a supplier for the purpose of recording transfer.\n\n**Integration-specific behaviour**\n\nFor more details on supported file types by integration see [Attachments](https://docs.codat.io/accounting-api#/schemas/Attachment).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support uploading a transfer attachment.\n", "operationId": "upload-transfer-attachment" } }, "/companies/{companyId}/connections/{connectionId}/data/transfers/{transferId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/transferId" } ], "get": { "tags": [ "Transfers" ], "summary": "Get transfer", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transfer" }, "examples": { "Clear Books": { "value": { "id": "0bd2f801-6f02-44d6-a2ab-5431553d16f9", "description": "depositing 16531.08 into Current Account", "contactRef": { "id": "e4baf949-cb1d-4341-8452-200a93baa3fa", "dataType": "customers" }, "date": "2022-04-25T07:20:00", "from": { "accountRef": { "id": "ff8fdc4c-2aad-4ec1-9430-6bd201832eb3", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 16531.08, "status": "Unknown" }, "to": { "accountRef": { "id": "dbcaf288-2b39-4b95-8ab3-42202ab15918", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 16531.08, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [ { "id": "fc253cca-0dfe-46e8-b75f-c7fb3db760b2", "dataType": "directIncomes" } ], "modifiedDate": "2023-04-26T12:38:18", "sourceModifiedDate": "2022-04-25T07:20:00", "metadata": { "isDeleted": false } } }, "Dynamics 365 Business Central": { "value": { "id": "G00001", "date": "2020-11-26T00:00:00", "from": { "accountRef": { "id": "cf1417b3-89d1-ea11-bbaa-000d3a2b9185", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 20, "status": "Unknown" }, "to": { "accountRef": { "id": "ce1417b3-89d1-ea11-bbaa-000d3a2b9185", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 20, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2023-03-27T14:21:26", "sourceModifiedDate": "2020-11-26T12:16:44Z", "metadata": { "isDeleted": false } } }, "FreeAgent": { "value": { "id": "307335275", "description": "Transfer from Savings Account to Freeagent Test12", "date": "2018-06-14T00:00:00", "from": { "accountRef": { "id": "532100", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 0.69, "status": "Unknown" }, "to": { "accountRef": { "id": "708504", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 0.69, "status": "Unknown" }, "trackingCategoryRefs": [ { "id": "761" } ], "depositedRecordRefs": [], "modifiedDate": "2023-04-25T14:21:36", "sourceModifiedDate": "2022-03-23T15:55:58Z", "metadata": { "isDeleted": false } } }, "Oracle NetSuite": { "value": { "id": "2-1", "contactRef": { "id": "417", "dataType": "customers" }, "date": "2021-03-10T00:00:00", "from": { "accountRef": { "id": "122", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 90, "status": "Unknown" }, "to": { "accountRef": { "id": "513", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 90, "status": "Unknown" }, "trackingCategoryRefs": [ { "id": "location-1" } ], "depositedRecordRefs": [ { "id": "428", "dataType": "payments" } ], "modifiedDate": "2022-09-20T08:16:26", "sourceModifiedDate": "2022-04-28T13:36:47" } }, "QuickBooks Desktop": { "value": { "id": "4B1-933288922", "description": "Funds Transfer", "date": "2024-10-14T00:00:00", "from": { "accountRef": { "id": "30000-933270541", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 15000, "status": "Unknown" }, "to": { "accountRef": { "id": "20000-933270541", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 15000, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2023-04-26T09:13:45", "sourceModifiedDate": "2023-12-16T05:03:58", "metadata": { "isDeleted": false } } }, "QuickBooks Online Sandbox": { "value": { "id": "646", "date": "2020-08-21T00:00:00", "from": { "accountRef": { "id": "102", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 73.41, "status": "Unknown" }, "to": { "accountRef": { "id": "108", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 73.41, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2023-04-26T09:36:33", "sourceModifiedDate": "2020-08-26T11:41:20Z", "metadata": { "isDeleted": false } } }, "QuickBooks Online": { "value": { "id": "1881", "date": "2020-08-29T00:00:00", "from": { "accountRef": { "id": "60", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 86.19, "status": "Unknown" }, "to": { "accountRef": { "id": "61", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 86.19, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2023-01-18T11:03:00", "sourceModifiedDate": "2020-09-03T11:19:54Z" } }, "Sage Business Cloud Accounting": { "value": { "id": "434bce57215a11e8b45c025132dab352", "description": "Some cheque", "date": "2018-03-06T00:00:00", "from": { "accountRef": { "id": "9a3f0ed6267a11e797950a57719b2edb", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 1000, "status": "Unknown" }, "to": { "accountRef": { "id": "9a2c3770267a11e797950a57719b2edb", "dataType": "bankAccounts" }, "currency": "GBP", "amount": 1000, "status": "Unknown" }, "trackingCategoryRefs": [], "depositedRecordRefs": [], "modifiedDate": "2022-10-24T14:54:11", "sourceModifiedDate": "2018-03-06T16:20:19Z" } }, "Sage Intacct": { "value": { "id": "4844", "description": "Description", "date": "2022-03-10T00:00:00", "from": { "accountRef": { "id": "CHECKINGACCOUNT:12", "dataType": "bankAccounts" }, "currency": "ZAR", "amount": 418.27, "status": "Unknown" }, "to": { "accountRef": { "id": "CHECKINGACCOUNT:9", "dataType": "bankAccounts" }, "currency": "CAD", "amount": 35.45, "status": "Unknown" }, "trackingCategoryRefs": [ { "id": "LOCATION-10", "name": "South Africa" } ], "depositedRecordRefs": [], "modifiedDate": "2023-02-23T14:18:48", "sourceModifiedDate": "2022-03-10T12:38:23", "metadata": { "isDeleted": false } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get transfer* endpoint returns a single transfer for a given transferId.\n\n[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support getting a specific transfer.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-transfer" } }, "/companies/{companyId}/connections/{connectionId}/options/transfers": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create transfer model", "tags": [ "Transfers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Exact (Netherlands)": { "value": { "type": "Object", "displayName": "Transfer", "description": "Transfers to or from a bank account", "properties": { "description": { "type": "String", "displayName": "Transfer Description", "description": "The description of the transfer", "required": false }, "contactRef": { "type": "Object", "displayName": "Contact Reference", "description": "The customer or supplier for this transfer if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "ContactRef.Id", "details": "Must match the ID of an existing customer or supplier." } ], "information": [] } }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "customers", "type": "String", "displayName": "customers", "required": false }, { "value": "suppliers", "type": "String", "displayName": "suppliers", "required": false } ], "required": true } }, "required": false }, "date": { "type": "DateTime", "displayName": "Transfer Date", "description": "The date the transfer occurred", "required": true }, "from": { "type": "Object", "displayName": "Transfered From", "description": "The account and amount that money was transfered from", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transfer", "required": false }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true, "validation": { "warnings": [ { "field": "From.Amount", "details": "Transfer Amount must be greater than zero." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing bank or nominal account." } ], "information": [] } }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "chartOfAccounts", "type": "String", "displayName": "chartOfAccounts", "required": false } ], "required": true } }, "required": true, "validation": { "warnings": [ { "field": "From.AccountRef", "details": "Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account)." } ], "information": [] } } }, "required": true }, "to": { "type": "Object", "displayName": "Transfered To", "description": "The account and amount that money was transfered to", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transfer", "required": false }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true, "validation": { "warnings": [ { "field": "To.Amount", "details": "Transfer Amount must be greater than zero." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing bank or nominal account." } ], "information": [] } }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "chartOfAccounts", "type": "String", "displayName": "chartOfAccounts", "required": false } ], "required": true } }, "required": true, "validation": { "warnings": [ { "field": "To.AccountRef", "details": "Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account)." } ], "information": [] } } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this transfer is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": false } }, "required": false } }, "required": true } }, "Exact (UK)": { "value": { "type": "Object", "displayName": "Transfer", "description": "Transfers to or from a bank account", "properties": { "description": { "type": "String", "displayName": "Transfer Description", "description": "The description of the transfer", "required": false }, "contactRef": { "type": "Object", "displayName": "Contact Reference", "description": "The customer or supplier for this transfer if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "ContactRef.Id", "details": "Must match the ID of an existing customer or supplier." } ], "information": [] } }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "customers", "type": "String", "displayName": "customers", "required": false }, { "value": "suppliers", "type": "String", "displayName": "suppliers", "required": false } ], "required": true } }, "required": false }, "date": { "type": "DateTime", "displayName": "Transfer Date", "description": "The date the transfer occurred", "required": true }, "from": { "type": "Object", "displayName": "Transfered From", "description": "The account and amount that money was transfered from", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transfer", "required": false }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true, "validation": { "warnings": [ { "field": "From.Amount", "details": "Transfer Amount must be greater than zero." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing bank or nominal account." } ], "information": [] } }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "chartOfAccounts", "type": "String", "displayName": "chartOfAccounts", "required": false } ], "required": true } }, "required": true, "validation": { "warnings": [ { "field": "From.AccountRef", "details": "Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account)." } ], "information": [] } } }, "required": true }, "to": { "type": "Object", "displayName": "Transfered To", "description": "The account and amount that money was transfered to", "properties": { "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transfer", "required": false }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true, "validation": { "warnings": [ { "field": "To.Amount", "details": "Transfer Amount must be greater than zero." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing bank or nominal account." } ], "information": [] } }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "chartOfAccounts", "type": "String", "displayName": "chartOfAccounts", "required": false } ], "required": true } }, "required": true, "validation": { "warnings": [ { "field": "To.AccountRef", "details": "Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account)." } ], "information": [] } } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this transfer is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": false } }, "required": false } }, "required": true } }, "FreeAgent": { "value": { "type": "Object", "displayName": "Transfer", "description": "Transfers to or from a bank account", "properties": { "date": { "type": "DateTime", "displayName": "Transfer Date", "description": "The date the transfer occurred", "required": true }, "from": { "type": "Object", "displayName": "Transfered From", "description": "The account and amount that money was transfered from", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing bank account." } ], "information": [] } } }, "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true, "validation": { "warnings": [ { "field": "From.Amount", "details": "Must be provided and be greater than zero." } ], "information": [] } } }, "required": true }, "to": { "type": "Object", "displayName": "Transfered To", "description": "The account and amount that money was transfered to", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing bank account." } ], "information": [] } } }, "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": false, "validation": { "warnings": [ { "field": "To.Amount", "details": "If provided, must be greater than zero." }, { "field": "To.Amount", "details": "It will be taken into account just if the accounts are in different currencies and will override the automatic currency conversion." } ], "information": [] } } }, "required": true } }, "required": true } }, "Oracle NetSuite": { "value": { "type": "Object", "displayName": "Transfer", "description": "Transfers to or from a bank account", "properties": { "description": { "type": "String", "displayName": "Transfer Description", "description": "The description of the transfer", "required": false }, "date": { "type": "DateTime", "displayName": "Transfer Date", "description": "The date the transfer occurred", "required": false, "validation": { "warnings": [], "information": [ { "field": "Date", "details": "Will default to today's date if not provided" } ] } }, "from": { "type": "Object", "displayName": "Transfered From", "description": "The account and amount that money was transfered from", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Either the 'From' account or the 'To' account must be a bank account - the other must be an undeposited funds account" } ], "information": [] } } }, "required": true } }, "required": true }, "to": { "type": "Object", "displayName": "Transfered To", "description": "The account and amount that money was transfered to", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Either the 'From' account or the 'To' account must be a bank account - the other must be an undeposited funds account" } ], "information": [] } } }, "required": true } }, "required": true }, "depositedRecordRefs": { "type": "Array", "displayName": "Deposited Record References", "description": "A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer.", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this transfer is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true, "validation": { "warnings": [ { "field": "TrackingCategoryRefs.Id", "details": "One location, one department and one classification may be provided" } ], "information": [] } } }, "required": false } }, "required": true, "validation": { "warnings": [ { "details": "Currently only transfers between bank accounts and undeposited funds accounts are supported" } ], "information": [] } } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Transfer", "description": "Transfers to or from a bank account", "properties": { "from": { "type": "Object", "displayName": "Transfered From", "description": "The account and amount that money was transfered from", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true, "validation": { "warnings": [ { "field": "From.Amount", "details": "Value should match To.Amount" }, { "field": "From.Amount", "details": "Value should be greater than zero" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transfer", "required": false, "validation": { "warnings": [ { "field": "From.Currency", "details": "This value is not used in the push, and will be ignored." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true } }, "required": true } }, "required": true }, "to": { "type": "Object", "displayName": "Transfered To", "description": "The account and amount that money was transfered to", "properties": { "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true, "validation": { "warnings": [ { "field": "To.Amount", "details": "Value should match To.Amount" }, { "field": "To.Amount", "details": "Value should be greater than zero" } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transfer", "required": false, "validation": { "warnings": [ { "field": "To.Currency", "details": "This value is not used in the push, and will be ignored." } ], "information": [] } }, "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true } }, "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this transfer is being tracked against", "required": false }, "description": { "type": "String", "displayName": "Transfer Description", "description": "The description of the transfer", "required": false, "validation": { "warnings": [ { "field": "Description", "details": "Max length of 4096 characters." } ], "information": [] } }, "date": { "type": "DateTime", "displayName": "Transfer Date", "description": "The date the transfer occurred", "required": true }, "contactRef": { "type": "Object", "displayName": "Contact Reference", "description": "The customer or supplier for this transfer if known", "required": false, "validation": { "warnings": [ { "field": "ContactRef", "details": "This value is not used in the push, and will be ignored." } ], "information": [] } }, "sourceModifiedDate": { "type": "DateTime", "displayName": "Source Modified Date", "description": "The date the record was last changed in the originating system", "required": true } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Transfer", "description": "Transfers to or from a bank account", "properties": { "description": { "type": "String", "displayName": "Transfer Description", "description": "The description of the transfer", "required": false }, "from": { "type": "Object", "displayName": "Transfered From", "description": "The account and amount that money was transfered from", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true } }, "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true } }, "required": true }, "to": { "type": "Object", "displayName": "Transfered To", "description": "The account and amount that money was transfered to", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true } }, "required": true } }, "required": true }, "depositedRecordRefs": { "type": "Array", "displayName": "Deposited Record References", "description": "A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer.", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "payments", "type": "String", "displayName": "Payments", "required": false }, { "value": "directIncomes", "type": "String", "displayName": "DirectIncomes", "required": false }, { "value": "journalEntries", "type": "String", "displayName": "JournalEntries", "required": false } ], "required": true } }, "required": false } }, "required": true, "validation": { "warnings": [ { "details": "When pushing a transfer using two different currencies, the exchange rate will be calculated and passed to QuickBooks, QuickBooks performs rounding on this value which may affect the values in the transfer" }, { "details": "Transfers between accounts in different currencies can only be made if multi-currency is enabled for company" }, { "details": "The currency of at least one of the accounts used must be the same as the company's currency" } ], "information": [] } } }, "QuickBooks Online": { "value": { "type": "Object", "displayName": "Transfer", "description": "Transfers to or from a bank account", "properties": { "description": { "type": "String", "displayName": "Transfer Description", "description": "The description of the transfer", "required": false }, "from": { "type": "Object", "displayName": "Transfered From", "description": "The account and amount that money was transfered from", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true } }, "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true } }, "required": true }, "to": { "type": "Object", "displayName": "Transfered To", "description": "The account and amount that money was transfered to", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true } }, "required": true } }, "required": true }, "depositedRecordRefs": { "type": "Array", "displayName": "Deposited Record References", "description": "A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer.", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "options": [ { "value": "payments", "type": "String", "displayName": "Payments", "required": false }, { "value": "directIncomes", "type": "String", "displayName": "DirectIncomes", "required": false }, { "value": "journalEntries", "type": "String", "displayName": "JournalEntries", "required": false } ], "required": true } }, "required": false } }, "required": true, "validation": { "warnings": [ { "details": "When pushing a transfer using two different currencies, the exchange rate will be calculated and passed to QuickBooks, QuickBooks performs rounding on this value which may affect the values in the transfer" }, { "details": "Transfers between accounts in different currencies can only be made if multi-currency is enabled for company" }, { "details": "The currency of at least one of the accounts used must be the same as the company's currency" } ], "information": [] } } }, "Sage Business Cloud Accounting": { "value": { "type": "Object", "displayName": "Transfer", "description": "Transfers to or from a bank account", "properties": { "description": { "type": "String", "displayName": "Transfer Description", "description": "The description of the transfer", "required": false, "validation": { "warnings": [ { "field": "Description", "details": "Must be provided if pushing a bank deposit." } ], "information": [ { "field": "Description", "details": "Must not be longer than 2000 characters." } ] } }, "date": { "type": "DateTime", "displayName": "Transfer Date", "description": "The date the transfer occurred", "required": true, "validation": { "warnings": [], "information": [ { "field": "Date", "details": "Must be provided." } ] } }, "from": { "type": "Object", "displayName": "Transfered From", "description": "The account and amount that money was transfered from", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Must be different from To.AccountRef.Id." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing bank account in the company's base currency." } ] } } }, "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true, "validation": { "warnings": [], "information": [ { "field": "From.Amount", "details": "Must be equal to To.Amount." }, { "field": "From.Amount", "details": "Must be greater than zero." } ] } } }, "required": true }, "to": { "type": "Object", "displayName": "Transfered To", "description": "The account and amount that money was transfered to", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountRef.Id", "details": "Must be different from From.AccountRef.Id." }, { "field": "AccountRef.Id", "details": "Must match the ID of an existing bank account in the company's base currency." } ] } } }, "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true, "validation": { "warnings": [], "information": [ { "field": "To.Amount", "details": "Must be equal to From.Amount." }, { "field": "To.Amount", "details": "Must be greater than zero." } ] } } }, "required": true } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Transfer", "description": "Transfers to or from a bank account", "properties": { "description": { "type": "String", "displayName": "Transfer Description", "description": "The description of the transfer", "required": true }, "contactRef": { "type": "Object", "displayName": "Contact Reference", "description": "The customer or supplier for this transfer if known", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true }, "date": { "type": "DateTime", "displayName": "Transfer Date", "description": "The date the transfer occurred", "required": true }, "from": { "type": "Object", "displayName": "Transfered From", "description": "The account and amount that money was transfered from", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transfer", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true }, "status": { "type": "String", "displayName": "Status", "description": "The status of the transfer in the account", "required": true } }, "required": true }, "to": { "type": "Object", "displayName": "Transfered To", "description": "The account and amount that money was transfered to", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the transfer", "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true }, "status": { "type": "String", "displayName": "Status", "description": "The status of the transfer in the account", "required": true } }, "required": true }, "trackingCategoryRefs": { "type": "Array", "displayName": "Tracking Category References", "description": "A collection of categories this transfer is being tracked against", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The identifier for the item, unique per tracking category", "required": true }, "name": { "type": "String", "displayName": "Tracking Category Name", "description": "The name of the category referenced by the identifier", "required": true } }, "required": true }, "depositedRecordRefs": { "type": "Array", "displayName": "Deposited Record References", "description": "A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer.", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true }, "dataType": { "type": "String", "displayName": "DataType", "description": "The name of the data type for which the ID is valid.", "required": true } }, "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } }, "Xero": { "value": { "type": "Object", "displayName": "Transfer", "description": "Transfers to or from a bank account", "properties": { "date": { "type": "DateTime", "displayName": "Transfer Date", "description": "The date the transfer occurred", "required": true }, "from": { "type": "Object", "displayName": "Transfered From", "description": "The account and amount that money was transfered from", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing bank account." } ], "information": [] } } }, "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true, "validation": { "warnings": [ { "field": "From.Amount", "details": "Must be equal to To.Amount." }, { "field": "From.Amount", "details": "Must be greater than zero." } ], "information": [] } }, "status": { "type": "String", "displayName": "Status", "description": "The status of the transfer in the account", "options": [ { "value": "Unknown", "type": "String", "displayName": "Unknown", "required": false }, { "value": "Unreconciled", "type": "String", "displayName": "Unreconciled", "required": false }, { "value": "Reconciled", "type": "String", "displayName": "Reconciled", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "From.Status", "details": "Must be provided." } ] } } }, "required": true }, "to": { "type": "Object", "displayName": "Transfered To", "description": "The account and amount that money was transfered to", "properties": { "accountRef": { "type": "Object", "displayName": "Account Reference", "description": "Reference to the bank or nominal account", "properties": { "id": { "type": "String", "displayName": "Identifier", "description": "The reference identifier for the record", "required": true, "validation": { "warnings": [ { "field": "AccountRef.Id", "details": "Must match the ID of an existing bank account." } ], "information": [] } } }, "required": true }, "amount": { "type": "Number", "displayName": "Amount", "description": "The amount transfered", "required": true, "validation": { "warnings": [ { "field": "To.Amount", "details": "Must be equal to From.Amount." }, { "field": "To.Amount", "details": "Must be greater than zero." } ], "information": [] } }, "status": { "type": "String", "displayName": "Status", "description": "The status of the transfer in the account", "options": [ { "value": "Unknown", "type": "String", "displayName": "Unknown", "required": false }, { "value": "Unreconciled", "type": "String", "displayName": "Unreconciled", "required": false }, { "value": "Reconciled", "type": "String", "displayName": "Reconciled", "required": false } ], "required": true, "validation": { "warnings": [], "information": [ { "field": "To.Status", "details": "Must be provided." } ] } } }, "required": true } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-transfers-model", "description": "The *Get create transfer model* endpoint returns the expected data for the request payload when creating a [transfer](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company and integration.\n\n[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support creating a transfer.\n" } }, "/companies/{companyId}/connections/{connectionId}/push/transfers": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Transfers" ], "summary": "Create transfer", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transfer" }, "examples": { "QuickBooks Desktop": { "value": { "description": "test transfers push 20230126 12.08", "contactRef": { "id": "80000028-167239230944", "dataType": "customers" }, "date": "2023-01-26T11:51:18.104Z", "from": { "accountRef": { "id": "80000028-1671794219", "dataType": "bankAccounts" }, "amount": 12 }, "to": { "accountRef": { "id": "80000004-1671793811", "dataType": "bankAccounts" }, "amount": 12 }, "status": "Unknown", "trackingCategoryRefs": [ { "id": "80000001-1674553252", "name": "Class 1" } ], "metadata": { "isDeleted": true } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTransferResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create transfer* endpoint creates a new [transfer](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company's connection.\n\n[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create transfer model](https://docs.codat.io/accounting-api#/operations/get-create-transfers-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support creating an account.\n", "operationId": "create-transfer" } }, "/companies/{companyId}/connections/{connectionId}/data/bankAccounts": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "tags": [ "Bank accounts" ], "summary": "List bank accounts", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccounts" }, "examples": { "Dynamics 365 Business Central": { "value": { "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" } } } }, "FreeAgent": { "value": { "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" } } } }, "KashFlow": { "value": { "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" } } } }, "Oracle NetSuite": { "value": { "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" } } } }, "QuickBooks Desktop": { "value": { "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" } } } }, "QuickBooks Online Sandbox": { "value": { "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" } } } }, "QuickBooks Online": { "value": { "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" } } } }, "Sage 50 (UK)": { "value": { "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" } } } }, "Sage Business Cloud Accounting": { "value": { "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" } } } }, "Sage Intacct": { "value": { "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" } } } }, "Xero": { "value": { "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" } } } }, "Zoho Books": { "value": { "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" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) for a given company's connection.\n\n[Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n ", "operationId": "list-bank-accounts" } }, "/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/accountId" } ], "get": { "tags": [ "Bank accounts" ], "summary": "Get bank account", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccount" }, "examples": { "Dynamics 365 Business Central": { "value": { "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 } } }, "FreeAgent": { "value": { "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 } } }, "KashFlow": { "value": { "id": "765768", "accountName": "16th Account", "accountType": "Unknown", "nominalCode": "70700", "currency": "GBP", "balance": 326, "availableBalance": 326, "modifiedDate": "2022-09-30T10:29:16Z" } }, "QuickBooks Desktop": { "value": { "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 } } }, "Sage 50 (UK)": { "value": { "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 } } }, "Sage Business Cloud Accounting": { "value": { "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" } }, "Xero": { "value": { "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 } } }, "Zoho Books": { "value": { "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" } }, "Oracle NetSuite": { "value": { "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 } } }, "QuickBooks Online Sandbox": { "value": { "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 } } }, "QuickBooks Online": { "value": { "id": "202", "accountName": "\\aa", "accountType": "Debit", "currency": "GBP", "balance": 123, "availableBalance": 123, "modifiedDate": "2023-01-18T11:02:37Z", "sourceModifiedDate": "2022-11-11T14:15:13Z" } }, "Sage Intacct": { "value": { "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 } } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Get bank account* endpoint returns a single account for a given accountId.\n\n[Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support getting a specific bank account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "get-bank-account" } }, "/companies/{companyId}/connections/{connectionId}/options/bankAccounts": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "get": { "summary": "Get create/update bank account model", "tags": [ "Bank accounts" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": { "Dynamics 365 Business Central": { "value": { "type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "properties": { "accountName": { "type": "String", "displayName": "Name", "description": "The name of the bank account in the originating system", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountName", "details": "Needs to be of the format '{No.}-{Name}'" } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the bank account", "required": true }, "accountNumber": { "type": "String", "displayName": "Account Number", "description": "The account number for the bank account", "required": false }, "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": false, "validation": { "warnings": [], "information": [ { "field": "NominalCode", "details": "Bank Account Posting Group with Nominal Account must exist" } ] } }, "sortCode": { "type": "String", "displayName": "Sort Code", "description": "The sort code for the bank account", "required": false, "validation": { "warnings": [], "information": [ { "field": "SortCode", "details": "Must have a length between 0 and 20 characters" } ] } }, "iBan": { "type": "String", "displayName": "IBAN", "description": "The international bank account number of the account. Often used when making or receiving international payments", "required": false }, "overdraftLimit": { "type": "Number", "displayName": "Overdraft Limit", "description": "The pre-arranged overdraft limit of the account", "required": false, "validation": { "warnings": [], "information": [ { "field": "OverdraftLimit", "details": "Default value is 0" } ] } } }, "required": true } }, "Exact (Netherlands)": { "value": { "type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "properties": { "accountName": { "type": "String", "displayName": "Name", "description": "The name of the bank account in the originating system", "required": true }, "accountNumber": { "type": "String", "displayName": "Account Number", "description": "The account number for the bank account", "required": true, "validation": { "warnings": [ { "field": "AccountNumber", "details": "Should not exceed the maximum length of 14 characters if the specified currency is GBP." } ], "information": [] } }, "sortCode": { "type": "String", "displayName": "Sort Code", "description": "The sort code for the bank account", "required": false, "validation": { "warnings": [ { "field": "SortCode", "details": "Must be 6 characters long if the specified currency is GBP." }, { "field": "SortCode", "details": "Must be provided if the specified currency is GBP." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the bank account", "required": false }, "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": false } }, "required": true } }, "Exact (UK)": { "value": { "type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "properties": { "accountName": { "type": "String", "displayName": "Name", "description": "The name of the bank account in the originating system", "required": true }, "accountNumber": { "type": "String", "displayName": "Account Number", "description": "The account number for the bank account", "required": true, "validation": { "warnings": [ { "field": "AccountNumber", "details": "Should not exceed the maximum length of 14 characters if the specified currency is GBP." } ], "information": [] } }, "sortCode": { "type": "String", "displayName": "Sort Code", "description": "The sort code for the bank account", "required": false, "validation": { "warnings": [ { "field": "SortCode", "details": "Must be 6 characters long if the specified currency is GBP." }, { "field": "SortCode", "details": "Must be provided if the specified currency is GBP." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the bank account", "required": false }, "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": false } }, "required": true } }, "FreeAgent": { "value": { "type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "properties": { "accountName": { "type": "String", "displayName": "Name", "description": "The name of the bank account in the originating system", "required": true }, "sortCode": { "type": "String", "displayName": "Sort Code", "description": "The sort code for the bank account", "required": false, "validation": { "warnings": [ { "field": "SortCode", "details": "Must have a length between 0 and 8 characters" } ], "information": [] } }, "accountNumber": { "type": "String", "displayName": "Account Number", "description": "The account number for the bank account", "required": false }, "iBan": { "type": "String", "displayName": "IBAN", "description": "The international bank account number of the account. Often used when making or receiving international payments", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the bank account", "options": [ { "value": "AED", "type": "String", "displayName": "AED", "required": false }, { "value": "AMD", "type": "String", "displayName": "AMD", "required": false }, { "value": "AOA", "type": "String", "displayName": "AOA", "required": false }, { "value": "ARS", "type": "String", "displayName": "ARS", "required": false }, { "value": "AUD", "type": "String", "displayName": "AUD", "required": false }, { "value": "AWG", "type": "String", "displayName": "AWG", "required": false }, { "value": "AZN", "type": "String", "displayName": "AZN", "required": false }, { "value": "BBD", "type": "String", "displayName": "BBD", "required": false }, { "value": "BDT", "type": "String", "displayName": "BDT", "required": false }, { "value": "BGN", "type": "String", "displayName": "BGN", "required": false }, { "value": "BRL", "type": "String", "displayName": "BRL", "required": false }, { "value": "BWP", "type": "String", "displayName": "BWP", "required": false }, { "value": "CAD", "type": "String", "displayName": "CAD", "required": false }, { "value": "CHF", "type": "String", "displayName": "CHF", "required": false }, { "value": "CLP", "type": "String", "displayName": "CLP", "required": false }, { "value": "CNY", "type": "String", "displayName": "CNY", "required": false }, { "value": "COP", "type": "String", "displayName": "COP", "required": false }, { "value": "CRC", "type": "String", "displayName": "CRC", "required": false }, { "value": "CUC", "type": "String", "displayName": "CUC", "required": false }, { "value": "CUP", "type": "String", "displayName": "CUP", "required": false }, { "value": "CZK", "type": "String", "displayName": "CZK", "required": false }, { "value": "DKK", "type": "String", "displayName": "DKK", "required": false }, { "value": "DOP", "type": "String", "displayName": "DOP", "required": false }, { "value": "EGP", "type": "String", "displayName": "EGP", "required": false }, { "value": "EUR", "type": "String", "displayName": "EUR", "required": false }, { "value": "FJD", "type": "String", "displayName": "FJD", "required": false }, { "value": "GBP", "type": "String", "displayName": "GBP", "required": false }, { "value": "GEL", "type": "String", "displayName": "GEL", "required": false }, { "value": "GHS", "type": "String", "displayName": "GHS", "required": false }, { "value": "GTQ", "type": "String", "displayName": "GTQ", "required": false }, { "value": "GYD", "type": "String", "displayName": "GYD", "required": false }, { "value": "HKD", "type": "String", "displayName": "HKD", "required": false }, { "value": "HNL", "type": "String", "displayName": "HNL", "required": false }, { "value": "HRK", "type": "String", "displayName": "HRK", "required": false }, { "value": "HUF", "type": "String", "displayName": "HUF", "required": false }, { "value": "IDR", "type": "String", "displayName": "IDR", "required": false }, { "value": "ILS", "type": "String", "displayName": "ILS", "required": false }, { "value": "INR", "type": "String", "displayName": "INR", "required": false }, { "value": "ISK", "type": "String", "displayName": "ISK", "required": false }, { "value": "JMD", "type": "String", "displayName": "JMD", "required": false }, { "value": "JPY", "type": "String", "displayName": "JPY", "required": false }, { "value": "KES", "type": "String", "displayName": "KES", "required": false }, { "value": "KRW", "type": "String", "displayName": "KRW", "required": false }, { "value": "KWD", "type": "String", "displayName": "KWD", "required": false }, { "value": "KYD", "type": "String", "displayName": "KYD", "required": false }, { "value": "KZT", "type": "String", "displayName": "KZT", "required": false }, { "value": "LAK", "type": "String", "displayName": "LAK", "required": false }, { "value": "LBP", "type": "String", "displayName": "LBP", "required": false }, { "value": "LKR", "type": "String", "displayName": "LKR", "required": false }, { "value": "LTL", "type": "String", "displayName": "LTL", "required": false }, { "value": "LVL", "type": "String", "displayName": "LVL", "required": false }, { "value": "MAD", "type": "String", "displayName": "MAD", "required": false }, { "value": "MDL", "type": "String", "displayName": "MDL", "required": false }, { "value": "MGA", "type": "String", "displayName": "MGA", "required": false }, { "value": "MUR", "type": "String", "displayName": "MUR", "required": false }, { "value": "MVR", "type": "String", "displayName": "MVR", "required": false }, { "value": "MWK", "type": "String", "displayName": "MWK", "required": false }, { "value": "MXN", "type": "String", "displayName": "MXN", "required": false }, { "value": "MYR", "type": "String", "displayName": "MYR", "required": false }, { "value": "MZN", "type": "String", "displayName": "MZN", "required": false }, { "value": "NAD", "type": "String", "displayName": "NAD", "required": false }, { "value": "NGN", "type": "String", "displayName": "NGN", "required": false }, { "value": "NOK", "type": "String", "displayName": "NOK", "required": false }, { "value": "NPR", "type": "String", "displayName": "NPR", "required": false }, { "value": "NZD", "type": "String", "displayName": "NZD", "required": false }, { "value": "OMR", "type": "String", "displayName": "OMR", "required": false }, { "value": "PEN", "type": "String", "displayName": "PEN", "required": false }, { "value": "PHP", "type": "String", "displayName": "PHP", "required": false }, { "value": "PKR", "type": "String", "displayName": "PKR", "required": false }, { "value": "PLN", "type": "String", "displayName": "PLN", "required": false }, { "value": "QAR", "type": "String", "displayName": "QAR", "required": false }, { "value": "RON", "type": "String", "displayName": "RON", "required": false }, { "value": "RSD", "type": "String", "displayName": "RSD", "required": false }, { "value": "RUB", "type": "String", "displayName": "RUB", "required": false }, { "value": "RWF", "type": "String", "displayName": "RWF", "required": false }, { "value": "SAR", "type": "String", "displayName": "SAR", "required": false }, { "value": "SCR", "type": "String", "displayName": "SCR", "required": false }, { "value": "SEK", "type": "String", "displayName": "SEK", "required": false }, { "value": "SGD", "type": "String", "displayName": "SGD", "required": false }, { "value": "THB", "type": "String", "displayName": "THB", "required": false }, { "value": "TND", "type": "String", "displayName": "TND", "required": false }, { "value": "TRY", "type": "String", "displayName": "TRY", "required": false }, { "value": "TTD", "type": "String", "displayName": "TTD", "required": false }, { "value": "TWD", "type": "String", "displayName": "TWD", "required": false }, { "value": "TZS", "type": "String", "displayName": "TZS", "required": false }, { "value": "UAH", "type": "String", "displayName": "UAH", "required": false }, { "value": "UGX", "type": "String", "displayName": "UGX", "required": false }, { "value": "USD", "type": "String", "displayName": "USD", "required": false }, { "value": "UYU", "type": "String", "displayName": "UYU", "required": false }, { "value": "VEF", "type": "String", "displayName": "VEF", "required": false }, { "value": "VND", "type": "String", "displayName": "VND", "required": false }, { "value": "VUV", "type": "String", "displayName": "VUV", "required": false }, { "value": "XAF", "type": "String", "displayName": "XAF", "required": false }, { "value": "XCD", "type": "String", "displayName": "XCD", "required": false }, { "value": "XOF", "type": "String", "displayName": "XOF", "required": false }, { "value": "ZAR", "type": "String", "displayName": "ZAR", "required": false }, { "value": "ZMK", "type": "String", "displayName": "ZMK", "required": false } ], "required": true }, "balance": { "type": "Number", "displayName": "Balance", "description": "The balance of the bank account", "required": false, "validation": { "warnings": [], "information": [ { "field": "Balance", "details": "The opening balance, in the account currency" } ] } }, "institution": { "type": "String", "displayName": "Institution", "description": "The institution of the bank account", "required": false } }, "required": true } }, "KashFlow": { "value": { "type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "properties": { "accountName": { "type": "String", "displayName": "Account Name", "description": "Name of the bank account as it appears in Kashflow.", "required": true }, "balance": { "type": "Number", "displayName": "Balance", "description": "The opening balance, in the account currency.", "required": false }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the bank account.", "required": true } }, "required": true } }, "QuickBooks Desktop": { "value": { "type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "properties": { "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true, "validation": { "warnings": [ { "field": "NominalCode", "details": "Max length of 7 characters." } ], "information": [] } }, "accountName": { "type": "String", "displayName": "Name", "description": "The name of the bank account in the originating system", "required": true, "validation": { "warnings": [ { "field": "AccountName", "details": "Max length of 31 characters." } ], "information": [] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the bank account", "required": false, "validation": { "warnings": [ { "field": "Currency", "details": "The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is 'Asset.AccountsReceivable','Liability.AccountsPayable' or 'Liability.CreditCard'" }, { "field": "Currency", "details": "Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company" }, { "field": "Currency", "details": "Can only be set if the Quickbooks Desktop company has Multicurrency enabled." } ], "information": [ { "field": "Currency", "details": "If not set, will default to the base currency of the QuickBooks Desktop company" } ] } }, "balance": { "type": "Number", "displayName": "Balance", "description": "The balance of the bank account", "required": false } }, "required": true } }, "QuickBooks Online Sandbox": { "value": { "type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "properties": { "accountName": { "type": "String", "displayName": "Account Name", "description": "Name of account as it appears in the chart of accounts or general ledger.", "required": true }, "accountNumber": { "type": "String", "displayName": "Account Number", "description": "User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account.", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "Currency of the bank account.", "required": true } }, "required": true } }, "Sage Business Cloud Accounting": { "value": { "type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "properties": { "accountName": { "type": "String", "displayName": "Name", "description": "The name of the bank account in the originating system", "required": true, "validation": { "warnings": [], "information": [ { "field": "AccountName", "details": "Must be provided." }, { "field": "AccountName", "details": "Should not be longer than 50 characters." } ] } }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the bank account", "required": true, "validation": { "warnings": [], "information": [ { "field": "Currency", "details": "Must be provided." }, { "field": "Currency", "details": "Must match the company's base currency." } ] } }, "sortCode": { "type": "String", "displayName": "Sort Code", "description": "The sort code for the bank account", "required": false, "validation": { "warnings": [], "information": [ { "field": "SortCode", "details": "Should be a 6 digit number." } ] } }, "accountNumber": { "type": "String", "displayName": "Account Number", "description": "The account number for the bank account", "required": false, "validation": { "warnings": [], "information": [ { "field": "AccountNumber", "details": "Should not be longer than 25 characters." } ] } }, "iBan": { "type": "String", "displayName": "IBAN", "description": "The international bank account number of the account. Often used when making or receiving international payments", "required": false, "validation": { "warnings": [], "information": [ { "field": "IBan", "details": "Should be in the international bank account number format." } ] } }, "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": false, "validation": { "warnings": [], "information": [ { "field": "NominalCode", "details": "Should be a number between 1 and 99999999." } ] } } }, "required": true } }, "Sandbox": { "value": { "type": "Object", "displayName": "Bank Account", "description": "An account that bank transactions may be recorded against", "properties": { "accountName": { "type": "String", "displayName": "Name", "description": "The name of the bank account in the originating system", "required": true }, "accountType": { "type": "String", "displayName": "Account Type", "description": "The type of account", "required": true }, "nominalCode": { "type": "String", "displayName": "Nominal Code", "description": "The external reference given to each nominal account for a business", "required": true }, "sortCode": { "type": "String", "displayName": "Sort Code", "description": "The sort code for the bank account", "required": true }, "accountNumber": { "type": "String", "displayName": "Account Number", "description": "The account number for the bank account", "required": true }, "iBan": { "type": "String", "displayName": "IBAN", "description": "The international bank account number of the account. Often used when making or receiving international payments", "required": true }, "currency": { "type": "String", "displayName": "Currency", "description": "The currency of the bank account", "required": true }, "balance": { "type": "Number", "displayName": "Balance", "description": "The balance of the bank account", "required": true }, "availableBalance": { "type": "Number", "displayName": "Available Balance", "description": "The available balance of the bank account", "required": true }, "overdraftLimit": { "type": "Number", "displayName": "Overdraft Limit", "description": "The pre-arranged overdraft limit of the account", "required": true }, "institution": { "type": "String", "displayName": "Institution", "description": "The institution of the bank account", "required": true }, "metadata": { "type": "Object", "displayName": "Metadata", "description": "Miscellaneous data about the item", "properties": { "isDeleted": { "type": "Boolean", "displayName": "IsDeleted", "description": "A boolean to indicate whether the object has been deleted", "required": true } }, "required": true } }, "required": true } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "operationId": "get-create-update-bankAccounts-model", "description": "The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a [bank account](https://docs.codat.io/accounting-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behaviour**\r\n\r\nSee the *response examples* for integration-specific indicative models.\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account.\r\n" } }, "/companies/{companyId}/connections/{connectionId}/push/bankAccounts": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" } ], "post": { "tags": [ "Bank accounts" ], "summary": "Create bank account", "parameters": [ { "$ref": "#/components/parameters/allowSyncOnPushComplete" }, { "$ref": "#/components/parameters/timeoutInMinutes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccount" }, "examples": {} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBankAccountResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/accounting-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behaviour**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/accounting-api#/operations/get-create-update-bankAccounts-model).\r\n\r\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account.", "operationId": "create-bank-account" } }, "/companies/{companyId}/connections/{connectionId}/push/bankAccounts/{bankAccountId}": { "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/bankAccountId" } ], "put": { "tags": [ "Bank accounts" ], "summary": "Update bank account", "parameters": [ { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/forceUpdate" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccount" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBankAccountResponse" }, "examples": {} } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } }, "description": "The *Update bank account* endpoint updates an existing [bank account](https://docs.codat.io/accounting-api#/schemas/BankAccount) for a given company's connection.\n\n[Bank accounts](https://docs.codat.io/accounting-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/accounting-api#/operations/get-create-update-bankAccounts-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account.\n", "operationId": "update-bank-account" } }, "/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions": { "get": { "tags": [ "Bank account transactions" ], "summary": "List bank account transactions", "description": "The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection.\n\n[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support listing bank transactions.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n", "operationId": "list-bank-account-transactions", "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/accountId" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/query" }, { "$ref": "#/components/parameters/orderBy" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankTransactions" }, "examples": { "Dynamics 365 Business Central": { "value": { "results": [ { "id": "07c891b4-f67a-ed11-9989-0022481ae525", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2022-11-17T00:00:00", "description": "Share Capital", "reconciled": false, "amount": 1, "balance": 1, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "5ced3895-f77a-ed11-9989-0022481b6241", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2022-11-17T00:00:00", "description": "Share Capital", "reconciled": false, "amount": 1, "balance": 2, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "cd12966b-8871-ed11-8c34-6045bd0c6935", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2022-12-02T00:00:00", "description": "", "reconciled": false, "amount": -19, "balance": -17, "transactionType": "Other", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "b13392b6-95a0-ed11-9a88-6045bdd16279", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-01-30T00:00:00", "description": "", "reconciled": false, "amount": -30, "balance": -72, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "b3696a16-1fa2-ed11-9a88-000d3ad59051", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-01-30T00:00:00", "description": "Income, Services", "reconciled": false, "amount": -10, "balance": -122, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "b73392b6-95a0-ed11-9a88-6045bdd16279", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-01-30T00:00:00", "description": "Child", "reconciled": false, "amount": -40, "balance": -112, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "befdd569-22a2-ed11-9a88-000d3ad59051", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-01-30T00:00:00", "description": "Child Child", "reconciled": false, "amount": -13, "balance": -160, "transactionType": "Other", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "cb71c33a-22a2-ed11-9a88-000d3ad59051", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-01-30T00:00:00", "description": "Income, Services", "reconciled": false, "amount": -25, "balance": -147, "transactionType": "Other", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "e7ec12c9-94a0-ed11-9a88-6045bdd16279", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-01-30T00:00:00", "description": "Child Child", "reconciled": false, "amount": -10, "balance": -27, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "fef7a026-95a0-ed11-9a88-6045bdd16279", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-01-30T00:00:00", "description": "", "reconciled": false, "amount": -15, "balance": -42, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "20869cb1-39a2-ed11-9a88-000d3ad59051", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-01T00:00:00", "description": "Accounts Payable", "reconciled": false, "amount": -14, "balance": -184, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "8c298754-20a2-ed11-9a88-000d3ad59051", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-01T00:00:00", "description": "", "reconciled": false, "amount": -10, "balance": -170, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "935d5578-3ca2-ed11-9a88-000d3ad59051", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-01T00:00:00", "description": "", "reconciled": false, "amount": -17, "balance": -201, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "935f4303-e3a2-ed11-9a88-002248010b7e", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-01T00:00:00", "description": "", "reconciled": false, "amount": -17, "balance": -239, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "d8ceb342-dba2-ed11-9a88-002248010b7e", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-01T00:00:00", "description": "", "reconciled": false, "amount": -21, "balance": -222, "transactionType": "Other", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "15719c0c-22a6-ed11-9a88-002248010b7e", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-02T00:00:00", "description": "", "reconciled": false, "amount": -20, "balance": -292.69, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "213d027d-b1a3-ed11-9a88-000d3ad59051", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-02T00:00:00", "description": "", "reconciled": false, "amount": -9.35, "balance": -265.19, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "273d027d-b1a3-ed11-9a88-000d3ad59051", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-02T00:00:00", "description": "Account no cat Balance Sheet", "reconciled": false, "amount": -7.5, "balance": -272.69, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "978c4a27-e0a2-ed11-9a88-002248010b7e", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-02T00:00:00", "description": "", "reconciled": false, "amount": 2.16, "balance": -236.84, "transactionType": "Other", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "a80f63ae-b0a3-ed11-9a88-000d3ad59051", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-02T00:00:00", "description": "", "reconciled": false, "amount": -7.01, "balance": -262.85, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "ad0f63ae-b0a3-ed11-9a88-000d3ad59051", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-02T00:00:00", "description": "Account no cat Balance Sheet", "reconciled": false, "amount": 7.01, "balance": -255.84, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "b5de7b74-afa3-ed11-9a88-000d3ad59051", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-02T00:00:00", "description": "", "reconciled": false, "amount": -4.91, "balance": -260.75, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "bbde7b74-afa3-ed11-9a88-000d3ad59051", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-02T00:00:00", "description": "", "reconciled": false, "amount": 4.91, "balance": -255.84, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "f9540bf4-e5a2-ed11-9a88-000d3ad5d945", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-02T00:00:00", "description": "", "reconciled": false, "amount": -19, "balance": -255.84, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "feca50d8-22a6-ed11-9a88-002248010b7e", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-06T00:00:00", "description": "", "reconciled": false, "amount": -20, "balance": -312.69, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "4777d7ec-cfa6-ed11-9a88-000d3a7fb2e5", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-07T00:00:00", "description": "", "reconciled": false, "amount": -2.34, "balance": -315.03, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "38b632de-7aac-ed11-9a88-002248410639", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-09T00:00:00", "description": "Invalid VAT Posting Setup", "reconciled": false, "amount": -10, "balance": -315.03, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "ffc0b740-68a8-ed11-9a88-6045bdd12fc1", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-09T00:00:00", "description": "", "reconciled": false, "amount": 10, "balance": -305.03, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "95f27455-7cac-ed11-9a88-002248410639", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-14T00:00:00", "description": "", "reconciled": false, "amount": -10, "balance": -325.03, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "0d6b1378-acae-ed11-9a88-6045bdd16279", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-16T00:00:00", "description": "Bank Account Line", "reconciled": false, "amount": -12, "balance": -337.03, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "978da9f7-baae-ed11-9a88-6045bdc1c1f3", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-18T00:00:00", "description": "Bank", "reconciled": false, "amount": 6, "balance": -342.03, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "dd34e6eb-b6ae-ed11-9a88-6045bdc1c1f3", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-18T00:00:00", "description": "G/L", "reconciled": false, "amount": -1, "balance": -338.03, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "e234e6eb-b6ae-ed11-9a88-6045bdc1c1f3", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-18T00:00:00", "description": "Customer", "reconciled": false, "amount": 2, "balance": -336.03, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "e734e6eb-b6ae-ed11-9a88-6045bdc1c1f3", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-18T00:00:00", "description": "Vendor", "reconciled": false, "amount": -3, "balance": -339.03, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "ed34e6eb-b6ae-ed11-9a88-6045bdc1c1f3", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-18T00:00:00", "description": "Bank", "reconciled": false, "amount": -4, "balance": -343.03, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "f234e6eb-b6ae-ed11-9a88-6045bdc1c1f3", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-18T00:00:00", "description": "Employee", "reconciled": false, "amount": -5, "balance": -348.03, "transactionType": "Payment", "modifiedDate": "2023-03-27T14:21:19Z" }, { "id": "39de1293-d3b1-ed11-9a88-6045bd0f94d6", "accountId": "c9a41bc7-6e5b-ed11-8c34-0022481b8b5b", "clearedOnDate": "2023-02-21T00:00:00", "description": "", "reconciled": false, "amount": -10, "balance": -352.03, "transactionType": "Credit", "modifiedDate": "2023-03-27T14:21:19Z" } ], "pageNumber": 1, "pageSize": 100, "totalResults": 37, "_links": { "current": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts/c9a41bc7-6e5b-ed11-8c34-0022481b8b5b/bankTransactions" }, "self": { "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts/c9a41bc7-6e5b-ed11-8c34-0022481b8b5b/bankTransactions" } } } }, "FreeAgent": { "value": { "results": [ { "id": "261197890", "accountId": "738783", "clearedOnDate": "2020-10-28T00:00:00", "description": "Invoice receipt against 1762", "reconciled": true, "amount": 111, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2020-10-28T16:27:10Z" }, { "id": "290878530", "accountId": "738783", "clearedOnDate": "2021-04-23T00:00:00", "description": "Invoice receipt against 1980", "reconciled": true, "amount": 10, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2021-04-27T04:55:42Z" }, { "id": "290825614", "accountId": "738783", "clearedOnDate": "2021-04-26T00:00:00", "description": "Invoice receipt against 1976", "reconciled": true, "amount": 10, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2021-04-26T14:05:15Z" }, { "id": "290878531", "accountId": "738783", "clearedOnDate": "2021-04-26T00:00:00", "description": "Invoice receipt against 1981", "reconciled": true, "amount": 20, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2021-04-27T04:55:44Z" }, { "id": "291227300", "accountId": "738783", "clearedOnDate": "2021-04-28T00:00:00", "description": "Invoice receipt against 2002", "reconciled": true, "amount": 20, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2021-04-28T13:43:56Z" }, { "id": "291242296", "accountId": "738783", "clearedOnDate": "2021-04-28T00:00:00", "description": "Invoice receipt against 2012", "reconciled": true, "amount": 40, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2021-04-28T16:14:16Z" }, { "id": "346437532", "accountId": "738783", "clearedOnDate": "2022-03-21T00:00:00", "description": "Invoice receipt against 2304", "reconciled": true, "amount": 1, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2022-03-21T14:59:40Z" }, { "id": "346444438", "accountId": "738783", "clearedOnDate": "2022-03-21T00:00:00", "description": "Invoice receipt against 2304", "reconciled": true, "amount": 1, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2022-03-21T15:37:54Z" }, { "id": "346444989", "accountId": "738783", "clearedOnDate": "2022-03-21T00:00:00", "description": "Invoice receipt against 2304", "reconciled": true, "amount": 1, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2022-03-21T15:41:22Z" }, { "id": "346457774", "accountId": "738783", "clearedOnDate": "2022-03-21T00:00:00", "description": "Credit Note refund against 2313", "reconciled": true, "amount": -1, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2022-03-21T17:07:50Z" }, { "id": "346458196", "accountId": "738783", "clearedOnDate": "2022-03-21T00:00:00", "description": "Invoice receipt against 2311", "reconciled": true, "amount": 1, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2022-03-21T17:14:15Z" }, { "id": "414441841", "accountId": "738783", "clearedOnDate": "2022-12-20T00:00:00", "description": "MCDONALDS - ROYSTON - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -12.78, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441842", "accountId": "738783", "clearedOnDate": "2022-12-20T00:00:00", "description": "HERMES PARCELNET LTD T/A - 08445437147 - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -7.98, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441845", "accountId": "738783", "clearedOnDate": "2022-12-20T00:00:00", "description": "TRAVELODGE GB0000 - THAME - Card Ending: 4999//OTHER/", "reconciled": false, "amount": -648.63, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441847", "accountId": "738783", "clearedOnDate": "2022-12-20T00:00:00", "description": "TRAVELODGE GB0000 - THAME - Card Ending: 4999//OTHER/", "reconciled": false, "amount": -324.31, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441849", "accountId": "738783", "clearedOnDate": "2022-12-20T00:00:00", "description": "RUGBY, PRET A MANGER - RUGBY - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -11.45, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441851", "accountId": "738783", "clearedOnDate": "2022-12-20T00:00:00", "description": "Just Eat - London - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -22.52, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441852", "accountId": "738783", "clearedOnDate": "2022-12-20T00:00:00", "description": "CN TAR TAROM SA-MOBILP - ORAS OTOPENI - Card Ending: 4999//OTHER/", "reconciled": false, "amount": -340.13, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441854", "accountId": "738783", "clearedOnDate": "2022-12-21T00:00:00", "description": "MOTO RUGBY SERVICES - RUGBY - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -126.12, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441855", "accountId": "738783", "clearedOnDate": "2022-12-21T00:00:00", "description": "POMANDA.COM - 138 HOLBORN, - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -9.99, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441856", "accountId": "738783", "clearedOnDate": "2022-12-21T00:00:00", "description": "RYANAIR 224BEZ3YM - LONDON - Card Ending: 4999//OTHER/", "reconciled": false, "amount": -267.97, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441857", "accountId": "738783", "clearedOnDate": "2022-12-21T00:00:00", "description": "TESCO STORES 5956 - LONDON - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -9.35, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441859", "accountId": "738783", "clearedOnDate": "2022-12-21T00:00:00", "description": "SPOTIFY - LONDON - Card Ending: 4999//OTHER/", "reconciled": false, "amount": -16.99, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441860", "accountId": "738783", "clearedOnDate": "2022-12-21T00:00:00", "description": "Revive My Device - London - Card Ending: 5913//OTHER/", "reconciled": false, "amount": -149, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441861", "accountId": "738783", "clearedOnDate": "2022-12-22T00:00:00", "description": "DELIVEROO - LONDON - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -39.36, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441862", "accountId": "738783", "clearedOnDate": "2022-12-22T00:00:00", "description": "UPS LTD - FELTHAM - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -2.4, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:33Z" }, { "id": "414441863", "accountId": "738783", "clearedOnDate": "2022-12-22T00:00:00", "description": "Amazon.co.uk*1N0N04VK4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -17.76, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441864", "accountId": "738783", "clearedOnDate": "2022-12-22T00:00:00", "description": "TESCO STORES 5956 - LONDON - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -10.65, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441865", "accountId": "738783", "clearedOnDate": "2022-12-22T00:00:00", "description": "GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -16.75, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441866", "accountId": "738783", "clearedOnDate": "2022-12-22T00:00:00", "description": "GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -4.55, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441867", "accountId": "738783", "clearedOnDate": "2022-12-22T00:00:00", "description": "TRAVELODGE GB0937 - LONDON - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -10.75, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441868", "accountId": "738783", "clearedOnDate": "2022-12-22T00:00:00", "description": "DELIVEROO - LONDON - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -34.2, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441869", "accountId": "738783", "clearedOnDate": "2022-12-22T00:00:00", "description": "TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/", "reconciled": false, "amount": -2.8, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441870", "accountId": "738783", "clearedOnDate": "2022-12-23T00:00:00", "description": "SIDS DIY - LONDON E1 - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -5.99, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441871", "accountId": "738783", "clearedOnDate": "2022-12-23T00:00:00", "description": "RESOLUTION GB LTD - WHITCHURCH - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -368.72, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441872", "accountId": "738783", "clearedOnDate": "2022-12-23T00:00:00", "description": "GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -6.15, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441874", "accountId": "738783", "clearedOnDate": "2022-12-23T00:00:00", "description": "HERMES PARCELNET LTD T/A - 08445437147 - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -5.34, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441875", "accountId": "738783", "clearedOnDate": "2022-12-23T00:00:00", "description": "Refund: SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/", "reconciled": false, "amount": 6.8, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441876", "accountId": "738783", "clearedOnDate": "2022-12-23T00:00:00", "description": "Refund: SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/", "reconciled": false, "amount": 12.49, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441877", "accountId": "738783", "clearedOnDate": "2022-12-23T00:00:00", "description": "SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -6.5, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441878", "accountId": "738783", "clearedOnDate": "2022-12-23T00:00:00", "description": "SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -27.15, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441879", "accountId": "738783", "clearedOnDate": "2022-12-23T00:00:00", "description": "GOODMANS FIELD - LONDON - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -8, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441880", "accountId": "738783", "clearedOnDate": "2022-12-23T00:00:00", "description": "GOODMANS FIELD - LONDON - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -25.7, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441881", "accountId": "738783", "clearedOnDate": "2022-12-23T00:00:00", "description": "CREAMLINE DAIRIES ONLINE - MANCHESTER - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -50, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:34Z" }, { "id": "414441883", "accountId": "738783", "clearedOnDate": "2022-12-24T00:00:00", "description": "AIRBNB * HMYDEXRY4N - 203-318-1111 - Card Ending: 5913//OTHER/", "reconciled": false, "amount": -388.24, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441884", "accountId": "738783", "clearedOnDate": "2022-12-24T00:00:00", "description": "UPS LTD - FELTHAM - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -9.35, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441886", "accountId": "738783", "clearedOnDate": "2022-12-24T00:00:00", "description": "UBER *TRIP - HELP.UBER.COM - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -11.9, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441889", "accountId": "738783", "clearedOnDate": "2022-12-24T00:00:00", "description": "UBER *TRIP - HELP.UBER.COM - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -6.84, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441891", "accountId": "738783", "clearedOnDate": "2022-12-24T00:00:00", "description": "WELCOME BREAK - NEWPORT PAGNE - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -102.23, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441892", "accountId": "738783", "clearedOnDate": "2022-12-24T00:00:00", "description": "SUBWAY 63582 London Gatew - Mill Hill, Lo - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -15.38, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441893", "accountId": "738783", "clearedOnDate": "2022-12-26T00:00:00", "description": "UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -40.65, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441894", "accountId": "738783", "clearedOnDate": "2022-12-26T00:00:00", "description": "UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -2, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441895", "accountId": "738783", "clearedOnDate": "2022-12-26T00:00:00", "description": "UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -34.06, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441897", "accountId": "738783", "clearedOnDate": "2022-12-26T00:00:00", "description": "UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -2, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441901", "accountId": "738783", "clearedOnDate": "2022-12-28T00:00:00", "description": "Tesla - West Drayton - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -9.99, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441904", "accountId": "738783", "clearedOnDate": "2022-12-28T00:00:00", "description": "Box Deansgate - Manchester - Card Ending: 0614//OTHER/", "reconciled": false, "amount": -20.65, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441906", "accountId": "738783", "clearedOnDate": "2022-12-28T00:00:00", "description": "MANCHESTER UNITED KIOSK - MANCHESTER - Card Ending: 0614//OTHER/", "reconciled": false, "amount": -26.5, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441908", "accountId": "738783", "clearedOnDate": "2022-12-29T00:00:00", "description": "TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/", "reconciled": false, "amount": -2.8, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441909", "accountId": "738783", "clearedOnDate": "2022-12-31T00:00:00", "description": "TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/", "reconciled": false, "amount": -1.65, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441910", "accountId": "738783", "clearedOnDate": "2023-01-01T00:00:00", "description": "UBER* TRIP - LONDON - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -2, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441911", "accountId": "738783", "clearedOnDate": "2023-01-01T00:00:00", "description": "UBER* TRIP - LONDON - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -11.95, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:35Z" }, { "id": "414441912", "accountId": "738783", "clearedOnDate": "2023-01-02T00:00:00", "description": "UBER* TRIP - LONDON - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -13.68, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441913", "accountId": "738783", "clearedOnDate": "2023-01-02T00:00:00", "description": "WWW.KASHFLOW.COM - DATCHET - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -22.8, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441914", "accountId": "738783", "clearedOnDate": "2023-01-02T00:00:00", "description": "UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -9.14, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441915", "accountId": "738783", "clearedOnDate": "2023-01-02T00:00:00", "description": "GOOGLE*GSUITE ISOMI.CO - DUBLIN 2 - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -216.2, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441916", "accountId": "738783", "clearedOnDate": "2023-01-03T00:00:00", "description": "Refund: AMZ*quickpickdeals - amazon.co.uk - Card Ending: 4999//OTHER/", "reconciled": false, "amount": 10.97, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441917", "accountId": "738783", "clearedOnDate": "2023-01-04T00:00:00", "description": "Finance Charge//OTHER/", "reconciled": false, "amount": -0.41, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441918", "accountId": "738783", "clearedOnDate": "2023-01-04T00:00:00", "description": "WWW.KASHFLOW.COM - DATCHET - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -22.8, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441919", "accountId": "738783", "clearedOnDate": "2023-01-04T00:00:00", "description": "ACCU.CO.UK - HUDDERSFIELD - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -86.34, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441920", "accountId": "738783", "clearedOnDate": "2023-01-04T00:00:00", "description": "ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -6.5, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441922", "accountId": "738783", "clearedOnDate": "2023-01-04T00:00:00", "description": "AMAZON PRIME*164AU3UZ4 AM - AMZN.CO.UK/PM - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -96, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441924", "accountId": "738783", "clearedOnDate": "2023-01-05T00:00:00", "description": "Amazon.co.uk*162DC7II4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -44.62, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441926", "accountId": "738783", "clearedOnDate": "2023-01-05T00:00:00", "description": "trainline - +443332022222 - Card Ending: 5913//OTHER/", "reconciled": false, "amount": -65.46, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441931", "accountId": "738783", "clearedOnDate": "2023-01-05T00:00:00", "description": "VITAL PARTS LTD - MAIDSTONE - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -124.35, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441934", "accountId": "738783", "clearedOnDate": "2023-01-05T00:00:00", "description": "Amazon.co.uk*168E49IU4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -2.52, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441935", "accountId": "738783", "clearedOnDate": "2023-01-05T00:00:00", "description": "ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -108.16, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441936", "accountId": "738783", "clearedOnDate": "2023-01-05T00:00:00", "description": "Refund: ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/", "reconciled": false, "amount": 22.96, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441937", "accountId": "738783", "clearedOnDate": "2023-01-05T00:00:00", "description": "Amazon.co.uk*1H31B0CO4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -20.52, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:36Z" }, { "id": "414441939", "accountId": "738783", "clearedOnDate": "2023-01-05T00:00:00", "description": "Amazon.co.uk*1H4GR4CH4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -13.69, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441941", "accountId": "738783", "clearedOnDate": "2023-01-05T00:00:00", "description": "Amazon.co.uk*162V47WY4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -16.83, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441945", "accountId": "738783", "clearedOnDate": "2023-01-05T00:00:00", "description": "Amazon.co.uk*160J00WI4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -17.68, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441946", "accountId": "738783", "clearedOnDate": "2023-01-06T00:00:00", "description": "Amazon.co.uk*1692Y9YY4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -29.74, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441947", "accountId": "738783", "clearedOnDate": "2023-01-06T00:00:00", "description": "Amazon.co.uk*166I62Y14 - AMAZON.CO.UK - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -29.74, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441948", "accountId": "738783", "clearedOnDate": "2023-01-06T00:00:00", "description": "GMELIUS GROWTH - MEYRIN - Card Ending: 5913//OTHER/", "reconciled": false, "amount": -121.3, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441949", "accountId": "738783", "clearedOnDate": "2023-01-07T00:00:00", "description": "ACCU.CO.UK - HUDDERSFIELD - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -116.34, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441950", "accountId": "738783", "clearedOnDate": "2023-01-07T00:00:00", "description": "AMZNMktplace - amazon.co.uk - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -66.79, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441951", "accountId": "738783", "clearedOnDate": "2023-01-07T00:00:00", "description": "TOOLSTATION UK - NORTHAMPTON - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -77.88, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441952", "accountId": "738783", "clearedOnDate": "2023-01-07T00:00:00", "description": "SHELL CHESTER - CHESTER - Card Ending: 9271//OTHER/", "reconciled": false, "amount": -112.24, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441953", "accountId": "738783", "clearedOnDate": "2023-01-08T00:00:00", "description": "BRITISH A 1252150515112 - LONDON - Card Ending: 4999//OTHER/", "reconciled": false, "amount": -450.85, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441954", "accountId": "738783", "clearedOnDate": "2023-01-08T00:00:00", "description": "BRITISH A 1254217966962 - LONDON - Card Ending: 4999//OTHER/", "reconciled": false, "amount": -65, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441955", "accountId": "738783", "clearedOnDate": "2023-01-08T00:00:00", "description": "TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/", "reconciled": false, "amount": -3.3, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441956", "accountId": "738783", "clearedOnDate": "2023-01-09T00:00:00", "description": "Amazon.co.uk*1H97Y6TL4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -17.45, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441957", "accountId": "738783", "clearedOnDate": "2023-01-09T00:00:00", "description": "UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -15.03, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441959", "accountId": "738783", "clearedOnDate": "2023-01-09T00:00:00", "description": "UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/", "reconciled": false, "amount": -16.43, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441960", "accountId": "738783", "clearedOnDate": "2023-01-09T00:00:00", "description": "Payment made (BACS)//OTHER/", "reconciled": false, "amount": 5000, "transactionType": "Credit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:37Z" }, { "id": "414441961", "accountId": "738783", "clearedOnDate": "2023-01-10T00:00:00", "description": "AMZNMktplace - amazon.co.uk - Card Ending: 2327//OTHER/", "reconciled": false, "amount": -32.57, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:38Z" }, { "id": "414441962", "accountId": "738783", "clearedOnDate": "2023-01-10T00:00:00", "description": "TESCO STORES - LONDON - Card Ending: 5913//OTHER/", "reconciled": false, "amount": -3.9, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:38Z" }, { "id": "414441963", "accountId": "738783", "clearedOnDate": "2023-01-10T00:00:00", "description": "VICTORIA INN - PECKHAM - Card Ending: 5913//OTHER/", "reconciled": false, "amount": -15.5, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:38Z" }, { "id": "414441965", "accountId": "738783", "clearedOnDate": "2023-01-10T00:00:00", "description": "TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/", "reconciled": false, "amount": -7.7, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:38Z" }, { "id": "414441967", "accountId": "738783", "clearedOnDate": "2023-01-10T00:00:00", "description": "PRET A MANGER - 326 - Card Ending: 5913//OTHER/", "reconciled": false, "amount": -13.8, "transactionType": "Debit", "modifiedDate": "2023-04-25T14:21:41Z", "sourceModifiedDate": "2023-02-08T09:05:38Z" } ], "pageNumber": 1, "pageSize": 100, "totalResults": 153, "_links": { "current": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions" }, "self": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions" }, "next": { "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions?page=2&pageSize=100" } } } }, "KashFlow": { "value": { "results": [ { "id": "765768:137014109", "accountId": "765768", "clearedOnDate": "2020-04-28T00:00:00", "description": "FIRST Transaction", "reconciled": false, "amount": 100, "transactionType": "Unknown", "modifiedDate": "2022-09-30T10:29:15Z" }, { "id": "765768:137014143", "accountId": "765768", "clearedOnDate": "2020-04-28T00:00:00", "description": "SECOND Transaction", "reconciled": false, "amount": 120, "transactionType": "Unknown", "modifiedDate": "2022-09-30T10:29:15Z" }, { "id": "765768:93269803", "accountId": "765768", "clearedOnDate": "2020-04-28T00:00:00", "description": "KF00021:", "reconciled": false, "amount": -5, "transactionType": "Unknown", "modifiedDate": "2022-09-30T10:29:15Z" }, { "id": "765768:141203309", "accountId": "765768", "clearedOnDate": "2020-06-18T00:00:00", "description": "INV #33: Customer overpayment", "reconciled": false, "amount": 110, "transactionType": "Unknown", "modifiedDate": "2022-09-30T10:29:15Z" }, { "id": "765768:144653342", "accountId": "765768", "clearedOnDate": "2020-10-23T00:00:00", "description": "", "reconciled": false, "amount": 1, "transactionType": "Unknown", "modifiedDate": "2022-09-30T10:29:15Z" } ], "pageNumber": 1, "pageSize": 100, "totalResults": 5, "_links": { "current": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts/765768/bankTransactions" }, "self": { "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts/765768/bankTransactions" } } } }, "QuickBooks Desktop": { "value": { "results": [ { "id": "D7B-933784104", "accountId": "20000-933270541", "clearedOnDate": "2022-12-01T00:00:00", "description": "", "reconciled": false, "amount": -1200, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:04:10" }, { "id": "DFA-933785132", "accountId": "20000-933270541", "clearedOnDate": "2022-12-05T00:00:00", "description": "", "reconciled": false, "amount": -35, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:04:11" }, { "id": "E2E-933785785", "accountId": "20000-933270541", "clearedOnDate": "2022-12-10T00:00:00", "description": "", "reconciled": false, "amount": -197.59, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:04:11" }, { "id": "536B-1197755199", "accountId": "20000-933270541", "clearedOnDate": "2022-12-20T00:00:00", "description": "", "reconciled": false, "amount": -2100, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:05:47" }, { "id": "5C18-1197711471-to", "accountId": "20000-933270541", "clearedOnDate": "2022-12-31T00:00:00", "description": "Opening Balance - Bank Balance - Checking Account", "reconciled": false, "amount": 27874.62, "transactionType": "Other", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:06" }, { "id": "3A09-1071529982", "accountId": "20000-933270541", "clearedOnDate": "2023-01-11T00:00:00", "description": "Monthly Truck Payment", "reconciled": false, "amount": -532.97, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:04:58" }, { "id": "95C6-1197729008", "accountId": "20000-933270541", "clearedOnDate": "2023-01-15T00:00:00", "description": "941 Deposit for December 2005 Payyroll", "reconciled": false, "amount": -3495.82, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:19" }, { "id": "95CA-1197729081", "accountId": "20000-933270541", "clearedOnDate": "2023-01-15T00:00:00", "description": "FUTA Payment - 4 Qrt 2005", "reconciled": false, "amount": -100, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:19" }, { "id": "95D0-1197729222", "accountId": "20000-933270541", "clearedOnDate": "2023-01-15T00:00:00", "description": "State Unemployment and Disability - 4th Quarter 2005", "reconciled": false, "amount": -208.09, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:19" }, { "id": "95D4-1197729376", "accountId": "20000-933270541", "clearedOnDate": "2023-01-15T00:00:00", "description": "Worker's Compensation - 4th Quarter 2005", "reconciled": false, "amount": -1214.31, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:19" }, { "id": "9C06-1181931827", "accountId": "20000-933270541", "clearedOnDate": "2023-01-15T00:00:00", "description": "Deposit", "reconciled": false, "amount": 1228.18, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:23" }, { "id": "9E3A-1182063799", "accountId": "20000-933270541", "clearedOnDate": "2023-01-15T00:00:00", "description": "", "reconciled": false, "amount": -308.34, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:30" }, { "id": "A293-1197953458", "accountId": "20000-933270541", "clearedOnDate": "2023-01-15T00:00:00", "description": "", "reconciled": false, "amount": -12362.89, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "A2AB-1197953786", "accountId": "20000-933270541", "clearedOnDate": "2023-01-15T00:00:00", "description": "", "reconciled": false, "amount": -9521, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "A33E-1197955762", "accountId": "20000-933270541", "clearedOnDate": "2023-01-15T00:00:00", "description": "ABCD 11-234567", "reconciled": false, "amount": -3146.88, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:36" }, { "id": "6992-1197775718", "accountId": "20000-933270541", "clearedOnDate": "2023-01-17T00:00:00", "description": "Deposit", "reconciled": false, "amount": 15281.67, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:11" }, { "id": "3E5D-1071498699", "accountId": "20000-933270541", "clearedOnDate": "2023-01-21T00:00:00", "description": "786-35", "reconciled": false, "amount": -712.56, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:05:09" }, { "id": "699D-1197775731", "accountId": "20000-933270541", "clearedOnDate": "2023-01-25T00:00:00", "description": "Deposit", "reconciled": false, "amount": 31474.25, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:11" }, { "id": "53D-933354764", "accountId": "20000-933270541", "clearedOnDate": "2023-01-31T00:00:00", "description": "Monthly Water - Flat Rate Plan", "reconciled": false, "amount": -24, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:04:00" }, { "id": "9E3D-1182131998", "accountId": "20000-933270541", "clearedOnDate": "2023-01-31T00:00:00", "description": "", "reconciled": false, "amount": -205, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:30" }, { "id": "9E42-1182131999", "accountId": "20000-933270541", "clearedOnDate": "2023-01-31T00:00:00", "description": "", "reconciled": false, "amount": -532, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:30" }, { "id": "9E47-1182131999", "accountId": "20000-933270541", "clearedOnDate": "2023-01-31T00:00:00", "description": "", "reconciled": false, "amount": -623, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:30" }, { "id": "9E4C-1182131999", "accountId": "20000-933270541", "clearedOnDate": "2023-01-31T00:00:00", "description": "", "reconciled": false, "amount": -13759, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:30" }, { "id": "9ED6-1182133365", "accountId": "20000-933270541", "clearedOnDate": "2023-01-31T00:00:00", "description": "Fuel", "reconciled": false, "amount": -138, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:32" }, { "id": "9F2D-1197948760", "accountId": "20000-933270541", "clearedOnDate": "2023-01-31T00:00:00", "description": "Monthly Vehicle Repairs and Maintenance", "reconciled": false, "amount": -218, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9F96-1197949640", "accountId": "20000-933270541", "clearedOnDate": "2023-01-31T00:00:00", "description": "Acct #560-82645-99C", "reconciled": false, "amount": -123.67, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "A2CD-1197955250", "accountId": "20000-933270541", "clearedOnDate": "2023-01-31T00:00:00", "description": "Pmt# 1", "reconciled": false, "amount": -2710.9, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:36" }, { "id": "F29-933787474", "accountId": "20000-933270541", "clearedOnDate": "2023-01-31T00:00:00", "description": "Checking Account Service Charge", "reconciled": false, "amount": -12.5, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:04:13" }, { "id": "698D-1197775698", "accountId": "20000-933270541", "clearedOnDate": "2023-02-02T00:00:00", "description": "Deposit", "reconciled": false, "amount": 1040, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:11" }, { "id": "69A8-1197775740", "accountId": "20000-933270541", "clearedOnDate": "2023-02-09T00:00:00", "description": "Deposit", "reconciled": false, "amount": 271.53, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:11" }, { "id": "3A10-1071529997", "accountId": "20000-933270541", "clearedOnDate": "2023-02-11T00:00:00", "description": "Monthly Truck Payment", "reconciled": false, "amount": -532.97, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:04:58" }, { "id": "A0BD-1197950967", "accountId": "20000-933270541", "clearedOnDate": "2023-02-15T00:00:00", "description": "", "reconciled": false, "amount": -268.39, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "A2AF-1197953842", "accountId": "20000-933270541", "clearedOnDate": "2023-02-15T00:00:00", "description": "", "reconciled": false, "amount": -4050.98, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "A343-1197955826", "accountId": "20000-933270541", "clearedOnDate": "2023-02-15T00:00:00", "description": "ABCD 11-234567", "reconciled": false, "amount": -1466.32, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:36" }, { "id": "9C0B-1181931843", "accountId": "20000-933270541", "clearedOnDate": "2023-02-28T00:00:00", "description": "Deposit", "reconciled": false, "amount": 25471.56, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:23" }, { "id": "9E63-1182132109", "accountId": "20000-933270541", "clearedOnDate": "2023-02-28T00:00:00", "description": "For Vetter Basement Remodel", "reconciled": false, "amount": -2050, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:30" }, { "id": "9ED9-1182133383", "accountId": "20000-933270541", "clearedOnDate": "2023-02-28T00:00:00", "description": "Fuel", "reconciled": false, "amount": -142, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:32" }, { "id": "9F33-1197948806", "accountId": "20000-933270541", "clearedOnDate": "2023-02-28T00:00:00", "description": "Monthly Vechiicle Repairs and Maintenance", "reconciled": false, "amount": -222, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9F99-1197949656", "accountId": "20000-933270541", "clearedOnDate": "2023-02-28T00:00:00", "description": "Acct #560-82645-99C", "reconciled": false, "amount": -125.89, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9FBD-1197949852", "accountId": "20000-933270541", "clearedOnDate": "2023-02-28T00:00:00", "description": "Monthly Water - Flat Rate Plan", "reconciled": false, "amount": -24, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:34" }, { "id": "A052-1197950680", "accountId": "20000-933270541", "clearedOnDate": "2023-02-28T00:00:00", "description": "Flat Rate Phone and Long Distance Bundle", "reconciled": false, "amount": -80, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:34" }, { "id": "A081-1197950831", "accountId": "20000-933270541", "clearedOnDate": "2023-02-28T00:00:00", "description": "Checking Account Service Charge", "reconciled": false, "amount": -12.5, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "A2D1-1197955271", "accountId": "20000-933270541", "clearedOnDate": "2023-02-28T00:00:00", "description": "Pmt# 2", "reconciled": false, "amount": -2710.9, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:36" }, { "id": "3A17-1071530007", "accountId": "20000-933270541", "clearedOnDate": "2023-03-11T00:00:00", "description": "Monthly Truck Payment", "reconciled": false, "amount": -532.97, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:04:58" }, { "id": "9C38-1182054225", "accountId": "20000-933270541", "clearedOnDate": "2023-03-13T00:00:00", "description": "", "reconciled": false, "amount": -7500, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:24" }, { "id": "A296-1197953484", "accountId": "20000-933270541", "clearedOnDate": "2023-03-15T00:00:00", "description": "", "reconciled": false, "amount": -1600, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "A346-1197955854", "accountId": "20000-933270541", "clearedOnDate": "2023-03-15T00:00:00", "description": "ABCD 11-234567", "reconciled": false, "amount": -83.6, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:36" }, { "id": "9C10-1181931855", "accountId": "20000-933270541", "clearedOnDate": "2023-03-20T00:00:00", "description": "Deposit", "reconciled": false, "amount": 6278.8, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:23" }, { "id": "9E72-1182132247", "accountId": "20000-933270541", "clearedOnDate": "2023-03-31T00:00:00", "description": "", "reconciled": false, "amount": -435, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:30" }, { "id": "9EDC-1182133383", "accountId": "20000-933270541", "clearedOnDate": "2023-03-31T00:00:00", "description": "Fuel", "reconciled": false, "amount": -127, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:32" }, { "id": "9F36-1197948806", "accountId": "20000-933270541", "clearedOnDate": "2023-03-31T00:00:00", "description": "Monthly Vechiicle Repairs and Maintenance", "reconciled": false, "amount": -232, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9F7B-1197949443", "accountId": "20000-933270541", "clearedOnDate": "2023-03-31T00:00:00", "description": "Payment - Quarterly Office Maintenance Contract", "reconciled": false, "amount": -450, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9F9C-1197949656", "accountId": "20000-933270541", "clearedOnDate": "2023-03-31T00:00:00", "description": "Acct #560-82645-99C", "reconciled": false, "amount": -389.2, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9FC0-1197949852", "accountId": "20000-933270541", "clearedOnDate": "2023-03-31T00:00:00", "description": "Monthly Water - Flat Rate Plan", "reconciled": false, "amount": -24, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:34" }, { "id": "A056-1197950680", "accountId": "20000-933270541", "clearedOnDate": "2023-03-31T00:00:00", "description": "Flat Rate Phone and Long Distance Bundle", "reconciled": false, "amount": -80, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:34" }, { "id": "A084-1197950832", "accountId": "20000-933270541", "clearedOnDate": "2023-03-31T00:00:00", "description": "Checking Account Service Charge", "reconciled": false, "amount": -12.5, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "A2D5-1197955280", "accountId": "20000-933270541", "clearedOnDate": "2023-03-31T00:00:00", "description": "Pmt# 3", "reconciled": false, "amount": -2710.9, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:36" }, { "id": "3A1E-1071530019", "accountId": "20000-933270541", "clearedOnDate": "2023-04-12T00:00:00", "description": "Monthly Truck Payment", "reconciled": false, "amount": -532.97, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:04:58" }, { "id": "4271-1071523732", "accountId": "20000-933270541", "clearedOnDate": "2023-04-17T00:00:00", "description": "", "reconciled": false, "amount": -714, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:05:32" }, { "id": "3E98-1071499056", "accountId": "20000-933270541", "clearedOnDate": "2023-04-19T00:00:00", "description": "786-35", "reconciled": false, "amount": -712.56, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:05:11" }, { "id": "9C68-1182054440", "accountId": "20000-933270541", "clearedOnDate": "2023-04-20T00:00:00", "description": "Deposit", "reconciled": false, "amount": 16500, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:24" }, { "id": "9EDF-1182133383", "accountId": "20000-933270541", "clearedOnDate": "2023-04-30T00:00:00", "description": "Fuel", "reconciled": false, "amount": -162, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:32" }, { "id": "9F39-1197948806", "accountId": "20000-933270541", "clearedOnDate": "2023-04-30T00:00:00", "description": "Monthly Vechiicle Repairs and Maintenance", "reconciled": false, "amount": -192, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9F9F-1197949656", "accountId": "20000-933270541", "clearedOnDate": "2023-04-30T00:00:00", "description": "Acct #560-82645-99C", "reconciled": false, "amount": -120.93, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9FC3-1197949852", "accountId": "20000-933270541", "clearedOnDate": "2023-04-30T00:00:00", "description": "Monthly Water - Flat Rate Plan", "reconciled": false, "amount": -24, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:34" }, { "id": "A05A-1197950680", "accountId": "20000-933270541", "clearedOnDate": "2023-04-30T00:00:00", "description": "Flat Rate Phone and Long Distance Bundle", "reconciled": false, "amount": -80, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:34" }, { "id": "A087-1197950832", "accountId": "20000-933270541", "clearedOnDate": "2023-04-30T00:00:00", "description": "Checking Account Service Charge", "reconciled": false, "amount": -12.5, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "A2D9-1197955286", "accountId": "20000-933270541", "clearedOnDate": "2023-04-30T00:00:00", "description": "Pmt# 4", "reconciled": false, "amount": -2710.9, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:36" }, { "id": "9C86-1182054823", "accountId": "20000-933270541", "clearedOnDate": "2023-05-01T00:00:00", "description": "", "reconciled": false, "amount": -7500, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:24" }, { "id": "3A25-1071530029", "accountId": "20000-933270541", "clearedOnDate": "2023-05-13T00:00:00", "description": "Monthly Truck Payment", "reconciled": false, "amount": -532.97, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:04:59" }, { "id": "A0C0-1197950991", "accountId": "20000-933270541", "clearedOnDate": "2023-05-15T00:00:00", "description": "", "reconciled": false, "amount": -950.23, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "A299-1197953515", "accountId": "20000-933270541", "clearedOnDate": "2023-05-15T00:00:00", "description": "", "reconciled": false, "amount": -1400, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "A349-1197955899", "accountId": "20000-933270541", "clearedOnDate": "2023-05-15T00:00:00", "description": "ABCD 11-234567", "reconciled": false, "amount": -318.02, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:36" }, { "id": "9CB8-1182055085", "accountId": "20000-933270541", "clearedOnDate": "2023-05-31T00:00:00", "description": "Deposit", "reconciled": false, "amount": 16500, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:25" }, { "id": "9EE2-1182133383", "accountId": "20000-933270541", "clearedOnDate": "2023-05-31T00:00:00", "description": "Fuel", "reconciled": false, "amount": -143, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:32" }, { "id": "9F3C-1197948806", "accountId": "20000-933270541", "clearedOnDate": "2023-05-31T00:00:00", "description": "Monthly Vechiicle Repairs and Maintenance", "reconciled": false, "amount": -232, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9FA2-1197949656", "accountId": "20000-933270541", "clearedOnDate": "2023-05-31T00:00:00", "description": "Acct #560-82645-99C", "reconciled": false, "amount": -128.03, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9FC6-1197949852", "accountId": "20000-933270541", "clearedOnDate": "2023-05-31T00:00:00", "description": "Monthly Water - Flat Rate Plan", "reconciled": false, "amount": -24, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:34" }, { "id": "A05E-1197950680", "accountId": "20000-933270541", "clearedOnDate": "2023-05-31T00:00:00", "description": "Flat Rate Phone and Long Distance Bundle", "reconciled": false, "amount": -80, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:34" }, { "id": "A08A-1197950832", "accountId": "20000-933270541", "clearedOnDate": "2023-05-31T00:00:00", "description": "Checking Account Service Charge", "reconciled": false, "amount": -12.5, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "A2DD-1197955294", "accountId": "20000-933270541", "clearedOnDate": "2023-05-31T00:00:00", "description": "Pmt# 5", "reconciled": false, "amount": -2710.9, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:36" }, { "id": "9CBD-1182055262", "accountId": "20000-933270541", "clearedOnDate": "2023-06-06T00:00:00", "description": "", "reconciled": false, "amount": -5275, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:25" }, { "id": "3A2C-1071530042", "accountId": "20000-933270541", "clearedOnDate": "2023-06-10T00:00:00", "description": "Monthly Truck Payment", "reconciled": false, "amount": -532.97, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:04:59" }, { "id": "5356-1197761596", "accountId": "20000-933270541", "clearedOnDate": "2023-06-16T00:00:00", "description": "", "reconciled": false, "amount": -1786, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:05:46" }, { "id": "9EE5-1182133383", "accountId": "20000-933270541", "clearedOnDate": "2023-06-30T00:00:00", "description": "Fuel", "reconciled": false, "amount": -157, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:32" }, { "id": "9F3F-1197948806", "accountId": "20000-933270541", "clearedOnDate": "2023-06-30T00:00:00", "description": "Monthly Vechiicle Repairs and Maintenance", "reconciled": false, "amount": -186, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9F7E-1197949458", "accountId": "20000-933270541", "clearedOnDate": "2023-06-30T00:00:00", "description": "Payment - Quarterly Office Maintenance Contract", "reconciled": false, "amount": -450, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9FA5-1197949656", "accountId": "20000-933270541", "clearedOnDate": "2023-06-30T00:00:00", "description": "Acct #560-82645-99C", "reconciled": false, "amount": -135.02, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9FC9-1197949852", "accountId": "20000-933270541", "clearedOnDate": "2023-06-30T00:00:00", "description": "Monthly Water - Flat Rate Plan", "reconciled": false, "amount": -24, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:34" }, { "id": "A062-1197950680", "accountId": "20000-933270541", "clearedOnDate": "2023-06-30T00:00:00", "description": "Flat Rate Phone and Long Distance Bundle", "reconciled": false, "amount": -80, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:34" }, { "id": "A08D-1197950832", "accountId": "20000-933270541", "clearedOnDate": "2023-06-30T00:00:00", "description": "Checking Account Service Charge", "reconciled": false, "amount": -12.5, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "A2E1-1197955306", "accountId": "20000-933270541", "clearedOnDate": "2023-06-30T00:00:00", "description": "Pmt# 6", "reconciled": false, "amount": -2710.9, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:36" }, { "id": "3A33-1071530066", "accountId": "20000-933270541", "clearedOnDate": "2023-07-11T00:00:00", "description": "Monthly Truck Payment", "reconciled": false, "amount": -532.97, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:04:59" }, { "id": "3E67-1071498733", "accountId": "20000-933270541", "clearedOnDate": "2023-07-19T00:00:00", "description": "786-35", "reconciled": false, "amount": -712.56, "transactionType": "Unknown", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:05:09" }, { "id": "A0C3-1197951027", "accountId": "20000-933270541", "clearedOnDate": "2023-07-23T00:00:00", "description": "", "reconciled": false, "amount": -239.29, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:35" }, { "id": "9EE8-1182133383", "accountId": "20000-933270541", "clearedOnDate": "2023-07-31T00:00:00", "description": "Fuel", "reconciled": false, "amount": -126, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:32" }, { "id": "9F42-1197948806", "accountId": "20000-933270541", "clearedOnDate": "2023-07-31T00:00:00", "description": "Monthly Vechiicle Repairs and Maintenance", "reconciled": false, "amount": -126, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9FA8-1197949656", "accountId": "20000-933270541", "clearedOnDate": "2023-07-31T00:00:00", "description": "Acct #560-82645-99C", "reconciled": false, "amount": -128.03, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:33" }, { "id": "9FCC-1197949852", "accountId": "20000-933270541", "clearedOnDate": "2023-07-31T00:00:00", "description": "Monthly Water - Flat Rate Plan", "reconciled": false, "amount": -24, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:34" }, { "id": "A066-1197950680", "accountId": "20000-933270541", "clearedOnDate": "2023-07-31T00:00:00", "description": "Flat Rate Phone and Long Distance Bundle", "reconciled": false, "amount": -80, "transactionType": "Payment", "modifiedDate": "2023-04-26T09:07:14Z", "sourceModifiedDate": "2023-12-16T05:06:34" } ], "pageNumber": 1, "pageSize": 100, "totalResults": 495, "_links": { "current": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions" }, "self": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions" }, "next": { "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions?page=2&pageSize=100" } } } }, "Sage 50 (UK)": { "value": { "results": [ { "id": "73", "accountId": "1200", "clearedOnDate": "2021-01-29T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -162, "balance": -10164.54, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "52", "accountId": "1200", "clearedOnDate": "2021-01-30T00:00:00", "description": "568953", "reconciled": false, "amount": -1497.58, "balance": -10302.54, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "53", "accountId": "1200", "clearedOnDate": "2021-01-30T00:00:00", "description": "5897532", "reconciled": false, "amount": 500, "balance": -9802.54, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "54", "accountId": "1200", "clearedOnDate": "2021-01-30T00:00:00", "description": "TRANS", "reconciled": false, "amount": -250, "balance": -10052.54, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "58", "accountId": "1200", "clearedOnDate": "2021-01-30T00:00:00", "description": "VOID", "reconciled": false, "amount": 50, "balance": -10002.54, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "50", "accountId": "1200", "clearedOnDate": "2021-01-31T00:00:00", "description": "TRANS", "reconciled": false, "amount": -500, "balance": -8804.96, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "85", "accountId": "1200", "clearedOnDate": "2021-01-31T00:00:00", "description": "6565689", "reconciled": false, "amount": -1800, "balance": -11964.54, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "97", "accountId": "1200", "clearedOnDate": "2021-01-31T00:00:00", "description": "Salary", "reconciled": false, "amount": -5932.29, "balance": -17896.83, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1183", "accountId": "1200", "clearedOnDate": "2021-09-01T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -162, "balance": 11299.91, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1184", "accountId": "1200", "clearedOnDate": "2021-09-15T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -1200, "balance": 10099.91, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1185", "accountId": "1200", "clearedOnDate": "2021-09-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -150, "balance": 9949.91, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1186", "accountId": "1200", "clearedOnDate": "2021-09-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -5.55, "balance": 9944.36, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1187", "accountId": "1200", "clearedOnDate": "2021-10-13T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -1200, "balance": 8744.36, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1188", "accountId": "1200", "clearedOnDate": "2021-10-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -150, "balance": 8594.36, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1189", "accountId": "1200", "clearedOnDate": "2021-10-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -5.55, "balance": 8588.81, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1190", "accountId": "1200", "clearedOnDate": "2021-11-10T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -1200, "balance": 7388.81, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1191", "accountId": "1200", "clearedOnDate": "2021-11-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -150, "balance": 7238.81, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1192", "accountId": "1200", "clearedOnDate": "2021-11-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -5.55, "balance": 7233.26, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1193", "accountId": "1200", "clearedOnDate": "2021-12-08T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -1200, "balance": 6033.26, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1194", "accountId": "1200", "clearedOnDate": "2021-12-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -150, "balance": 5883.26, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1195", "accountId": "1200", "clearedOnDate": "2021-12-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -5.55, "balance": 5877.71, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "24", "accountId": "1200", "clearedOnDate": "2021-12-31T00:00:00", "description": "O/Bal", "reconciled": true, "amount": -6511.96, "balance": -6511.96, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "26", "accountId": "1200", "clearedOnDate": "2021-12-31T00:00:00", "description": "56956", "reconciled": false, "amount": 55, "balance": -6456.96, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "27", "accountId": "1200", "clearedOnDate": "2021-12-31T00:00:00", "description": "656678", "reconciled": false, "amount": -150, "balance": -6606.96, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "28", "accountId": "1200", "clearedOnDate": "2021-12-31T00:00:00", "description": "656679", "reconciled": false, "amount": -352, "balance": -6958.96, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "29", "accountId": "1200", "clearedOnDate": "2021-12-31T00:00:00", "description": "656680", "reconciled": false, "amount": -550, "balance": -7508.96, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "30", "accountId": "1200", "clearedOnDate": "2021-12-31T00:00:00", "description": "656681", "reconciled": false, "amount": -250, "balance": -7758.96, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "31", "accountId": "1200", "clearedOnDate": "2021-12-31T00:00:00", "description": "656869", "reconciled": false, "amount": -546, "balance": -8304.96, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1196", "accountId": "1200", "clearedOnDate": "2022-01-01T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -162, "balance": 5715.71, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1197", "accountId": "1200", "clearedOnDate": "2022-01-05T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -1200, "balance": 4515.71, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1198", "accountId": "1200", "clearedOnDate": "2022-01-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -150, "balance": 4365.71, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1199", "accountId": "1200", "clearedOnDate": "2022-01-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -5.55, "balance": 4360.16, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "255", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "(BACS)", "reconciled": false, "amount": -370.71, "balance": -18267.54, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "256", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "100001", "reconciled": false, "amount": -256.36, "balance": -18523.9, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "257", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "100002", "reconciled": false, "amount": -25.5, "balance": -18549.4, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "258", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "100003", "reconciled": false, "amount": -1977.58, "balance": -20526.98, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "259", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "100004", "reconciled": false, "amount": -599.03, "balance": -21126.01, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "260", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "100005", "reconciled": false, "amount": -7141.98, "balance": -28267.99, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "261", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "100006", "reconciled": false, "amount": -150.96, "balance": -28418.95, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "262", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "100007", "reconciled": false, "amount": -63, "balance": -28481.95, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "263", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "100008", "reconciled": false, "amount": -35.01, "balance": -28516.96, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "264", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "100009", "reconciled": false, "amount": -1659.34, "balance": -30176.3, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "265", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "4353454", "reconciled": false, "amount": 1432.17, "balance": -28744.13, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "266", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "", "reconciled": false, "amount": 2684.26, "balance": -26059.87, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "267", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "", "reconciled": false, "amount": 1204.57, "balance": -24855.3, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "268", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "", "reconciled": false, "amount": 1140.78, "balance": -23714.52, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "269", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "", "reconciled": false, "amount": 4372, "balance": -19342.52, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "270", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "", "reconciled": false, "amount": 1946.18, "balance": -17396.34, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "271", "accountId": "1200", "clearedOnDate": "2022-01-29T00:00:00", "description": "", "reconciled": false, "amount": 11123.33, "balance": -6273.01, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1200", "accountId": "1200", "clearedOnDate": "2022-02-02T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -1200, "balance": 3160.16, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "300", "accountId": "1200", "clearedOnDate": "2022-02-03T00:00:00", "description": "TRANS", "reconciled": false, "amount": -500, "balance": -16588.09, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1201", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -150, "balance": 3010.16, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1202", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -5.55, "balance": 3004.61, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "276", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "Credit", "reconciled": false, "amount": -500, "balance": -6773.01, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "279", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "", "reconciled": false, "amount": -58.75, "balance": -6831.76, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "280", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "TRANS", "reconciled": false, "amount": -1400, "balance": -8231.76, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "282", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "TRANS", "reconciled": false, "amount": -12600, "balance": -20831.76, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "286", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "TRANS", "reconciled": false, "amount": 6500, "balance": -14331.76, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "287", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "PAYE", "reconciled": false, "amount": -1256.33, "balance": -15588.09, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "288", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "Deposit", "reconciled": false, "amount": -500, "balance": -16088.09, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "314", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -162, "balance": -16750.09, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "315", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -1200, "balance": -17950.09, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "325", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "Loan", "reconciled": false, "amount": -150, "balance": -18100.09, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "326", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "Loan", "reconciled": false, "amount": -5.55, "balance": -18105.64, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "328", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "Returned", "reconciled": false, "amount": 103.4, "balance": -18002.24, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "331", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "Salary", "reconciled": false, "amount": -5932.29, "balance": -23934.53, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "523", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "", "reconciled": false, "amount": 6556.33, "balance": -17378.2, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "525", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "", "reconciled": false, "amount": 3350.33, "balance": -14027.87, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "526", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "(BACS)", "reconciled": false, "amount": -435.14, "balance": -14463.01, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "529", "accountId": "1200", "clearedOnDate": "2022-02-28T00:00:00", "description": "12324", "reconciled": false, "amount": -8561.48, "balance": -23024.49, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "532", "accountId": "1200", "clearedOnDate": "2022-03-01T00:00:00", "description": "VOID", "reconciled": false, "amount": 352.5, "balance": -22671.99, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "534", "accountId": "1200", "clearedOnDate": "2022-03-01T00:00:00", "description": "SED", "reconciled": false, "amount": 55, "balance": -22616.99, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1203", "accountId": "1200", "clearedOnDate": "2022-03-02T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -1200, "balance": 1804.61, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "821", "accountId": "1200", "clearedOnDate": "2022-03-10T00:00:00", "description": "", "reconciled": false, "amount": 1908.89, "balance": -14370.08, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "820", "accountId": "1200", "clearedOnDate": "2022-03-20T00:00:00", "description": "776", "reconciled": false, "amount": 9057.34, "balance": -16278.97, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "606", "accountId": "1200", "clearedOnDate": "2022-03-24T00:00:00", "description": "Deposit", "reconciled": false, "amount": -150, "balance": -22370.09, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "607", "accountId": "1200", "clearedOnDate": "2022-03-25T00:00:00", "description": "44555", "reconciled": false, "amount": 100, "balance": -22270.09, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "823", "accountId": "1200", "clearedOnDate": "2022-03-25T00:00:00", "description": "", "reconciled": false, "amount": 1770.15, "balance": -12229.5, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "578", "accountId": "1200", "clearedOnDate": "2022-03-27T00:00:00", "description": "456", "reconciled": false, "amount": -15, "balance": -22084.91, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "608", "accountId": "1200", "clearedOnDate": "2022-03-27T00:00:00", "description": "CREDIT", "reconciled": false, "amount": -100, "balance": -22370.09, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "824", "accountId": "1200", "clearedOnDate": "2022-03-27T00:00:00", "description": "", "reconciled": false, "amount": 1025.86, "balance": -11203.64, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1204", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -150, "balance": 1654.61, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "1205", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -5.55, "balance": 1649.06, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "546", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -162, "balance": -22778.99, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "547", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -1200, "balance": -23978.99, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "548", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -150, "balance": -24128.99, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "549", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "DD/STO", "reconciled": false, "amount": -5.55, "balance": -24134.54, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "555", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "VOID", "reconciled": false, "amount": 50, "balance": -24084.54, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "560", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "REFUND", "reconciled": false, "amount": 64.63, "balance": -24019.91, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "562", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "TRANS", "reconciled": false, "amount": 2000, "balance": -22019.91, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "563", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "TRANS", "reconciled": false, "amount": -50, "balance": -22069.91, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "584", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "CREDIT", "reconciled": false, "amount": -70.31, "balance": -22155.22, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "589", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "VOID", "reconciled": false, "amount": 30, "balance": -22125.22, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "596", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "REFUND", "reconciled": false, "amount": 35.01, "balance": -22090.21, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "597", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "PAYE", "reconciled": false, "amount": -2070.23, "balance": -24160.44, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "598", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "NI", "reconciled": false, "amount": -1003.49, "balance": -25163.93, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "604", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "TRANS", "reconciled": false, "amount": 3000, "balance": -22163.93, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "605", "accountId": "1200", "clearedOnDate": "2022-03-28T00:00:00", "description": "225", "reconciled": false, "amount": -56.16, "balance": -22220.09, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "612", "accountId": "1200", "clearedOnDate": "2022-03-29T00:00:00", "description": "NI", "reconciled": false, "amount": -1003.49, "balance": -29305.87, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" }, { "id": "614", "accountId": "1200", "clearedOnDate": "2022-03-29T00:00:00", "description": "Sales", "reconciled": false, "amount": 179.2, "balance": -29126.67, "transactionType": "Credit", "modifiedDate": "2023-03-30T14:42:44Z", "sourceModifiedDate": "2022-11-25T09:43:54" } ], "pageNumber": 1, "pageSize": 100, "totalResults": 179, "_links": { "current": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions" }, "self": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions" }, "next": { "href": "/companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions?page=2&pageSize=100" } } } }, "Sage Business Cloud Accounting": { "value": { "results": [ { "id": "26b727ca84734e3c8e245011bd04dbf1", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2020-02-05T00:00:00", "description": "string Supplier Payment", "reconciled": false, "amount": -5, "transactionType": "Credit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2020-02-07T11:35:39Z" }, { "id": "508f3fd4403e45cb903b362a4ae55344", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2020-02-05T00:00:00", "description": "string Supplier Payment", "reconciled": false, "amount": -3.86, "transactionType": "Credit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2020-02-10T10:51:43Z" }, { "id": "52e58431005e44328af44116e0433230", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2020-02-05T00:00:00", "description": "string Supplier Payment", "reconciled": false, "amount": -3.85, "transactionType": "Credit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2020-02-07T14:36:01Z" }, { "id": "f3255e4b79c5427ba5b963d0e26cecfc", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2020-02-05T00:00:00", "description": "string Supplier Payment", "reconciled": false, "amount": -3.86, "transactionType": "Credit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2020-02-07T14:19:24Z" }, { "id": "a00e1ce357cc4064b9cce8abe1b15110", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2020-04-21T00:00:00", "description": "Cash Deposit Bank Transfer", "reconciled": false, "amount": 1000, "transactionType": "Debit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2020-04-21T21:03:25Z" }, { "id": "a7d26740129945c3a76209020fbb7fd1", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2020-11-25T00:00:00", "description": "Bank Transfer", "reconciled": false, "amount": -40, "transactionType": "Credit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2020-11-25T19:35:03Z" }, { "id": "829f45112347471cbf99b0d9afe08113", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2021-07-02T00:00:00", "description": "Made from codat api Customer Receipt", "reconciled": false, "amount": 10, "transactionType": "Debit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2021-07-02T13:14:57Z" }, { "id": "786f769ae88a4fa898e25e2cbff43be3", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2021-07-20T00:00:00", "description": "Supplier payment AD Supplier Payment", "reconciled": false, "amount": -2400, "transactionType": "Credit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2021-07-22T14:12:38Z" }, { "id": "abb5995867c546c2b32097d515dcef2a", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2021-07-21T00:00:00", "description": "Payment Customer Receipt", "reconciled": false, "amount": 12, "transactionType": "Debit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2021-07-21T14:09:59Z" }, { "id": "943f3bd6eacc4071807d89895fe03ef4", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2021-08-17T00:00:00", "description": "Ref5565 Other Receipt", "reconciled": false, "amount": 50, "transactionType": "Debit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2021-08-17T11:58:37Z" }, { "id": "039e6bb20b6e44d690601e4dd04a5b21", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2021-09-22T00:00:00", "description": "Note 1 Customer Receipt", "reconciled": false, "amount": 1080, "transactionType": "Debit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2021-09-22T14:22:57Z" }, { "id": "1a62f54358e74ba4a71dd733f2b08ba4", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2021-09-27T00:00:00", "description": "Note 2 Customer Receipt", "reconciled": false, "amount": 1080, "transactionType": "Debit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2021-09-27T14:04:05Z" }, { "id": "a79ebcf0710d415baad6b588eb28307b", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2021-12-01T00:00:00", "description": "Payment Customer Receipt", "reconciled": false, "amount": 33, "transactionType": "Debit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2021-12-01T13:03:00Z" }, { "id": "4b691b78b6cd43c9a64d75aeb29e4d11", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2022-07-19T00:00:00", "description": "Bank Transfer", "reconciled": false, "amount": -10, "transactionType": "Credit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2022-07-19T08:51:52Z" }, { "id": "7b1f2f55f39042838d5f7226aa92386f", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2022-07-19T00:00:00", "description": "Bank Transfer", "reconciled": false, "amount": -1415, "transactionType": "Credit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2022-07-19T13:15:26Z" }, { "id": "87eca750292b4cfea216e13bb22923c6", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2022-07-19T00:00:00", "description": "Bank Transfer", "reconciled": false, "amount": -10, "transactionType": "Credit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2022-07-19T13:01:47Z" }, { "id": "a48474f83d214637a700e76e24446086", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2022-07-19T00:00:00", "description": "Bank Transfer", "reconciled": false, "amount": -10, "transactionType": "Credit", "modifiedDate": "2022-10-24T15:31:14Z", "sourceModifiedDate": "2022-07-19T13:10:42Z" }, { "id": "cc1fc960e05c40c1968314efe1175b9f", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2022-09-14T00:00:00", "description": "string Customer Receipt", "reconciled": false, "amount": 69, "transactionType": "Debit", "modifiedDate": "2022-10-24T15:31:15Z", "sourceModifiedDate": "2022-09-14T16:20:09Z" }, { "id": "e600eb7549b74d96bdca18b9cc60f39d", "accountId": "154d05abe9f24c4babe0f6a741dec1b9", "clearedOnDate": "2022-09-14T00:00:00", "description": "Customer Receipt", "reconciled": false, "amount": 60, "transactionType": "Debit", "modifiedDate": "2022-10-24T15:31:15Z", "sourceModifiedDate": "2022-09-14T16:12:03Z" } ], "pageNumber": 1, "pageSize": 100, "totalResults": 19, "_links": { "current": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts/154d05abe9f24c4babe0f6a741dec1b9/bankTransactions" }, "self": { "href": "/companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts/154d05abe9f24c4babe0f6a741dec1b9/bankTransactions" } } } }, "Xero": { "value": { "results": [ { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2021-12-20T00:00:00", "description": "DD", "counterparty": "DIISR", "reconciled": true, "amount": -7267.2, "balance": -3136.22, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-02-17T00:00:00", "description": "DD", "counterparty": "Ridgeway University", "reconciled": true, "amount": 500, "balance": -5703.42, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-02-17T00:00:00", "description": "INV0010", "counterparty": "MADDOX PUBLISHING GP", "reconciled": true, "amount": 4200, "balance": -6203.42, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-02-17T00:00:00", "description": "DD", "counterparty": "DIISR", "reconciled": true, "amount": -7267.2, "balance": -10403.42, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-02-19T00:00:00", "description": "DD", "counterparty": "PowerDirect", "reconciled": true, "amount": -95.5, "balance": -5798.92, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-03-19T00:00:00", "description": "DD", "counterparty": "Ridgeway University", "reconciled": true, "amount": 500, "balance": -5298.92, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-03-21T00:00:00", "description": "DD", "counterparty": "PowerDirect", "reconciled": true, "amount": -97, "balance": -5395.92, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-04-19T00:00:00", "description": "INV-0003", "counterparty": "Ridgeway University", "reconciled": true, "amount": 500, "balance": -4895.92, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-04-21T00:00:00", "description": "DD", "counterparty": "PowerDirect", "reconciled": true, "amount": -92, "balance": -4987.92, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-05-21T00:00:00", "description": "INV-0004", "counterparty": "Ridgeway University", "reconciled": true, "amount": 1000, "balance": -3987.92, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-05-21T00:00:00", "description": "DD", "counterparty": "PowerDirect", "reconciled": true, "amount": -89, "balance": -4076.92, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-06-19T00:00:00", "description": "INV-005", "counterparty": "Ridgeway University", "reconciled": true, "amount": 500, "balance": -3576.92, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-06-21T00:00:00", "description": "DD", "counterparty": "PowerDirect", "reconciled": true, "amount": -91, "balance": -3667.92, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-07-20T00:00:00", "description": "INV-006", "counterparty": "Ridgeway University", "reconciled": true, "amount": 500, "balance": -3167.92, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-07-22T00:00:00", "description": "DD", "counterparty": "PowerDirect", "reconciled": true, "amount": -96.25, "balance": -3264.17, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-08-19T00:00:00", "description": "INV-007", "counterparty": "Ridgeway University", "reconciled": true, "amount": 1500, "balance": -1764.17, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-08-21T00:00:00", "description": "DD", "counterparty": "PowerDirect", "reconciled": true, "amount": -100.6, "balance": -1864.77, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-09-19T00:00:00", "description": "INV-008", "counterparty": "Ridgeway University", "reconciled": true, "amount": 500, "balance": -1364.77, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-09-21T00:00:00", "description": "DD", "counterparty": "PowerDirect", "reconciled": true, "amount": -105.75, "balance": -1470.52, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-10-19T00:00:00", "description": "INV-009", "counterparty": "Ridgeway University", "reconciled": true, "amount": 1200, "balance": -270.52, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-10-21T00:00:00", "description": "DD", "counterparty": "PowerDirect", "reconciled": true, "amount": -106.5, "balance": -377.02, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-11-20T00:00:00", "description": "INV-0010", "counterparty": "Ridgeway University", "reconciled": true, "amount": 500, "balance": 122.98, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-11-21T00:00:00", "description": "DD", "counterparty": "PowerDirect", "reconciled": true, "amount": -119.08, "balance": 3.9, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-11-22T00:00:00", "description": "Monthly a/c fee", "counterparty": "Ridgeway Banking Corporation", "reconciled": true, "amount": -15, "balance": -11.1, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-11-23T00:00:00", "description": "FP089876", "counterparty": "FastPay", "reconciled": true, "amount": -3126.17, "balance": -1591.58, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-11-23T00:00:00", "description": "Subs DD", "counterparty": "Xero", "reconciled": true, "amount": -56.35, "balance": -89.16, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-11-23T00:00:00", "description": "0015", "counterparty": "Rex Media Group", "reconciled": true, "amount": 541.25, "balance": 1534.59, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-11-23T00:00:00", "description": "INV-0014", "counterparty": "Port & Philip Freight", "reconciled": true, "amount": 541.25, "balance": 993.34, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-11-23T00:00:00", "description": "", "counterparty": "Office Supplies Company", "reconciled": true, "amount": -21.71, "balance": -32.81, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-11-23T00:00:00", "description": "INV-0013", "counterparty": "Young Brothers", "reconciled": true, "amount": 541.25, "balance": 452.09, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-11-24T00:00:00", "description": "INV0012", "counterparty": "Hamilton Smith", "reconciled": true, "amount": 541.25, "balance": -1050.33, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-01T00:00:00", "description": "", "counterparty": "Woolworths Oaktown", "reconciled": true, "amount": -65.2, "balance": -1115.53, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-02T00:00:00", "description": "", "counterparty": "Berry Brew Cafe", "reconciled": true, "amount": -15.6, "balance": -1131.13, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-09T00:00:00", "description": "AR-0019", "counterparty": "Bank West", "reconciled": true, "amount": 1500, "balance": 368.87, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-11T00:00:00", "description": "CHQ 6543-000409", "counterparty": "Melrose Parking Services", "reconciled": true, "amount": -148.5, "balance": 220.37, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-16T00:00:00", "description": "", "counterparty": "Espresso 31 Ltd", "reconciled": true, "amount": -16, "balance": 204.37, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-19T00:00:00", "description": "", "counterparty": "Brunswick Flower Suppliers T/A Brunswick Petals", "reconciled": true, "amount": -50, "balance": 154.37, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-20T00:00:00", "description": "AR-0011", "counterparty": "Ridgeway University", "reconciled": true, "amount": 2500, "balance": 2583.57, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-20T00:00:00", "description": "", "counterparty": "Mobil", "reconciled": true, "amount": -70.8, "balance": 83.57, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-23T00:00:00", "description": "", "counterparty": "PC Complete", "reconciled": true, "amount": -1463.88, "balance": 1449.49, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-23T00:00:00", "description": "AR-0018", "counterparty": "City Agency", "reconciled": true, "amount": 329.8, "balance": 2913.37, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-23T00:00:00", "description": "Bank Fee", "counterparty": "Ridgeway Banking Corporation", "reconciled": true, "amount": -15, "balance": 1434.49, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-23T00:00:00", "description": "", "counterparty": "Truxton Property Management", "reconciled": true, "amount": -1181.25, "balance": 253.24, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2022-12-29T00:00:00", "description": "FP101897", "counterparty": "FastPay", "reconciled": false, "amount": -1223.91, "balance": -970.67, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-19T00:00:00", "description": "", "counterparty": "Net Connect", "reconciled": true, "amount": -98.32, "balance": -1177.59, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-19T00:00:00", "description": "", "counterparty": "Power Direct", "reconciled": true, "amount": -108.6, "balance": -1079.27, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-19T00:00:00", "description": "AR-0020", "counterparty": "Ridgeway University", "reconciled": true, "amount": 6187.5, "balance": 5009.91, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-20T00:00:00", "description": "", "counterparty": "Truxton Property Management", "reconciled": true, "amount": -1181.25, "balance": 3828.66, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-20T00:00:00", "description": "", "counterparty": "Swantston Security", "reconciled": true, "amount": -59.54, "balance": 3769.12, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-21T00:00:00", "description": "", "counterparty": "Xero", "reconciled": true, "amount": -56.35, "balance": 3712.77, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-22T00:00:00", "description": "INV0022", "counterparty": "Petrie McLoud", "reconciled": true, "amount": 1407.25, "balance": 5120.02, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-23T00:00:00", "description": "0024", "counterparty": "Boom FM", "reconciled": true, "amount": 1000, "balance": 6120.02, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-24T00:00:00", "description": "CHQ 6543-000410", "counterparty": "Melrose Parking", "reconciled": true, "amount": -148.5, "balance": 5971.52, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-25T00:00:00", "description": "0027-Part", "counterparty": "DIISR", "reconciled": true, "amount": 579.37, "balance": 6550.89, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-26T00:00:00", "description": "Inv 0029", "counterparty": "Hamilton Smith", "reconciled": true, "amount": 541.25, "balance": 7092.14, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-26T00:00:00", "description": "INV0032", "counterparty": "Rex Media Group", "reconciled": true, "amount": 541.25, "balance": 8715.89, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-26T00:00:00", "description": "0030", "counterparty": "Young Brothers Transport", "reconciled": true, "amount": 541.25, "balance": 7633.39, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-26T00:00:00", "description": "INV-0031", "counterparty": "Port & Philip Freight Limited", "reconciled": true, "amount": 541.25, "balance": 8174.64, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-27T00:00:00", "description": "Eft", "counterparty": "Woolworths Oaktown", "reconciled": true, "amount": -34.1, "balance": 8681.79, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-28T00:00:00", "description": "033-Full", "counterparty": "DIISR", "reconciled": true, "amount": 250, "balance": 8931.79, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-30T00:00:00", "description": "Eft", "counterparty": "Office Supplies Company", "reconciled": true, "amount": -49.2, "balance": 8882.59, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-01-31T00:00:00", "description": "", "counterparty": "Berry Brew", "reconciled": true, "amount": -22, "balance": 8860.59, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-01T00:00:00", "description": "CHQ 6543-000411", "counterparty": "24 Locks", "reconciled": true, "amount": -69.5, "balance": 8791.09, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-02T00:00:00", "description": "08-4123", "counterparty": "Hoyt Productions Ltd", "reconciled": true, "amount": -5953.75, "balance": 2837.34, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-03T00:00:00", "description": "", "counterparty": "Carlton Functions", "reconciled": true, "amount": -1500, "balance": 1337.34, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-06T00:00:00", "description": "Exps", "counterparty": "O.Greenville", "reconciled": true, "amount": -29.5, "balance": 1307.84, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-07T00:00:00", "description": "Rent", "counterparty": "Truxton Property Management", "reconciled": false, "amount": -1181.25, "balance": 6314.09, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-07T00:00:00", "description": "INV-0035", "counterparty": "Ridgeway University", "reconciled": false, "amount": 6187.5, "balance": 7495.34, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-08T00:00:00", "description": "0017-Part", "counterparty": "City Limousines", "reconciled": false, "amount": 100, "balance": 1914.09, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-08T00:00:00", "description": "DEPOSIT ADV", "counterparty": "Jakaranda Maple Systems", "reconciled": false, "amount": 2000, "balance": 3914.09, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-08T00:00:00", "description": "0195 0210", "counterparty": "SMART Agency", "reconciled": false, "amount": -4500, "balance": 1814.09, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-09T00:00:00", "description": "Eft", "counterparty": "Cooper Street Bakery", "reconciled": false, "amount": -15.75, "balance": 3898.34, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-10T00:00:00", "description": "", "counterparty": "7-Eleven", "reconciled": false, "amount": -15.5, "balance": 3882.84, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-11T00:00:00", "description": "", "counterparty": "Swanston Security", "reconciled": false, "amount": -59.55, "balance": 3811.39, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-11T00:00:00", "description": "", "counterparty": "Cooper Street Bakery", "reconciled": false, "amount": -11.9, "balance": 3870.94, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-12T00:00:00", "description": "", "counterparty": "Whitcoulls", "reconciled": false, "amount": -29.8, "balance": 4769.59, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-12T00:00:00", "description": "", "counterparty": "e-Bank Dep", "reconciled": false, "amount": 1000, "balance": 4811.39, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-12T00:00:00", "description": "", "counterparty": "Central City Parking", "reconciled": false, "amount": -12, "balance": 4799.39, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-13T00:00:00", "description": "", "counterparty": "Central City Parking", "reconciled": false, "amount": -12, "balance": 4757.59, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-13T00:00:00", "description": "Sub 092201", "counterparty": "Wilson Online Periodicals", "reconciled": false, "amount": -49.9, "balance": 4588.09, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-13T00:00:00", "description": "Reg 8018922", "counterparty": "ACL Conferences", "reconciled": false, "amount": -85, "balance": 4672.59, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-13T00:00:00", "description": "", "counterparty": "New World", "reconciled": false, "amount": -34.6, "balance": 4637.99, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-14T00:00:00", "description": "Sublet RM2031", "counterparty": "Majestic Contracting", "reconciled": false, "amount": 450, "balance": 6526.09, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-14T00:00:00", "description": "", "counterparty": "Central City Parking", "reconciled": false, "amount": -12, "balance": 4576.09, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-14T00:00:00", "description": "", "counterparty": "e-Bank Dep", "reconciled": false, "amount": 1500, "balance": 6076.09, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-15T00:00:00", "description": "", "counterparty": "Central City Parking", "reconciled": false, "amount": -12, "balance": 6499.79, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-15T00:00:00", "description": "CR 092201", "counterparty": "Wilson Online Periodicals", "reconciled": false, "amount": 35, "balance": 6534.79, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-15T00:00:00", "description": "", "counterparty": "Parkside Kiosk", "reconciled": false, "amount": -14.3, "balance": 6511.79, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-16T00:00:00", "description": "", "counterparty": "e-Bank Dep", "reconciled": false, "amount": 200, "balance": 6712.29, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-16T00:00:00", "description": "", "counterparty": "Parkside Kiosk", "reconciled": false, "amount": -10.5, "balance": 6512.29, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-16T00:00:00", "description": "Fee", "counterparty": "Ridgeway Banking Corporation", "reconciled": false, "amount": -15, "balance": 6697.29, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-16T00:00:00", "description": "", "counterparty": "7-Eleven", "reconciled": false, "amount": -15.5, "balance": 6681.79, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" }, { "accountId": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "clearedOnDate": "2023-02-16T00:00:00", "description": "", "counterparty": "Central City Parking", "reconciled": false, "amount": -12, "balance": 6522.79, "transactionType": "Unknown", "modifiedDate": "2023-03-15T20:37:10Z" } ], "pageNumber": 1, "pageSize": 100, "totalResults": 93, "_links": { "current": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts/bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4/bankTransactions" }, "self": { "href": "/companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts/bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4/bankTransactions" } } } }, "Zoho Books": { "value": { "results": [ { "id": "104957000000060010-104957000000070175", "accountId": "104957000000060010", "clearedOnDate": "2020-02-06T00:00:00", "description": "", "reconciled": false, "amount": 9001, "transactionType": "Cash", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000000060014", "accountId": "104957000000060010", "clearedOnDate": "2020-02-12T00:00:00", "description": "", "reconciled": false, "amount": 10000, "transactionType": "Dep", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000000067014", "accountId": "104957000000060010", "clearedOnDate": "2020-02-14T00:00:00", "description": "", "reconciled": false, "amount": 9001, "transactionType": "Cash", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000000070035", "accountId": "104957000000060010", "clearedOnDate": "2020-02-17T00:00:00", "description": "", "reconciled": false, "amount": 11980, "transactionType": "Debit", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000000070055", "accountId": "104957000000060010", "clearedOnDate": "2020-02-17T00:00:00", "description": "", "reconciled": false, "amount": -20, "transactionType": "Payment", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000000070097", "accountId": "104957000000060010", "clearedOnDate": "2020-02-17T00:00:00", "description": "", "reconciled": false, "amount": 10789.21, "transactionType": "Cash", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000000097011", "accountId": "104957000000060010", "clearedOnDate": "2020-02-26T00:00:00", "description": "", "reconciled": false, "amount": 10000, "transactionType": "Cash", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000000099013", "accountId": "104957000000060010", "clearedOnDate": "2020-02-27T00:00:00", "description": "", "reconciled": false, "amount": -72, "transactionType": "Payment", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000000099053", "accountId": "104957000000060010", "clearedOnDate": "2020-02-27T00:00:00", "description": "", "reconciled": false, "amount": 10, "transactionType": "Debit", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000000137017", "accountId": "104957000000060010", "clearedOnDate": "2020-05-19T00:00:00", "description": "", "reconciled": false, "amount": 9000, "transactionType": "Cash", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000000336002", "accountId": "104957000000060010", "clearedOnDate": "2020-12-01T00:00:00", "description": "", "reconciled": false, "amount": -20, "transactionType": "Xfer", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000000336020", "accountId": "104957000000060010", "clearedOnDate": "2020-12-01T00:00:00", "description": "", "reconciled": false, "amount": 1.79, "transactionType": "Xfer", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000001706009", "accountId": "104957000000060010", "clearedOnDate": "2021-04-12T00:00:00", "description": "", "reconciled": false, "amount": 200, "transactionType": "Cash", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000001469026", "accountId": "104957000000060010", "clearedOnDate": "2022-05-12T00:00:00", "description": "", "reconciled": false, "amount": -50, "transactionType": "Credit", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000001480001", "accountId": "104957000000060010", "clearedOnDate": "2022-05-13T00:00:00", "description": "", "reconciled": false, "amount": 18.98, "transactionType": "Debit", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000001480045", "accountId": "104957000000060010", "clearedOnDate": "2022-05-13T00:00:00", "description": "", "reconciled": false, "amount": -20, "transactionType": "Credit", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000001633002", "accountId": "104957000000060010", "clearedOnDate": "2022-07-27T00:00:00", "description": "", "reconciled": false, "amount": 26, "transactionType": "Other", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000001652007", "accountId": "104957000000060010", "clearedOnDate": "2022-08-08T00:00:00", "description": "", "reconciled": false, "amount": 11.75, "transactionType": "Other", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000001689069", "accountId": "104957000000060010", "clearedOnDate": "2022-08-24T00:00:00", "description": "", "reconciled": false, "amount": -2.89, "transactionType": "Payment", "modifiedDate": "2022-10-03T08:40:40Z" }, { "id": "104957000000060010-104957000001689125", "accountId": "104957000000060010", "clearedOnDate": "2022-08-25T00:00:00", "description": "", "reconciled": false, "amount": 3.6, "transactionType": "Debit", "modifiedDate": "2022-10-03T08:40:40Z" } ], "pageNumber": 1, "pageSize": 100, "totalResults": 20, "_links": { "current": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts/104957000000060010/bankTransactions" }, "self": { "href": "/companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts/104957000000060010/bankTransactions" } } } } } } } }, "400": { "$ref": "#/components/responses/Malformed-Query" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions": { "get": { "tags": [ "Bank account transactions" ], "summary": "Get create bank account transactions model", "description": "The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company and integration.\n\n[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.\n\n**Integration-specific behaviour**\n\nSee the *response examples* for integration-specific indicative models.\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating an bank transaction.\n", "operationId": "get-create-bank-transactions-model", "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/accountId" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushOption" }, "examples": {} } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions": { "post": { "tags": [ "Bank account transactions" ], "summary": "Create bank account transactions", "description": "The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) for a given company's connection.\n\n[Bank account transactions](https://docs.codat.io/accounting-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account.\n\n**Integration-specific behaviour**\n\nRequired data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/accounting-api#/operations/get-create-bankTransactions-model).\n\nCheck out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions.\n", "operationId": "create-bank-transactions", "parameters": [ { "$ref": "#/components/parameters/companyId" }, { "$ref": "#/components/parameters/connectionId" }, { "$ref": "#/components/parameters/accountId" }, { "$ref": "#/components/parameters/timeoutInMinutes" }, { "$ref": "#/components/parameters/allowSyncOnPushComplete" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBankTransactions" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBankTransactionsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/reports/agedDebtor/available": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Reports" ], "summary": "Aged debtors report available", "description": "Indicates whether the aged debtor report is available for the company.", "operationId": "is-aged-debtor-report-available", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/reports/agedDebtor": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Reports" ], "parameters": [ { "$ref": "#/components/parameters/reportDate" }, { "$ref": "#/components/parameters/numberOfPeriods" }, { "$ref": "#/components/parameters/periodLengthDays" } ], "summary": "Aged debtors report", "description": "Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time.", "operationId": "get-aged-debtors-report", "x-speakeasy-name-override": "get-aged-debtors-report", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgedDebtorReport" }, "examples": { "Clear Books": { "value": { "generated": "2023-05-02T16:05:21.4959955Z", "reportDate": "2023-05-02T16:05:21.4459444Z", "data": [ { "customerId": "c8180244-74ac-40cf-a5df-6d83661c44d7", "customerName": "Arjun Kuvalis", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -3367.71, "details": [ { "name": "CreditNotes", "amount": -3367.71 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Invoices", "amount": 0 } ] } ] } ] }, { "customerId": "6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0", "customerName": "Breitenberg, Emard and Schiller", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -4299.26, "details": [ { "name": "Invoices", "amount": 0 }, { "name": "CreditNotes", "amount": -4299.26 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Invoices", "amount": 0 } ] } ] } ] }, { "customerId": "981d56a7-cf63-4ed2-b8db-2eba2c0aeb5a", "customerName": "Collins - Anderson", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -14959.84, "details": [ { "name": "CreditNotes", "amount": -14959.84 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 773.94, "details": [ { "name": "Invoices", "amount": 773.94 } ] } ] } ] }, { "customerId": "d3739e0f-5a70-465b-9dfe-deb8efac0cd3", "customerName": "Damien Schneider", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -2817.59, "details": [ { "name": "CreditNotes", "amount": -2817.59 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Invoices", "amount": 0 } ] } ] } ] }, { "customerId": "10652b76-2a9a-43ba-a892-fb4f369fe1ef", "customerName": "Franco Labadie", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1541.52, "details": [ { "name": "CreditNotes", "amount": -1541.52 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Invoices", "amount": 0 } ] } ] } ] }, { "customerId": "03b7f9fd-40e0-4c71-9f93-58e867233bcb", "customerName": "Harvey Predovic", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -14312.59, "details": [ { "name": "CreditNotes", "amount": -14312.59 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 158.76, "details": [ { "name": "Invoices", "amount": 158.76 } ] } ] } ] }, { "customerId": "bbea9634-7a60-4c3f-97cd-70e481ec2cce", "customerName": "Jenkins Inc", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -32818.36, "details": [ { "name": "CreditNotes", "amount": -32818.36 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 431.71, "details": [ { "name": "Invoices", "amount": 431.71 } ] } ] } ] }, { "customerId": "d65ac505-072c-49ec-be3c-3cb74228966d", "customerName": "Jensen Steuber", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -9766.18, "details": [ { "name": "Invoices", "amount": 0 }, { "name": "CreditNotes", "amount": -9766.18 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1273.16, "details": [ { "name": "Invoices", "amount": 1273.16 } ] } ] } ] }, { "customerId": "a82042f1-a005-4ca5-bfd3-5bc237123aa5", "customerName": "Keara Leffler", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -2595.66, "details": [ { "name": "CreditNotes", "amount": -2595.66 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1397.98, "details": [ { "name": "Invoices", "amount": 1397.98 } ] } ] } ] }, { "customerId": "f67eab14-12f1-432f-af73-81ebf6ec8ddc", "customerName": "Neoma Kreiger", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -3047.62, "details": [ { "name": "CreditNotes", "amount": -3047.62 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Invoices", "amount": 0 } ] } ] } ] }, { "customerId": "2d6a5c2d-80dc-4aac-8909-ddfb3cb24437", "customerName": "Newton Zieme", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -225.44, "details": [ { "name": "CreditNotes", "amount": -225.44 }, { "name": "Invoices", "amount": 0 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Invoices", "amount": 0 } ] } ] } ] }, { "customerId": "976a2402-0908-46d9-9121-a93005d29c01", "customerName": "Norbert Tillman", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -537.61, "details": [ { "name": "CreditNotes", "amount": -537.61 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Invoices", "amount": 0 } ] } ] } ] }, { "customerId": "453ddfc0-49ce-4f66-a815-dae734be885c", "customerName": "Ralph Wilderman", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -2538.49, "details": [ { "name": "CreditNotes", "amount": -2538.49 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Invoices", "amount": 0 } ] } ] } ] }, { "customerId": "51f03576-f6b0-40d5-9fba-81a490411c03", "customerName": "Raul Johns", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -4403.5, "details": [ { "name": "CreditNotes", "amount": -4403.5 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3477.81, "details": [ { "name": "Invoices", "amount": 3477.81 } ] } ] } ] }, { "customerId": "84539fde-118f-48ed-978d-0aa50c7ec223", "customerName": "Rodger Feest", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1456.66, "details": [ { "name": "CreditNotes", "amount": -1456.66 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 7366.21, "details": [ { "name": "Invoices", "amount": 7366.21 } ] } ] } ] }, { "customerId": "dc75136b-b504-49c5-be35-04e1d2771e1e", "customerName": "Vincenzo Wolff", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -80.97, "details": [ { "name": "CreditNotes", "amount": -80.97 }, { "name": "Invoices", "amount": 0 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Invoices", "amount": 0 } ] } ] } ] } ] } }, "Dynamics 365 Business Central": { "value": { "generated": "2023-05-02T16:05:20.8918448Z", "reportDate": "2023-05-02T16:05:20.8411594Z", "data": [ { "customerId": "8ddfa6bf-0c60-eb11-89fa-00224800af18", "customerName": "Abdi Company", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -80, "details": [ { "name": "CreditNotes", "amount": -80 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -257.28, "details": [ { "name": "Payments", "amount": -300 }, { "name": "Invoices", "amount": 42.72 } ] } ] } ] }, { "customerId": "b41217b3-89d1-ea11-bbaa-000d3a2b9185", "customerName": "Adatum Corporation", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1558.56, "details": [ { "name": "CreditNotes", "amount": -1558.56 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 33200.76, "details": [ { "name": "Invoices", "amount": 34782.32 }, { "name": "Payments", "amount": -1581.56 } ] } ] }, { "currency": "HKD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 8554.46, "details": [ { "name": "Invoices", "amount": 8554.46 } ] } ] } ] }, { "customerId": "ba1217b3-89d1-ea11-bbaa-000d3a2b9185", "customerName": "Alpine Ski House", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 7503.08, "details": [ { "name": "Invoices", "amount": 7503.08 } ] } ] } ] }, { "customerId": "f5860a8e-4b5a-eb11-89fa-00224800af18", "customerName": "CustomerQA", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 349.68, "details": [ { "name": "Invoices", "amount": 349.68 } ] } ] } ] }, { "customerId": "feef29a2-1d59-ed11-8c36-002248c5e6c0", "customerName": "DP Test Customer", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 332.2, "details": [ { "name": "Invoices", "amount": 427.2 }, { "name": "Payments", "amount": -95 } ] } ] } ] }, { "customerId": "264d74d4-3218-ed11-90eb-000d3a873415", "customerName": "Eliana", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -779.28, "details": [ { "name": "CreditNotes", "amount": -779.28 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1905, "details": [ { "name": "Invoices", "amount": 1905 } ] } ] } ] }, { "customerId": "99faf6fb-5209-eb11-bbf6-0022481ad2e8", "customerName": "QA Customer", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4923.48, "details": [ { "name": "Invoices", "amount": 4923.48 } ] } ] } ] }, { "customerId": "bc1217b3-89d1-ea11-bbaa-000d3a2b9185", "customerName": "Relecloud", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 10559.04, "details": [ { "name": "Invoices", "amount": 10559.04 } ] } ] } ] }, { "customerId": "b81217b3-89d1-ea11-bbaa-000d3a2b9185", "customerName": "School of Fine Art", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 33438.88, "details": [ { "name": "Invoices", "amount": 34811.2 }, { "name": "Payments", "amount": -1372.32 } ] } ] } ] }, { "customerId": "dc3f4f1b-3c54-ed11-9470-002248c5e18c", "customerName": "Test no payment terms", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 10, "details": [ { "name": "Invoices", "amount": 10 } ] } ] } ] }, { "customerId": "9e55a119-064e-ed11-946f-0022481b84d7", "customerName": "Test Push", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 126, "details": [ { "name": "Invoices", "amount": 126 } ] } ] } ] }, { "customerId": "b30ca600-074e-ed11-946f-0022481b84d7", "customerName": "Test Push", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 116, "details": [ { "name": "Invoices", "amount": 116 } ] } ] } ] }, { "customerId": "b61217b3-89d1-ea11-bbaa-000d3a2b9185", "customerName": "Trey Researches", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -24, "details": [ { "name": "CreditNotes", "amount": -24 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2663.38, "details": [ { "name": "Payments", "amount": 10 }, { "name": "Invoices", "amount": 2653.38 } ] } ] } ] }, { "customerId": "d93ceb37-b805-ec11-86bc-0022481a45c2", "customerName": "Vegan Bakeshop", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -18.67, "details": [ { "name": "Payments", "amount": -18.67 } ] } ] } ] } ] } }, "FreshBooks": { "value": { "generated": "2023-05-02T16:05:20.6173310Z", "reportDate": "2023-05-02T16:05:20.5039554Z", "data": [ { "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -1, "details": [ { "name": "Payments", "amount": -1 } ] } ] } ] }, { "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -5, "details": [ { "name": "Payments", "amount": -5 } ] } ] } ] }, { "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -500, "details": [ { "name": "Payments", "amount": -500 }, { "name": "Invoices", "amount": 0 } ] } ] } ] }, { "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -100, "details": [ { "name": "Payments", "amount": -100 } ] } ] } ] }, { "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -49, "details": [ { "name": "Payments", "amount": -49 } ] } ] } ] }, { "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -10, "details": [ { "name": "Payments", "amount": -10 } ] } ] } ] }, { "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 100, "details": [ { "name": "Invoices", "amount": 100 } ] } ] } ] }, { "customerId": "602174", "customerName": "ab1", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 222.71, "details": [ { "name": "Invoices", "amount": 222.71 } ] } ] }, { "currency": "AED", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -5, "details": [ { "name": "Payments", "amount": -5 } ] } ] } ] }, { "customerId": "511657", "customerName": "Bob's Stationary", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -2060.2, "details": [ { "name": "Payments", "amount": -2083.83 }, { "name": "Invoices", "amount": 23.63 } ] } ] } ] }, { "customerId": "581145", "customerName": "CanadaCo", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -132.15, "details": [ { "name": "Payments", "amount": -160.9 }, { "name": "Invoices", "amount": 28.75 } ] } ] }, { "currency": "CNY", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2.88, "details": [ { "name": "Invoices", "amount": 2.88 } ] } ] } ] }, { "customerId": "578409", "customerName": "company1", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -1031.45, "details": [ { "name": "Invoices", "amount": 144 }, { "name": "Payments", "amount": -1175.45 } ] } ] }, { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -100.29, "details": [ { "name": "Invoices", "amount": 0 }, { "name": "Payments", "amount": -100.29 } ] } ] } ] }, { "customerId": "669531", "customerName": "P", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 24.98, "details": [ { "name": "Invoices", "amount": 24.98 } ] } ] } ] }, { "customerId": "515655", "customerName": "Parent company", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -2898.25, "details": [ { "name": "Payments", "amount": -2898.25 }, { "name": "Invoices", "amount": 0 } ] } ] } ] }, { "customerId": "511669", "customerName": "Pens International", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 516.3, "details": [ { "name": "Payments", "amount": 0 }, { "name": "Invoices", "amount": 516.3 } ] } ] } ] }, { "customerId": "582461", "customerName": "QA Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -76, "details": [ { "name": "Invoices", "amount": 20 }, { "name": "Payments", "amount": -96 } ] } ] }, { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -1.15, "details": [ { "name": "Payments", "amount": -1.15 } ] } ] } ] }, { "customerId": "511661", "customerName": "Sarah's Office Supplies", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -10, "details": [ { "name": "Invoices", "amount": 0 }, { "name": "Payments", "amount": -10 } ] } ] } ] }, { "customerId": "572047", "customerName": "SRS Customer", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 141.25, "details": [ { "name": "Invoices", "amount": 141.25 } ] } ] } ] }, { "customerId": "536295", "customerName": "Test company", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -144.46, "details": [ { "name": "Invoices", "amount": 7.64 }, { "name": "Payments", "amount": -152.1 } ] } ] } ] }, { "customerId": "512927", "customerName": "Wood Turnerss", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 48442.07, "details": [ { "name": "Invoices", "amount": 51089.28 }, { "name": "Payments", "amount": -2647.21 } ] } ] }, { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -10, "details": [ { "name": "Invoices", "amount": 0 }, { "name": "Payments", "amount": -10 } ] } ] }, { "currency": "CAD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 192.28, "details": [ { "name": "Invoices", "amount": 1186.28 }, { "name": "Payments", "amount": -994 } ] } ] } ] } ] } }, "KashFlow": { "value": { "generated": "2023-05-02T16:05:20.3727270Z", "reportDate": "2023-05-02T16:05:20.3123550Z", "data": [ { "customerId": "88459410", "customerName": "Diogo Sousa", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 482.57, "details": [ { "name": "Invoices", "amount": 482.57 } ] } ] } ] }, { "customerId": "86810130", "customerName": "Maria Gomez", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -216, "details": [ { "name": "Invoices", "amount": -216 } ] } ] } ] }, { "customerId": "86832299", "customerName": "Mr French Person", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 5, "details": [ { "name": "Invoices", "amount": 5 } ] } ] }, { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 5, "details": [ { "name": "Invoices", "amount": 5 } ] } ] } ] }, { "customerId": "69946501", "customerName": "Peter Lord", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3, "details": [ { "name": "Invoices", "amount": 3 } ] } ] }, { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -46, "details": [ { "name": "CreditNotes", "amount": -46 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 55661.49, "details": [ { "name": "Invoices", "amount": 55911.49 }, { "name": "Payments", "amount": -250 } ] } ] } ] }, { "customerId": "88353693", "customerName": "Test Customer updated", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4771.03, "details": [ { "name": "Invoices", "amount": 4771.03 } ] } ] } ] }, { "customerId": "69952389", "customerName": "Things Limited", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -42.42, "details": [ { "name": "CreditNotes", "amount": -42.42 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 6385, "details": [ { "name": "Invoices", "amount": 6385 } ] } ] } ] } ] } }, "MYOB AccountRight and Essentials": { "value": { "generated": "2023-05-02T16:05:21.0942911Z", "reportDate": "2023-05-02T16:05:20.8602315Z", "data": [] } }, "Oracle NetSuite": { "value": { "generated": "2023-05-02T16:05:20.0339587Z", "reportDate": "2023-05-02T16:05:19.8669114Z", "data": [] } }, "QuickBooks Desktop": { "value": { "generated": "2023-05-02T16:05:19.9204890Z", "reportDate": "2023-05-02T16:05:19.8723073Z", "data": [ { "customerId": "1F0000-933272658", "customerName": "Jacobsen, Doug", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 7991.52, "details": [ { "name": "Invoices", "amount": 7991.52 }, { "name": "Payments", "amount": 0 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "customerId": "6F0000-1071510646", "customerName": "Morgenthaler, Jenny", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -271.53, "details": [ { "name": "Payments", "amount": -271.53 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] } ] } }, "QuickBooks Online": { "value": { "generated": "2023-05-02T16:05:21.0640297Z", "reportDate": "2023-05-02T16:05:20.9965545Z", "data": [ { "customerId": "67", "customerName": "Abercrombie International Group", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -837.11, "details": [ { "name": "CreditNotes", "amount": -837.11 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 55512.84, "details": [ { "name": "Invoices", "amount": 55578.69 }, { "name": "Payments", "amount": -65.85 } ] } ] }, { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 10, "details": [ { "name": "Payments", "amount": 10 } ] } ] } ] }, { "customerId": "4", "customerName": "Cathy's Consulting Company", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -905.8, "details": [ { "name": "Invoices", "amount": 314.2 }, { "name": "Payments", "amount": -1220 } ] } ] } ] }, { "customerId": "20", "customerName": "Chadha's Consultants", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -75, "details": [ { "name": "Payments", "amount": -75 } ] } ] } ] }, { "customerId": "7", "customerName": "Clement's Cleaners", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 24, "details": [ { "name": "Invoices", "amount": 24 } ] } ] } ] }, { "customerId": "301", "customerName": "Codat Customer", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -650.27, "details": [ { "name": "Invoices", "amount": 15 }, { "name": "CreditNotes", "amount": -469.52 }, { "name": "Payments", "amount": -195.75 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 266.49, "details": [ { "name": "Invoices", "amount": 210.01 }, { "name": "Payments", "amount": 56.48 } ] } ] } ] }, { "customerId": "305", "customerName": "Codat Customer (USD)", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Payments", "amount": 0 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 121.5, "details": [ { "name": "Invoices", "amount": 0 }, { "name": "Payments", "amount": 121.5 } ] } ] }, { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 10, "details": [ { "name": "Payments", "amount": 10 } ] } ] } ] }, { "customerId": "136", "customerName": "Customer Name", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 13.37, "details": [ { "name": "Payments", "amount": 13.37 } ] } ] } ] }, { "customerId": "218", "customerName": "Diego Trantow", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 11.65, "details": [ { "name": "Payments", "amount": 11.65 } ] } ] } ] }, { "customerId": "8", "customerName": "Ecker Designs", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2273, "details": [ { "name": "Invoices", "amount": 2273 } ] } ] } ] }, { "customerId": "59", "customerName": "Ecker Holiday event", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3206779, "details": [ { "name": "Invoices", "amount": 3206779 } ] } ] } ] }, { "customerId": "13", "customerName": "Himateja Madala", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -100, "details": [ { "name": "Invoices", "amount": 0 }, { "name": "Payments", "amount": -100 } ] } ] } ] }, { "customerId": "11", "customerName": "Ho Engineering Company", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 10, "details": [ { "name": "Invoices", "amount": 10 } ] } ] } ] }, { "customerId": "114", "customerName": "huw default not included", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 116.4, "details": [ { "name": "Invoices", "amount": 116.4 } ] } ] } ] }, { "customerId": "117", "customerName": "Huw's Test Push customer2", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -521.4, "details": [ { "name": "CreditNotes", "amount": -521.4 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1120.6, "details": [ { "name": "Invoices", "amount": 1232.2 }, { "name": "Payments", "amount": -111.6 } ] } ] } ] }, { "customerId": "306", "customerName": "J Codat", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 32.1, "details": [ { "name": "Invoices", "amount": 176.1 }, { "name": "Payments", "amount": -144 } ] } ] } ] }, { "customerId": "15", "customerName": "Jen Zaccarella", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4800, "details": [ { "name": "Invoices", "amount": 4800 } ] } ] } ] }, { "customerId": "307", "customerName": "Jo Codat 2", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 112.6, "details": [ { "name": "Invoices", "amount": 143.96 }, { "name": "Payments", "amount": 58.14 }, { "name": "CreditNotes", "amount": -89.5 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "customerId": "119", "customerName": "John Smith 1", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 160, "details": [ { "name": "Invoices", "amount": 160 } ] } ] } ] }, { "customerId": "16", "customerName": "Jordan Burgess", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1098, "details": [ { "name": "CreditNotes", "amount": -1098 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -60, "details": [ { "name": "Invoices", "amount": 0 }, { "name": "Payments", "amount": -60 } ] } ] } ] }, { "customerId": "83", "customerName": "Kay's Bake Shop", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 8508.37, "details": [ { "name": "Invoices", "amount": 8717.33 }, { "name": "Payments", "amount": -208.96 } ] } ] } ] }, { "customerId": "1", "customerName": "Ko International Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -3586.2, "details": [ { "name": "CreditNotes", "amount": -3586.2 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 11291.4, "details": [ { "name": "Invoices", "amount": 11474.05 }, { "name": "Payments", "amount": -182.65 } ] } ] } ] }, { "customerId": "91", "customerName": "Mr Huw Test", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -2311.27, "details": [ { "name": "CreditNotes", "amount": -2311.27 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2292.91, "details": [ { "name": "Invoices", "amount": 2290.91 }, { "name": "Payments", "amount": 2 } ] } ] } ] }, { "customerId": "55", "customerName": "Oxon Insurance - Holiday Party", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -10800, "details": [ { "name": "Payments", "amount": -10800 } ] } ] } ] }, { "customerId": "70", "customerName": "Project X", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 50, "details": [ { "name": "Invoices", "amount": 50 } ] } ] } ] }, { "customerId": "281", "customerName": "Renee O'Connell", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 12.75, "details": [ { "name": "Payments", "amount": 12.75 } ] } ] } ] }, { "customerId": "118", "customerName": "RSP", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 100, "details": [ { "name": "Payments", "amount": 100 } ] } ] } ] }, { "customerId": "76", "customerName": "TestPushCustomer5", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1320, "details": [ { "name": "Invoices", "amount": 1320 } ] } ] } ] }, { "customerId": "77", "customerName": "TestPushCustomer6", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1848, "details": [ { "name": "Invoices", "amount": 1848 } ] } ] } ] }, { "customerId": "79", "customerName": "TestPushCustomer7", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -25, "details": [ { "name": "Payments", "amount": -25 } ] } ] } ] }, { "customerId": "84", "customerName": "Vegan Cake Shop", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -86.4, "details": [ { "name": "CreditNotes", "amount": -116.4 }, { "name": "Payments", "amount": 30 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -206460.15, "details": [ { "name": "Invoices", "amount": 5145.29 }, { "name": "Payments", "amount": -211605.44 } ] } ] } ] }, { "customerId": "60", "customerName": "Whitehead - Employee celebration", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1100, "details": [ { "name": "CreditNotes", "amount": -1100 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "customerId": "5", "customerName": "Whitehead and Sons", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 754.4, "details": [ { "name": "Invoices", "amount": 754.4 } ] } ] } ] }, { "customerId": "3", "customerName": "Yeung's Architects", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -600, "details": [ { "name": "CreditNotes", "amount": -600 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 20035.25, "details": [ { "name": "Invoices", "amount": 20604.49 }, { "name": "Payments", "amount": -569.24 } ] } ] } ] } ] } }, "Sage 200cloud": { "value": { "generated": "2023-05-02T16:05:20.5553019Z", "reportDate": "2023-05-02T16:05:20.4958267Z", "data": [ { "customerId": "A1D001", "customerName": "A1 Design Services", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -378, "details": [ { "name": "CreditNotes", "amount": -378 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4504.07, "details": [ { "name": "Invoices", "amount": 4505.07 }, { "name": "Payments", "amount": -1 } ] } ] } ] }, { "customerId": "A1D002", "customerName": "A2 Design Services", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -66, "details": [ { "name": "CreditNotes", "amount": -66 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 540, "details": [ { "name": "Invoices", "amount": 540 } ] } ] } ] }, { "customerId": "A1D003", "customerName": "A2 Design Services", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -24.71, "details": [ { "name": "CreditNotes", "amount": -24.71 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 16606.32, "details": [ { "name": "Invoices", "amount": 16606.32 } ] } ] } ] }, { "customerId": "ABS001", "customerName": "ABS Garages Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -177.14, "details": [ { "name": "CreditNotes", "amount": -177.14 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4345.3, "details": [ { "name": "Invoices", "amount": 4845.3 }, { "name": "Payments", "amount": -500 } ] } ] } ] }, { "customerId": "USA1", "customerName": "American Sales", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 100, "details": [ { "name": "Invoices", "amount": 100 } ] } ] } ] }, { "customerId": "BBS001", "customerName": "Bobs Building Supplies", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -103.16, "details": [ { "name": "CreditNotes", "amount": -103.16 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4284.77, "details": [ { "name": "Invoices", "amount": 4309.77 }, { "name": "Payments", "amount": -25 } ] } ] } ] }, { "customerId": "BRO001", "customerName": "Bronson Inc", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 786.48, "details": [ { "name": "Invoices", "amount": 852 }, { "name": "Payments", "amount": -65.52 } ] } ] } ] }, { "customerId": "BUS001", "customerName": "Business Exhibitions", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2274.62, "details": [ { "name": "Invoices", "amount": 2374.62 }, { "name": "Payments", "amount": -100 } ] } ] } ] }, { "customerId": "CASH001", "customerName": "Cash and Credit Card Sales", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 324.5, "details": [ { "name": "Invoices", "amount": 324.5 } ] } ] } ] }, { "customerId": "COM001", "customerName": "Compton Packaging", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4571.04, "details": [ { "name": "Invoices", "amount": 4571.04 } ] } ] } ] }, { "customerId": "CGS001", "customerName": "County Golf Supplies", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2028.03, "details": [ { "name": "Invoices", "amount": 2028.03 } ] } ] } ] }, { "customerId": "STU001", "customerName": "Edward Stuart", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2341.25, "details": [ { "name": "Invoices", "amount": 2341.25 } ] } ] } ] }, { "customerId": "FGL001", "customerName": "F G Landscape & Design", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 11260.26, "details": [ { "name": "Invoices", "amount": 11260.26 } ] } ] } ] }, { "customerId": "BRI001", "customerName": "Fred Briant", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 536.67, "details": [ { "name": "Invoices", "amount": 656.67 }, { "name": "Payments", "amount": -120 } ] } ] } ] }, { "customerId": "GRA001", "customerName": "Graham Electonics", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4149.09, "details": [ { "name": "Invoices", "amount": 4149.09 } ] } ] } ] }, { "customerId": "HAU001", "customerName": "Hausser GMBH", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2082.96, "details": [ { "name": "Invoices", "amount": 2082.96 } ] } ] } ] }, { "customerId": "JSS001", "customerName": "John Smith Studios", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1228.34, "details": [ { "name": "Invoices", "amount": 1228.34 } ] } ] } ] }, { "customerId": "KIN001", "customerName": "Kinghorn & French", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 9254.03, "details": [ { "name": "Invoices", "amount": 9254.03 } ] } ] } ] }, { "customerId": "MAC001", "customerName": "Macolm Hall Associates", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 6927.26, "details": [ { "name": "Invoices", "amount": 6927.26 } ] } ] } ] }, { "customerId": "1A2B3C", "customerName": "Maria Company", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 69.12, "details": [ { "name": "Invoices", "amount": 69.12 } ] } ] } ] }, { "customerId": "MIB001", "customerName": "Mikes Insurance Services", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3597.16, "details": [ { "name": "Invoices", "amount": 3597.16 } ] } ] } ] }, { "customerId": "MIL001", "customerName": "Mile Road Health Centre", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 5644.12, "details": [ { "name": "Invoices", "amount": 6644.12 }, { "name": "Payments", "amount": -1000 } ] } ] } ] }, { "customerId": "MOR001", "customerName": "Morley Solicitors", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 392.67, "details": [ { "name": "Invoices", "amount": 1767.67 }, { "name": "Payments", "amount": -1375 } ] } ] } ] }, { "customerId": "PAT001", "customerName": "Patterson & Graham Garages", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 915.24, "details": [ { "name": "Invoices", "amount": 915.24 } ] } ] } ] }, { "customerId": "YOU001", "customerName": "Peter Young", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -168, "details": [ { "name": "CreditNotes", "amount": -168 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2106.84, "details": [ { "name": "Invoices", "amount": 2106.84 } ] } ] } ] }, { "customerId": "PIC001", "customerName": "Picture Frame Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 546.12, "details": [ { "name": "Invoices", "amount": 1413.9 }, { "name": "Payments", "amount": -867.78 } ] } ] } ] }, { "customerId": "RSP001", "customerName": "Richard Sanderson-Pope", "agedCurrencyOutstanding": [ { "currency": "JPY", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -29210, "details": [ { "name": "CreditNotes", "amount": -29210 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 623907.28, "details": [ { "name": "Invoices", "amount": 624053.94 }, { "name": "Payments", "amount": -146.66 } ] } ] } ] }, { "customerId": "ROB001", "customerName": "Robertson Joinery", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4550.2, "details": [ { "name": "Invoices", "amount": 4550.2 } ] } ] } ] }, { "customerId": "SDE001", "customerName": "S D Enterprises", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 15339.68, "details": [ { "name": "Invoices", "amount": 15339.68 } ] } ] } ] }, { "customerId": "STE001", "customerName": "Stevenson & Smith", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1562.75, "details": [ { "name": "Invoices", "amount": 1562.75 } ] } ] } ] }, { "customerId": "SWA001", "customerName": "Swan Leisure Centre", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -16.68, "details": [ { "name": "CreditNotes", "amount": -16.68 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1615.51, "details": [ { "name": "Invoices", "amount": 1615.51 } ] } ] } ] }, { "customerId": "0001", "customerName": "Test Customer01", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -366.71, "details": [ { "name": "CreditNotes", "amount": -366.71 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 900.22, "details": [ { "name": "Invoices", "amount": 913.38 }, { "name": "Payments", "amount": -13.16 } ] } ] } ] }, { "customerId": "TESTSUPP", "customerName": "Test supplier for testing purposes 1234567891234567891234567", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 149.61, "details": [ { "name": "Invoices", "amount": 149.61 } ] } ] } ] }, { "customerId": "SHO001", "customerName": "The Show Lodge", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 7148.07, "details": [ { "name": "Invoices", "amount": 7148.07 } ] } ] } ] }, { "customerId": "VID001", "customerName": "The Video Rental Company", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2041.66, "details": [ { "name": "Invoices", "amount": 2041.66 } ] } ] } ] } ] } }, "Sage 50 (UK)": { "value": { "generated": "2023-05-02T16:05:19.8072734Z", "reportDate": "2023-05-02T16:05:19.7472225Z", "data": [ { "customerId": "A1D001", "customerName": "A1 Design Services", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -5.37, "details": [ { "name": "Invoices", "amount": -5.37 } ] } ] } ] }, { "customerId": "ABS001", "customerName": "ABS Garages Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2454.97, "details": [ { "name": "Invoices", "amount": 2454.97 } ] } ] } ] }, { "customerId": "BBS001", "customerName": "Bobs Building Supplies", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4309.77, "details": [ { "name": "Invoices", "amount": 4309.77 } ] } ] } ] }, { "customerId": "BUS001", "customerName": "Business Exhibitions", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2066.61, "details": [ { "name": "Invoices", "amount": 2166.61 }, { "name": "Payments", "amount": -100 } ] } ] } ] }, { "customerId": "CASH001", "customerName": "Cash and Credit Card Sales", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -0.01, "details": [ { "name": "Invoices", "amount": -0.01 } ] } ] } ] }, { "customerId": "COM001", "customerName": "Compton Packaging", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2749.02, "details": [ { "name": "Invoices", "amount": 2749.02 } ] } ] } ] }, { "customerId": "CGS001", "customerName": "County Golf Supplies", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2028.03, "details": [ { "name": "Invoices", "amount": 2028.03 } ] } ] } ] }, { "customerId": "STU001", "customerName": "Edward Stuart", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2341.25, "details": [ { "name": "Invoices", "amount": 2341.25 } ] } ] } ] }, { "customerId": "FGL001", "customerName": "F G Landscape & Design", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 11256.18, "details": [ { "name": "Invoices", "amount": 11256.18 } ] } ] } ] }, { "customerId": "GRA001", "customerName": "Graham Electonics", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4149.08, "details": [ { "name": "Invoices", "amount": 4149.08 } ] } ] } ] }, { "customerId": "HAU001", "customerName": "Hausser GMBH", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1965.96, "details": [ { "name": "Invoices", "amount": 1965.96 } ] } ] } ] }, { "customerId": "JSS001", "customerName": "John Smith Studios", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 977.09, "details": [ { "name": "Invoices", "amount": 977.09 } ] } ] } ] }, { "customerId": "KIN001", "customerName": "Kinghorn & French", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 7398.33, "details": [ { "name": "Invoices", "amount": 7398.33 } ] } ] } ] }, { "customerId": "MAC001", "customerName": "Macolm Hall Associates", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 6916.46, "details": [ { "name": "Invoices", "amount": 6916.46 } ] } ] } ] }, { "customerId": "MIB001", "customerName": "Mikes Insurance Services", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3525.26, "details": [ { "name": "Invoices", "amount": 3525.26 } ] } ] } ] }, { "customerId": "MIL001", "customerName": "Mile Road Health Centre", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2307.84, "details": [ { "name": "Invoices", "amount": 3307.84 }, { "name": "Payments", "amount": -1000 } ] } ] } ] }, { "customerId": "MOR001", "customerName": "Morley Solicitors", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 370.27, "details": [ { "name": "Invoices", "amount": 1745.27 }, { "name": "Payments", "amount": -1375 } ] } ] } ] }, { "customerId": "PAT001", "customerName": "Patterson & Graham Garages", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 915.24, "details": [ { "name": "Invoices", "amount": 915.24 } ] } ] } ] }, { "customerId": "YOU001", "customerName": "Peter Young", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2115.77, "details": [ { "name": "Invoices", "amount": 2115.77 } ] } ] } ] }, { "customerId": "PIC001", "customerName": "Picture Frame Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 268.93, "details": [ { "name": "Invoices", "amount": 1136.71 }, { "name": "Payments", "amount": -867.78 } ] } ] } ] }, { "customerId": "ROB001", "customerName": "Robertson Joinery", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4530.98, "details": [ { "name": "Invoices", "amount": 4530.98 } ] } ] } ] }, { "customerId": "SDE001", "customerName": "S D Enterprises", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 15339.68, "details": [ { "name": "Invoices", "amount": 15339.68 } ] } ] } ] }, { "customerId": "STE002", "customerName": "Steven Stephenson", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 8.35, "details": [ { "name": "Invoices", "amount": 8.35 } ] } ] } ] }, { "customerId": "STE001", "customerName": "Stevenson & Smith", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1562.75, "details": [ { "name": "Invoices", "amount": 1562.75 } ] } ] } ] }, { "customerId": "SWA001", "customerName": "Swan Leisure Centre", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -16.68, "details": [ { "name": "CreditNotes", "amount": -16.68 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1615.51, "details": [ { "name": "Invoices", "amount": 1615.51 } ] } ] } ] }, { "customerId": "SHO001", "customerName": "The Show Lodge", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 7305.77, "details": [ { "name": "Invoices", "amount": 7305.77 } ] } ] } ] }, { "customerId": "VID001", "customerName": "The Video Rental Company", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2041.64, "details": [ { "name": "Invoices", "amount": 2041.64 } ] } ] } ] } ] } }, "Sage Business Cloud Accounting": { "value": { "generated": "2023-05-02T16:05:20.9416221Z", "reportDate": "2023-05-02T16:05:20.7435694Z", "data": [ { "customerId": "260f6a3f94a243738f2d5e08496a41a8", "customerName": "100 test name", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -60, "details": [ { "name": "CreditNotes", "amount": -60 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1471, "details": [ { "name": "Invoices", "amount": 1891 }, { "name": "Payments", "amount": -420 } ] } ] } ] }, { "customerId": "860dd9f1ad9346ba85117aedfa19cc72", "customerName": "100 test name DS", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1065, "details": [ { "name": "Invoices", "amount": 1080 }, { "name": "Payments", "amount": -15 } ] } ] } ] }, { "customerId": "395d26ee8ab44f8b861b468caf63b00d", "customerName": "222 Abdul's Test Name", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -120, "details": [ { "name": "CreditNotes", "amount": -120 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2443.8, "details": [ { "name": "Invoices", "amount": 2759.8 }, { "name": "Payments", "amount": -316 } ] } ] } ] }, { "customerId": "013cf04960924a0da800f019369c3262", "customerName": "333 Abdul's Test Name", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -0.66, "details": [ { "name": "Invoices", "amount": 9.34 }, { "name": "Payments", "amount": -10 } ] } ] } ] }, { "customerId": "4ba77efb904e4380accc242b1526ac2c", "customerName": "333 Abdul's Test Name", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -10, "details": [ { "name": "CreditNotes", "amount": -10 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 65, "details": [ { "name": "Invoices", "amount": 65 } ] } ] } ] }, { "customerId": "18e45991fe6440ad8e8b5ecf9a2e7e09", "customerName": "444 Abdul's Test Name", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -2, "details": [ { "name": "Invoices", "amount": 48 }, { "name": "Payments", "amount": -50 } ] } ] } ] }, { "customerId": "23ca7ffaa2b54360937531dde804c9aa", "customerName": "aaa", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -22, "details": [ { "name": "CreditNotes", "amount": -22 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -62, "details": [ { "name": "Invoices", "amount": 7 }, { "name": "Payments", "amount": -69 } ] } ] } ] }, { "customerId": "2b93da6ce4af4dc99520eafd28768457", "customerName": "Abdul Al-haj", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 288, "details": [ { "name": "Invoices", "amount": 288 } ] } ] } ] }, { "customerId": "460af92dd82a4a61b6ce1d18245789b3", "customerName": "Abdul Al-haj", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 48, "details": [ { "name": "Invoices", "amount": 48 } ] } ] } ] }, { "customerId": "b8bd7e0dfdd64d39abaaf2dcd1c48b49", "customerName": "Abdul Al-haj", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -119.99, "details": [ { "name": "CreditNotes", "amount": -119.99 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "customerId": "aa37b59417024d2494f01ba23d92a2ef", "customerName": "Abe The Engineer", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1562, "details": [ { "name": "CreditNotes", "amount": -1562 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1337, "details": [ { "name": "Invoices", "amount": 1362 }, { "name": "Payments", "amount": -25 } ] } ] } ] }, { "customerId": "df65eaa6789111e8aaa5027d54329956", "customerName": "Baguettes Ltd", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -844.99, "details": [ { "name": "CreditNotes", "amount": -844.99 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 616726.02, "details": [ { "name": "Invoices", "amount": 617888.74 }, { "name": "Payments", "amount": -1162.72 } ] } ] } ] }, { "customerId": "2916114b3b6942a7b08f1bcc971f5bf9", "customerName": "c.taylor@codat.io", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1.2, "details": [ { "name": "Invoices", "amount": 1.2 } ] } ] } ] }, { "customerId": "0556b365ef4e42068fff775f847c0330", "customerName": "Customer 71 (AUD)", "agedCurrencyOutstanding": [ { "currency": "AUD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -701, "details": [ { "name": "Payments", "amount": -701 } ] } ] } ] }, { "customerId": "145dee01b49c4359a052682f234007e3", "customerName": "Customer Name", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -10, "details": [ { "name": "Payments", "amount": -10 } ] } ] } ] }, { "customerId": "76f656dfbafa4cec823f1e2e43ea1a8e", "customerName": "Customer Test 59", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -10, "details": [ { "name": "Payments", "amount": -10 } ] } ] } ] }, { "customerId": "a11e6776ca9a4e16af3425982de25a22", "customerName": "Debs Customer", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 5279.2, "details": [ { "name": "Invoices", "amount": 5279.2 } ] } ] } ] }, { "customerId": "cc80e0fb747e4ddaab743d778d04ec4a", "customerName": "Debs US Customer", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 15111, "details": [ { "name": "Invoices", "amount": 15111 } ] } ] } ] }, { "customerId": "adb9cae8b34e446da3d53305b299168b", "customerName": "Fo Shizzle", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 300, "details": [ { "name": "Invoices", "amount": 300 } ] } ] } ] }, { "customerId": "cc745370213545f6bd4129a7502f19fb", "customerName": "Grace Lo", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -1150, "details": [ { "name": "Invoices", "amount": 0 }, { "name": "Payments", "amount": -1150 } ] } ] } ] }, { "customerId": "3b17c5ae9caf4b88a4a9e33a83fa321d", "customerName": "Hello", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 12, "details": [ { "name": "Invoices", "amount": 12 } ] } ] } ] }, { "customerId": "979c5156ea0e45d9a9ea7b9d54775138", "customerName": "J Customer FR", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -52795, "details": [ { "name": "CreditNotes", "amount": -52795 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 134045, "details": [ { "name": "Invoices", "amount": 134045 } ] } ] } ] }, { "customerId": "99d52ca7060341a698a664d1737663c5", "customerName": "J Customer UK", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -265, "details": [ { "name": "CreditNotes", "amount": -265 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 15, "details": [ { "name": "Invoices", "amount": 30 }, { "name": "Payments", "amount": -15 } ] } ] } ] }, { "customerId": "f40870d5b704407481be14f780122d4f", "customerName": "J Customer US", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -161570, "details": [ { "name": "CreditNotes", "amount": -161570 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 181372, "details": [ { "name": "Invoices", "amount": 181372 } ] } ] } ] }, { "customerId": "50a66e9756d2416d946419948bcf3631", "customerName": "J Customer ZA", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -10, "details": [ { "name": "CreditNotes", "amount": -10 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "customerId": "0328dd6b109a4a6cbcb3d1a73f1d541b", "customerName": "James Arroyo", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -719, "details": [ { "name": "Invoices", "amount": 178 }, { "name": "Payments", "amount": -897 } ] } ] } ] }, { "customerId": "bca2a47d7b4549c79b0c092d26b6661c", "customerName": "Jay Farm", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 25.01, "details": [ { "name": "Invoices", "amount": 25.01 } ] } ] } ] }, { "customerId": "6477be6d012b4d48b4c160c098645c1c", "customerName": "Jo's Bake Shop", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -37.8, "details": [ { "name": "CreditNotes", "amount": -37.8 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 22.25, "details": [ { "name": "Invoices", "amount": 48 }, { "name": "Payments", "amount": -25.75 } ] } ] } ] }, { "customerId": "097305a078ba473c884d2519ab290e57", "customerName": "John QuickEntry Test", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 396, "details": [ { "name": "Invoices", "amount": 396 } ] } ] } ] }, { "customerId": "eac978a7622e4ef8b8d3af661f0cfdd3", "customerName": "John Smith", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 200, "details": [ { "name": "Invoices", "amount": 200 } ] } ] } ] }, { "customerId": "3cc3148bbd8111e8bad90617b3da4b8a", "customerName": "John's Test Customer", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1081.2, "details": [ { "name": "CreditNotes", "amount": -1081.2 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3379, "details": [ { "name": "Invoices", "amount": 3479 }, { "name": "Payments", "amount": -100 } ] } ] } ] }, { "customerId": "f66deccde15843ef80a82daad887146b", "customerName": "Kiran testing 2", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 48, "details": [ { "name": "Invoices", "amount": 48 } ] } ] } ] }, { "customerId": "6e921696a21a45c891ff4716a18e7649", "customerName": "M Smith", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 900, "details": [ { "name": "Invoices", "amount": 900 } ] } ] } ] }, { "customerId": "bbb0582a0d054f5db268e570b50b4d6c", "customerName": "Mark Smith", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 40, "details": [ { "name": "Invoices", "amount": 40 } ] } ] } ] }, { "customerId": "440ba2199c07426a93e8edc1beb09791", "customerName": "Matt Ager test EUR customer", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -8159.78, "details": [ { "name": "CreditNotes", "amount": -8159.78 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 6016.67, "details": [ { "name": "Invoices", "amount": 6022.98 }, { "name": "Payments", "amount": -6.31 } ] } ] } ] }, { "customerId": "d430ed86b05645d7af0a630dae5d11d2", "customerName": "Matthew Smith", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 240, "details": [ { "name": "Invoices", "amount": 240 } ] } ] } ] }, { "customerId": "9e8c3d82a2164ad29e29ab3a09ddf382", "customerName": "Morv Smith", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 300, "details": [ { "name": "Invoices", "amount": 300 } ] } ] } ] }, { "customerId": "fbdd38adb5b4441ebb200b83700d7ea5", "customerName": "My Shop Customer", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -384, "details": [ { "name": "CreditNotes", "amount": -384 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 398, "details": [ { "name": "Invoices", "amount": 398 } ] } ] } ] }, { "customerId": "4b4cc40d998f47c3bec92fc088dcf327", "customerName": "Nicoletta Carchia", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 90, "details": [ { "name": "Invoices", "amount": 90 } ] } ] } ] }, { "customerId": "ed070b1768bb4dd295e2a544a74c8ec0", "customerName": "Paige Burlingham", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -48, "details": [ { "name": "CreditNotes", "amount": -48 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 48, "details": [ { "name": "Invoices", "amount": 48 } ] } ] } ] }, { "customerId": "84709d3f01a4462eb7f1527718f525f4", "customerName": "SageOneCustomer.BusinessName", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1085, "details": [ { "name": "CreditNotes", "amount": -1085 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "customerId": "90c438274d0b43759407da704394c104", "customerName": "Test Company", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -16.2, "details": [ { "name": "CreditNotes", "amount": -16.2 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1137.2, "details": [ { "name": "Invoices", "amount": 1137.2 } ] } ] } ] }, { "customerId": "762e6895c1ff43f988f35fb507e20dd9", "customerName": "Test Custiomer 2", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -615, "details": [ { "name": "CreditNotes", "amount": -615 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2178.25, "details": [ { "name": "Invoices", "amount": 2178.25 } ] } ] } ] }, { "customerId": "7b9c18af4b66454b9f7e9409eb7da123", "customerName": "Test Customer", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1200, "details": [ { "name": "Invoices", "amount": 1200 } ] } ] } ] }, { "customerId": "4ccf5c5fa14046ecb591e0620d87ea2e", "customerName": "Test Customer 3", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -50, "details": [ { "name": "CreditNotes", "amount": -50 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 499971, "details": [ { "name": "Invoices", "amount": 499971 } ] } ] } ] }, { "customerId": "f4ff85ba33dd11e797950a57719b2edb", "customerName": "Widgets Limited", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -23206.12, "details": [ { "name": "CreditNotes", "amount": -23206.12 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 733824.64, "details": [ { "name": "Invoices", "amount": 739536.49 }, { "name": "Payments", "amount": -5711.85 } ] } ] } ] } ] } }, "Sage Intacct": { "value": { "generated": "2023-05-02T16:05:22.6557479Z", "reportDate": "2023-05-02T16:05:22.6081858Z", "data": [ { "customerId": "6", "customerName": "AG Insurance", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 180, "details": [ { "name": "Invoices", "amount": 180 } ] } ] } ] }, { "customerId": "531", "customerName": "Shoprite", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -150, "details": [ { "name": "Payments", "amount": -150 } ] } ] } ] } ] } }, "Xero": { "value": { "generated": "2023-05-02T16:05:20.0730291Z", "reportDate": "2023-05-02T16:05:20.0102278Z", "data": [ { "customerId": "305ca5cf-497d-4fee-a161-cdb30e6be989", "customerName": "Basket Case", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 914.55, "details": [ { "name": "Invoices", "amount": 914.55 } ] } ] } ] }, { "customerId": "362819c9-f285-4d09-ac95-26327863adac", "customerName": "Bayside Club", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3434, "details": [ { "name": "Invoices", "amount": 3434 } ] } ] } ] }, { "customerId": "9ce626d2-14ea-463c-9fff-6785ab5f9bfb", "customerName": "Boom FM", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1623.75, "details": [ { "name": "Invoices", "amount": 1623.75 } ] } ] } ] }, { "customerId": "c523e12f-8b74-4d3a-bbd8-32d7a2f598b4", "customerName": "City Limousines", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1169.95, "details": [ { "name": "Invoices", "amount": 1169.95 } ] } ] } ] }, { "customerId": "1262c350-fe0f-40ec-aeff-41c95b4a45af", "customerName": "DIISR - Small Business Services", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4470.63, "details": [ { "name": "Invoices", "amount": 4470.63 } ] } ] } ] }, { "customerId": "94cb6d7b-5291-49f3-a0bc-fc0c01e68575", "customerName": "Marine Systems", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 396, "details": [ { "name": "Invoices", "amount": 396 } ] } ] } ] }, { "customerId": "847933f0-7c35-4e5b-b884-5f9df64c8e4b", "customerName": "Port & Philip Freight", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2245, "details": [ { "name": "Invoices", "amount": 2245 } ] } ] } ] }, { "customerId": "a871a956-05b5-4e2a-9419-7aeb478ca647", "customerName": "Ridgeway University", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 6187.5, "details": [ { "name": "Invoices", "amount": 6187.5 } ] } ] } ] } ] } }, "Zoho Books": { "value": { "generated": "2023-05-02T16:05:23.2078272Z", "reportDate": "2023-05-02T16:05:23.1573589Z", "data": [ { "customerId": "104957000000054050", "customerName": "Doe, John", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -10567, "details": [ { "name": "CreditNotes", "amount": -10567 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 38965, "details": [ { "name": "Invoices", "amount": 39865 }, { "name": "Payments", "amount": -900 } ] } ] } ] }, { "customerId": "104957000000634160", "customerName": "Dr. Jekyll", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -110, "details": [ { "name": "CreditNotes", "amount": -110 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "customerId": "104957000000080010", "customerName": "Max Mustermann", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -68, "details": [ { "name": "Invoices", "amount": 0 }, { "name": "Payments", "amount": -68 } ] } ] } ] }, { "customerId": "104957000000277089", "customerName": "Miss. No Contact Persons", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -10, "details": [ { "name": "CreditNotes", "amount": -10 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Invoices", "amount": 0 } ] } ] } ] }, { "customerId": "104957000000054080", "customerName": "Ms. Jane Doe", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -465, "details": [ { "name": "CreditNotes", "amount": -465 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "customerId": "104957000000277001", "customerName": "Sousa, Diogo", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 9001, "details": [ { "name": "Invoices", "amount": 9001 } ] } ] } ] }, { "customerId": "104957000000037097", "customerName": "Test Company", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -9001, "details": [ { "name": "CreditNotes", "amount": -9001 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3556.98, "details": [ { "name": "Invoices", "amount": 4501 }, { "name": "Payments", "amount": -944.02 } ] } ] } ] }, { "customerId": "104957000001497001", "customerName": "Will Westrop", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 56, "details": [ { "name": "Invoices", "amount": 56 } ] } ] } ] } ] } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/reports/agedCreditor/available": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Reports" ], "summary": "Aged creditors report available", "description": "Indicates whether the aged creditor report is available for the company.", "operationId": "is-aged-creditors-report-available", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } }, "/companies/{companyId}/reports/agedCreditor": { "parameters": [ { "$ref": "#/components/parameters/companyId" } ], "get": { "tags": [ "Reports" ], "parameters": [ { "$ref": "#/components/parameters/reportDate" }, { "$ref": "#/components/parameters/numberOfPeriods" }, { "$ref": "#/components/parameters/periodLengthDays" } ], "summary": "Aged creditors report", "description": "Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time.", "operationId": "get-aged-creditors-report", "x-speakeasy-name-override": "get-aged-creditors-report", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgedCreditorReport" }, "examples": { "Clear Books": { "value": { "generated": "2023-05-02T16:05:21.7545859Z", "reportDate": "2023-05-02T16:05:21.7016767Z", "data": [ { "supplierId": "owQ2Gqgj9f", "supplierName": "Abshire - Kshlerin", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -78.12, "details": [ { "name": "BillCreditNotes", "amount": -78.12 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 375.6, "details": [ { "name": "Bills", "amount": 375.6 } ] } ] } ] }, { "supplierId": "FyUkHbZxhn", "supplierName": "Arjun Kuvalis", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -3782.27, "details": [ { "name": "BillCreditNotes", "amount": -3782.27 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 8556.1, "details": [ { "name": "Bills", "amount": 8556.1 } ] } ] } ] }, { "supplierId": "gxazX5hqx4", "supplierName": "Bernier Inc", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 213.19, "details": [ { "name": "Bills", "amount": 213.19 } ] } ] } ] }, { "supplierId": "ro8nWYGzlg", "supplierName": "Botsford - Hickle", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -2242.95, "details": [ { "name": "Bills", "amount": 0 }, { "name": "BillCreditNotes", "amount": -2242.95 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 838.67, "details": [ { "name": "Bills", "amount": 838.67 } ] } ] } ] }, { "supplierId": "D4Q4iYwHou", "supplierName": "Breitenberg, Emard and Schiller", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -276.5, "details": [ { "name": "BillCreditNotes", "amount": -276.5 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 46060.53, "details": [ { "name": "Bills", "amount": 46060.53 } ] } ] } ] }, { "supplierId": "9436ead6-545e-4e8c-8444-0220047c5a38", "supplierName": "Champlin LLC", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 22726.97, "details": [ { "name": "Bills", "amount": 22726.97 } ] } ] } ] }, { "supplierId": "O6jExrbN3v", "supplierName": "Collins - Anderson", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -19.39, "details": [ { "name": "BillCreditNotes", "amount": -19.39 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "9d4b61a4-4ce3-4d90-8d6b-66614694dc27", "supplierName": "Crona - Adams", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 302.8, "details": [ { "name": "Bills", "amount": 302.8 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "supplierId": "ad8f4ee1-7a04-415f-b3dc-365d41d8d4f0", "supplierName": "Cronin, Kunde and Tremblay", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -3271.91, "details": [ { "name": "BillCreditNotes", "amount": -3271.91 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3479.78, "details": [ { "name": "Bills", "amount": 3479.78 } ] } ] } ] }, { "supplierId": "8GeHBdBZiZ", "supplierName": "DuBuque, Goyette and Franecki", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -16511.91, "details": [ { "name": "BillCreditNotes", "amount": -16511.91 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "XOPP3v2lQu", "supplierName": "Fisher and Sons", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 238599.9, "details": [ { "name": "Bills", "amount": 238599.9 } ] } ] } ] }, { "supplierId": "0a7b0432-7de3-4e29-bf15-4e7ca0722384", "supplierName": "Flatley - Kirlin", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -113.59, "details": [ { "name": "BillCreditNotes", "amount": -113.59 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 910.45, "details": [ { "name": "Bills", "amount": 910.45 } ] } ] } ] }, { "supplierId": "HrGZeW4I51", "supplierName": "Frami, Simonis and Krajcik", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -2070.59, "details": [ { "name": "BillCreditNotes", "amount": -2070.59 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "SFmBGSHLQ3", "supplierName": "Gottlieb LLC", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -105.07, "details": [ { "name": "BillCreditNotes", "amount": -105.07 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "unNIu8Uyap", "supplierName": "Hahn and Sons", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -297.78, "details": [ { "name": "BillCreditNotes", "amount": -297.78 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2095.75, "details": [ { "name": "Bills", "amount": 2095.75 } ] } ] } ] }, { "supplierId": "GTGS3Sx241", "supplierName": "Harvey Predovic", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3612.41, "details": [ { "name": "Bills", "amount": 3612.41 } ] } ] } ] }, { "supplierId": "w07H3CBm5P", "supplierName": "Hayes, Predovic and Ruecker", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -11662.51, "details": [ { "name": "BillCreditNotes", "amount": -11662.51 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 393776.18, "details": [ { "name": "Bills", "amount": 393776.18 } ] } ] } ] }, { "supplierId": "92144542-2227-409e-8f5b-fc73260e670b", "supplierName": "Hettinger, Schmitt and Will", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 3433.54, "details": [ { "name": "Bills", "amount": 3433.54 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "supplierId": "rpLhEYz0ML", "supplierName": "Hickle - Buckridge", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -7484.88, "details": [ { "name": "BillCreditNotes", "amount": -7484.88 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "d2056eb9-649e-4808-8f96-d8ea4dac71fe", "supplierName": "Hodkiewicz Group", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -6627.16, "details": [ { "name": "BillCreditNotes", "amount": -6627.16 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 18266.27, "details": [ { "name": "Bills", "amount": 18266.27 } ] } ] } ] }, { "supplierId": "s3WcvMyVdR", "supplierName": "Howe - Ruecker", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4042.16, "details": [ { "name": "Bills", "amount": 4042.16 } ] } ] } ] }, { "supplierId": "b60XbI9zhE", "supplierName": "Jenkins Inc", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -12938.29, "details": [ { "name": "BillCreditNotes", "amount": -12938.29 }, { "name": "Bills", "amount": 0 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 18360.8, "details": [ { "name": "Bills", "amount": 18360.8 } ] } ] } ] }, { "supplierId": "OtXKRTOcQc", "supplierName": "Jensen Steuber", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 190.16, "details": [ { "name": "Bills", "amount": 190.16 } ] } ] } ] }, { "supplierId": "c02bc2f1-631d-4721-aec1-a190d63e8322", "supplierName": "Jones - Zulauf", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -69.05, "details": [ { "name": "BillCreditNotes", "amount": -69.05 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 51357.36, "details": [ { "name": "Bills", "amount": 51357.36 } ] } ] } ] }, { "supplierId": "c02382bd-ff23-4b34-bfd7-8dce15fa7d6a", "supplierName": "Keara Leffler", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -2496.69, "details": [ { "name": "BillCreditNotes", "amount": -2496.69 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1519.74, "details": [ { "name": "Bills", "amount": 1519.74 } ] } ] } ] }, { "supplierId": "d3tf43eghS", "supplierName": "Klocko - Keebler", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 12367.4, "details": [ { "name": "Bills", "amount": 12367.4 } ] } ] } ] }, { "supplierId": "7GObELDcsE", "supplierName": "Lakin, Schmeler and Kihn", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -318.71, "details": [ { "name": "BillCreditNotes", "amount": -318.71 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "gO8p5O3Mvy", "supplierName": "Lehner Group", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1042.8, "details": [ { "name": "BillCreditNotes", "amount": -1042.8 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "62229022-713f-4c64-84f2-63cf6dd11443", "supplierName": "Littel - Cole", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -7.5, "details": [ { "name": "BillCreditNotes", "amount": -7.5 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "39b32019-c5d0-4db3-ae83-f0a644e614ef", "supplierName": "Marvin - Schaden", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1611.56, "details": [ { "name": "BillCreditNotes", "amount": -1611.56 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "8635b986-048f-424c-985d-912576c004d9", "supplierName": "Mills, Bechtelar and Wintheiser", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -604.41, "details": [ { "name": "BillCreditNotes", "amount": -604.41 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "d2fb1aba-79ac-4840-95d5-6c173c9beaad", "supplierName": "Morissette LLC", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -55.93, "details": [ { "name": "BillCreditNotes", "amount": -55.93 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "27dc0345-aae8-4b69-a903-fed6b0a8778b", "supplierName": "Newton Zieme", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1546.46, "details": [ { "name": "Bills", "amount": 1546.46 } ] } ] } ] }, { "supplierId": "0d892acd-4b56-4412-80ee-381b8118637b", "supplierName": "Nicolas - McKenzie", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -186.97, "details": [ { "name": "BillCreditNotes", "amount": -186.97 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 5131.74, "details": [ { "name": "Bills", "amount": 5131.74 } ] } ] } ] }, { "supplierId": "cc283863-960f-42f8-8e38-1e22235e9cfc", "supplierName": "Nicolas Group", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -6.41, "details": [ { "name": "BillCreditNotes", "amount": -6.41 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "9UvJVVmPHO", "supplierName": "Nienow - Schroeder", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -2822.41, "details": [ { "name": "BillCreditNotes", "amount": -2822.41 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "1346295c-2970-47a7-8a99-1f935567db02", "supplierName": "Polly Crona", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3600.36, "details": [ { "name": "Bills", "amount": 3600.36 } ] } ] } ] }, { "supplierId": "5fcb09bf-ae92-42a1-a69b-57c5f0ebedd9", "supplierName": "Raul Johns", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -2938.85, "details": [ { "name": "Bills", "amount": 0 }, { "name": "BillCreditNotes", "amount": -2938.85 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "supplierId": "4253a13e-638e-4a42-9e61-665a60267a48", "supplierName": "Robel, Ledner and Stroman", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1106.72, "details": [ { "name": "Bills", "amount": 1106.72 } ] } ] } ] }, { "supplierId": "143ed2c5-2623-465e-a015-5ac12df75aa6", "supplierName": "Schulist - Douglas", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -12468.22, "details": [ { "name": "BillCreditNotes", "amount": -12468.22 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 39306.44, "details": [ { "name": "Bills", "amount": 39306.44 } ] } ] } ] }, { "supplierId": "d770b767-489e-455b-9d32-29c37a1b9d07", "supplierName": "Schultz Group", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -517.52, "details": [ { "name": "BillCreditNotes", "amount": -517.52 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "98e93284-fcaa-440c-8f86-f36e5df591da", "supplierName": "Simonis - Ziemann", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -597.01, "details": [ { "name": "BillCreditNotes", "amount": -597.01 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "supplierId": "87e907ed-97f8-4146-b276-fea2a10671bf", "supplierName": "Sporer and Sons", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -62443.6, "details": [ { "name": "BillCreditNotes", "amount": -62443.6 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "97682025-4e50-449f-8510-6d09d1d0f84b", "supplierName": "Sporer LLC", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1104.37, "details": [ { "name": "BillCreditNotes", "amount": -1104.37 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1050.12, "details": [ { "name": "Bills", "amount": 1050.12 } ] } ] } ] }, { "supplierId": "c51351a0-b43f-48c6-8dbb-8417171bda67", "supplierName": "Veum - Schiller", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1966.59, "details": [ { "name": "BillCreditNotes", "amount": -1966.59 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 10234.97, "details": [ { "name": "Bills", "amount": 10234.97 } ] } ] } ] }, { "supplierId": "26f6b56a-4a86-468f-a302-9d60bdc01d91", "supplierName": "Vincenzo Wolff", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -23450.31, "details": [ { "name": "BillCreditNotes", "amount": -23450.31 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "f589fd05-c5f8-4815-b205-0a9f3f0b3b96", "supplierName": "Weber LLC", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -681.79, "details": [ { "name": "BillCreditNotes", "amount": -681.79 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 10221.45, "details": [ { "name": "Bills", "amount": 10221.45 } ] } ] } ] }, { "supplierId": "1cc8b95c-62ec-415a-ab0e-facf7e7218bf", "supplierName": "Welch, Terry and Hermiston", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1219.54, "details": [ { "name": "Bills", "amount": 1219.54 } ] } ] } ] }, { "supplierId": "f6CgWtm1aw", "supplierName": "Wisoky Group", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 272.67, "details": [ { "name": "Bills", "amount": 272.67 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "je5ok1Cam5", "supplierName": "Wunsch, Kerluke and West", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 7238.24, "details": [ { "name": "Bills", "amount": 7238.24 } ] } ] } ] } ] } }, "Dynamics 365 Business Central": { "value": { "generated": "2023-05-02T16:05:21.1349781Z", "reportDate": "2023-05-02T16:05:21.0866594Z", "data": [ { "supplierId": "e89328bd-485a-eb11-89fa-00224800af18", "supplierName": "A QA", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -526.8, "details": [ { "name": "BillCreditNotes", "amount": -526.8 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 120, "details": [ { "name": "Bills", "amount": 120 } ] } ] } ] }, { "supplierId": "be1217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "Fabrikam, Inc.", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -65, "details": [ { "name": "BillCreditNotes", "amount": -65 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -11904.4, "details": [ { "name": "Bills", "amount": 461.6 }, { "name": "BillPayments", "amount": -12366 } ] } ] }, { "currency": "PLN", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -15, "details": [ { "name": "BillPayments", "amount": -15 } ] } ] }, { "currency": "MAD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 5, "details": [ { "name": "Bills", "amount": 5 } ] } ] } ] }, { "supplierId": "c01217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "First Up Consultants", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 12123.81, "details": [ { "name": "Bills", "amount": 12128.81 }, { "name": "BillPayments", "amount": -5 } ] } ] } ] }, { "supplierId": "c21217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "Graphic Design Institute", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 7514.8, "details": [ { "name": "Bills", "amount": 7520.8 }, { "name": "BillPayments", "amount": -6 } ] } ] } ] }, { "supplierId": "4a1b210e-b805-ec11-86bc-0022481a45c2", "supplierName": "Kays Farm", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -121, "details": [ { "name": "BillPayments", "amount": -121 } ] } ] } ] }, { "supplierId": "c61217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "Nod Publishers", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 13156.74, "details": [ { "name": "Bills", "amount": 13156.74 } ] } ] } ] }, { "supplierId": "b864b5ae-4a5a-eb11-89fa-00224800af18", "supplierName": "Test Supplier", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3951, "details": [ { "name": "Bills", "amount": 3951 } ] } ] }, { "currency": "MAD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 121.45, "details": [ { "name": "Bills", "amount": 121.45 } ] } ] } ] }, { "supplierId": "8b4c95b4-b705-ec11-86bc-0022481a45c2", "supplierName": "Vegan Farm", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -5.27, "details": [ { "name": "Bills", "amount": 0 }, { "name": "BillPayments", "amount": -5.27 } ] } ] }, { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -11.75, "details": [ { "name": "BillPayments", "amount": -11.75 } ] } ] } ] }, { "supplierId": "c41217b3-89d1-ea11-bbaa-000d3a2b9185", "supplierName": "Wide World Importers", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 15843.22, "details": [ { "name": "Bills", "amount": 15848.22 }, { "name": "BillPayments", "amount": -5 } ] } ] } ] } ] } }, "Exact (Netherlands)": { "value": { "generated": "2023-05-02T16:05:19.8312183Z", "reportDate": "2023-05-02T16:05:19.7538301Z", "data": [ { "supplierId": "3150917c-1d92-4d77-9018-31b5c4758ca9", "supplierName": "Abe", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -38.28, "details": [ { "name": "BillCreditNotes", "amount": -38.28 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1952.27, "details": [ { "name": "Bills", "amount": 1941.58 }, { "name": "BillPayments", "amount": 10.69 } ] } ] }, { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 10, "details": [ { "name": "Bills", "amount": 10 } ] } ] } ] }, { "supplierId": "5811b467-53eb-4491-8ca1-bc9b7889811b", "supplierName": "Ann's test supplier 2", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -10000, "details": [ { "name": "BillCreditNotes", "amount": -10000 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] }, { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 117, "details": [ { "name": "Bills", "amount": 117 } ] } ] }, { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4997.25, "details": [ { "name": "Bills", "amount": 4997.25 } ] } ] } ] }, { "supplierId": "78afea22-ee21-48c3-84d5-45b9b24768e9", "supplierName": "Ann's test supplier 2", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 110, "details": [ { "name": "Bills", "amount": 108 }, { "name": "BillPayments", "amount": 2 } ] } ] } ] }, { "supplierId": "773416a6-b196-487b-ae02-eeb273a86bcd", "supplierName": "Belastingdienst", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -293.14, "details": [ { "name": "BillCreditNotes", "amount": -293.14 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1547.08, "details": [ { "name": "Bills", "amount": 1547.08 } ] } ] }, { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 32.17, "details": [ { "name": "Bills", "amount": 32.17 } ] } ] } ] }, { "supplierId": "7017da1f-2d49-4601-abf3-c4e779459976", "supplierName": "Bool Test", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 121, "details": [ { "name": "Bills", "amount": 121 } ] } ] } ] }, { "supplierId": "f87070e2-bbd7-4383-a7c9-824748c1d70e", "supplierName": "Exact Software Nederland B.V.", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -65.73, "details": [ { "name": "BillCreditNotes", "amount": -65.73 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -83351.62, "details": [ { "name": "BillPayments", "amount": -83381.63 }, { "name": "Bills", "amount": 30.01 } ] } ] }, { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -8285.73, "details": [ { "name": "BillPayments", "amount": -8285.73 } ] } ] } ] }, { "supplierId": "8cb6745b-4769-4c7a-9d92-bc688c60ca3c", "supplierName": "iZettle AB (Supplier)", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 19.93, "details": [ { "name": "Bills", "amount": 19.93 } ] } ] } ] }, { "supplierId": "63fadca8-4905-475a-b32a-b4341293bcf4", "supplierName": "Kelly's Industrial Supplies", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 5, "details": [ { "name": "BillPayments", "amount": 5 } ] } ] } ] }, { "supplierId": "acde3236-898e-4e68-b076-4e946defbc5f", "supplierName": "Matt Ager Test Supplier 1", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -276, "details": [ { "name": "BillCreditNotes", "amount": -276 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 75, "details": [ { "name": "Bills", "amount": 105 }, { "name": "BillPayments", "amount": -30 } ] } ] }, { "currency": "RUB", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -10, "details": [ { "name": "BillPayments", "amount": -10 } ] } ] } ] }, { "supplierId": "5e6f49b9-6489-4b82-83e7-291d308919bb", "supplierName": "Mickey Mouse", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -12.1, "details": [ { "name": "BillCreditNotes", "amount": -12.1 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 119.97, "details": [ { "name": "Bills", "amount": 119.97 } ] } ] }, { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -7040, "details": [ { "name": "BillCreditNotes", "amount": -7040 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 8800, "details": [ { "name": "Bills", "amount": 8800 } ] } ] } ] }, { "supplierId": "fc189bfa-f083-438c-bf09-379a0631d4a1", "supplierName": "Mickey Mouse", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -0.83, "details": [ { "name": "Bills", "amount": -0.83 } ] } ] } ] }, { "supplierId": "1d2c9f47-a2fc-48e6-a967-71583d764b10", "supplierName": "NLSuppliers07", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 25, "details": [ { "name": "Bills", "amount": 25 } ] } ] } ] }, { "supplierId": "a1e88d58-caec-4ed6-ad1b-646ebb959c17", "supplierName": "supplierrrr", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -55, "details": [ { "name": "BillCreditNotes", "amount": -55 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 11084, "details": [ { "name": "Bills", "amount": 11084 } ] } ] } ] }, { "supplierId": "cdcdce7b-0330-49fb-8169-0a50e0b74dcc", "supplierName": "Test NL sup1", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 13.21, "details": [ { "name": "BillPayments", "amount": 13.21 } ] } ] } ] }, { "supplierId": "bad8020a-267f-41fb-9e0f-e93465ee9529", "supplierName": "Test supplier", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 718.22, "details": [ { "name": "Bills", "amount": 718.22 } ] } ] } ] }, { "supplierId": "26bc5305-8613-43e4-ab97-522ade34cbba", "supplierName": "Vandana's Test Supplier", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 403.74, "details": [ { "name": "Bills", "amount": 403.74 } ] } ] } ] } ] } }, "Exact (UK)": { "value": { "generated": "2023-05-02T16:05:22.8960035Z", "reportDate": "2023-05-02T16:05:22.8283897Z", "data": [ { "supplierId": "0185fea2-0298-445b-909a-0db685118a9e", "supplierName": "a", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -10, "details": [ { "name": "BillCreditNotes", "amount": -10 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 560.1, "details": [ { "name": "Bills", "amount": 660.1 }, { "name": "BillPayments", "amount": -100 } ] } ] } ] }, { "supplierId": "64ae712f-4155-48bb-9fce-98232c51d979", "supplierName": "aa", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -400, "details": [ { "name": "BillCreditNotes", "amount": -400 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 30, "details": [ { "name": "Bills", "amount": 430 }, { "name": "BillPayments", "amount": -400 } ] } ] } ] }, { "supplierId": "5f20075a-a28e-434d-81a6-2db0dc170e87", "supplierName": "Abdi 99", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -65, "details": [ { "name": "BillCreditNotes", "amount": -65 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 609, "details": [ { "name": "Bills", "amount": 258 }, { "name": "BillPayments", "amount": 351 } ] } ] } ] }, { "supplierId": "0d3f8692-4b0a-4bc3-85f2-4cb763306397", "supplierName": "Ann's test supplier", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -3600, "details": [ { "name": "BillCreditNotes", "amount": -3600 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2400, "details": [ { "name": "Bills", "amount": 2400 } ] } ] } ] }, { "supplierId": "fc62db43-a6f8-4b65-9d29-15290ec56674", "supplierName": "Anna's test supplier", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1717.5, "details": [ { "name": "BillCreditNotes", "amount": -1717.5 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2751, "details": [ { "name": "Bills", "amount": 2751 } ] } ] } ] }, { "supplierId": "cde51f36-2a06-4eac-9784-c0c967c1e1ed", "supplierName": "b", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -6, "details": [ { "name": "BillCreditNotes", "amount": -6 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "supplierId": "437c6631-3c5d-4351-b757-6ad4f94bd26e", "supplierName": "bb", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 220, "details": [ { "name": "Bills", "amount": 220 } ] } ] } ] }, { "supplierId": "fe713acb-3c98-423d-8372-68a32aae6232", "supplierName": "cc", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -60, "details": [ { "name": "BillPayments", "amount": -60 } ] } ] } ] }, { "supplierId": "1c703cce-967c-4476-a86a-32e35341a8f5", "supplierName": "Customer Bill Supplier", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -100073.4, "details": [ { "name": "BillCreditNotes", "amount": -100073.4 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 374.8, "details": [ { "name": "Bills", "amount": 373.8 }, { "name": "BillPayments", "amount": 1 } ] } ] } ] }, { "supplierId": "6a4c6a14-d5eb-4427-aae0-c544f67dff7a", "supplierName": "CustomerAndSupplier", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2.05, "details": [ { "name": "BillPayments", "amount": 2.05 } ] } ] } ] }, { "supplierId": "efb5d438-7d3a-4b77-a254-2d90f76d3f22", "supplierName": "dd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 200, "details": [ { "name": "Bills", "amount": 200 } ] } ] } ] }, { "supplierId": "77b652bb-a363-4425-adbd-0206e2ce4639", "supplierName": "e", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -72.33, "details": [ { "name": "BillCreditNotes", "amount": -72.33 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "supplierId": "a4d5d739-c979-4819-b0ce-666db1ec3a7d", "supplierName": "Exact Software (UK) Ltd � Exact Online", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 133.6, "details": [ { "name": "Bills", "amount": 133.6 } ] } ] } ] }, { "supplierId": "7c8a9143-7322-48e3-b809-88a038b8a0e0", "supplierName": "John Doe", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 192.5, "details": [ { "name": "Bills", "amount": 192.5 } ] } ] } ] }, { "supplierId": "a7cad20d-44db-442b-ac1f-90475802d6fb", "supplierName": "Pencils Pencils Pencils", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1200, "details": [ { "name": "BillCreditNotes", "amount": -1200 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3837, "details": [ { "name": "Bills", "amount": 3837 } ] } ] } ] }, { "supplierId": "41302634-76b5-4442-b800-0bb63780e77c", "supplierName": "Some Supplier", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -46.8, "details": [ { "name": "BillCreditNotes", "amount": -46.8 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -54537.12, "details": [ { "name": "Bills", "amount": 455.73 }, { "name": "BillPayments", "amount": -54992.85 } ] } ] } ] } ] } }, "FreeAgent": { "value": { "generated": "2023-05-02T16:05:23.3560058Z", "reportDate": "2023-05-02T16:05:23.3059155Z", "data": [ { "supplierId": "10123537", "supplierName": "_Test 1", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "BillPayments", "amount": 0 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 791, "details": [ { "name": "Bills", "amount": 791 } ] } ] }, { "currency": "QAR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 12, "details": [ { "name": "Bills", "amount": 12 } ] } ] } ] }, { "supplierId": "11526230", "supplierName": "-", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -6430, "details": [ { "name": "Bills", "amount": 1500 }, { "name": "BillCreditNotes", "amount": -7930 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1200, "details": [ { "name": "Bills", "amount": 1200 } ] } ] } ] }, { "supplierId": "9677150", "supplierName": "-", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 5, "details": [ { "name": "Bills", "amount": 5 } ] } ] } ] }, { "supplierId": "8959011", "supplierName": "1", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -134.3, "details": [ { "name": "BillCreditNotes", "amount": -134.3 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 46, "details": [ { "name": "Bills", "amount": 46 } ] } ] } ] }, { "supplierId": "6161941", "supplierName": "A & J Fabtech Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -2433.99, "details": [ { "name": "BillCreditNotes", "amount": -2433.99 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3431, "details": [ { "name": "Bills", "amount": 3431 } ] } ] }, { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 400, "details": [ { "name": "Bills", "amount": 400 } ] } ] } ] }, { "supplierId": "6161963", "supplierName": "ABB Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -10, "details": [ { "name": "BillCreditNotes", "amount": -10 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "Bills", "amount": 0 } ] } ] } ] }, { "supplierId": "9356878", "supplierName": "Abdul Al-haj", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 12, "details": [ { "name": "Bills", "amount": 12 } ] } ] } ] }, { "supplierId": "8984892", "supplierName": "Abraham's Spider Hunting Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 77, "details": [ { "name": "Bills", "amount": 77 } ] } ] } ] }, { "supplierId": "9273150", "supplierName": "Best Company", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -456, "details": [ { "name": "BillCreditNotes", "amount": -456 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "supplierId": "6161956", "supplierName": "C Allen", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -100, "details": [ { "name": "BillCreditNotes", "amount": -100 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 122, "details": [ { "name": "Bills", "amount": 122 } ] } ] } ] }, { "supplierId": "7994567", "supplierName": "codat", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 10, "details": [ { "name": "Bills", "amount": 10 } ] } ] } ] }, { "supplierId": "5730310", "supplierName": "Demo Customer", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 200, "details": [ { "name": "Bills", "amount": 200 } ] } ] } ] }, { "supplierId": "6162169", "supplierName": "PricewaterhouseCoopers LLP", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 42, "details": [ { "name": "Bills", "amount": 42 } ] } ] } ] }, { "supplierId": "10672202", "supplierName": "Random Org", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -42, "details": [ { "name": "BillCreditNotes", "amount": -42 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 130, "details": [ { "name": "Bills", "amount": 130 } ] } ] } ] }, { "supplierId": "8989342", "supplierName": "Supplier Hidden", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -500, "details": [ { "name": "BillCreditNotes", "amount": -500 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] }, { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -150, "details": [ { "name": "BillPayments", "amount": -150 } ] } ] } ] }, { "supplierId": "7169654", "supplierName": "The Eagle", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -492, "details": [ { "name": "BillCreditNotes", "amount": -492 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3523.75, "details": [ { "name": "Bills", "amount": 3523.75 } ] } ] }, { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 301, "details": [ { "name": "Bills", "amount": 301 } ] } ] } ] } ] } }, "MYOB AccountRight and Essentials": { "value": { "generated": "2023-05-02T16:05:21.5229720Z", "reportDate": "2023-05-02T16:05:21.2821865Z", "data": [] } }, "Oracle NetSuite": { "value": { "generated": "2023-05-02T16:05:20.3296968Z", "reportDate": "2023-05-02T16:05:20.2442587Z", "data": [ { "supplierId": "779", "supplierName": "Test Vendor", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 56, "details": [ { "name": "Bills", "amount": 56 } ] } ] } ] }, { "supplierId": "724", "supplierName": "Vendor A.A.A", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 579.55, "details": [ { "name": "Bills", "amount": 524 }, { "name": "BillPayments", "amount": 55.55 } ] } ] } ] } ] } }, "QuickBooks Desktop": { "value": { "generated": "2023-05-02T16:05:20.3972104Z", "reportDate": "2023-05-02T16:05:20.3178060Z", "data": [ { "supplierId": "B0000-933272656", "supplierName": "Patton Hardware Supplies", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [ { "name": "BillPayments", "amount": 0 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 5000, "details": [ { "name": "Bills", "amount": 5000 } ] } ] } ] } ] } }, "QuickBooks Online": { "value": { "generated": "2023-05-02T16:05:21.3065432Z", "reportDate": "2023-05-02T16:05:21.2488309Z", "data": [ { "supplierId": "129", "supplierName": "Ally Johnson", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 230.98, "details": [ { "name": "Bills", "amount": 276.38 }, { "name": "BillPayments", "amount": -45.4 } ] } ] } ] }, { "supplierId": "88", "supplierName": "Andrew Haberbosch", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -16, "details": [ { "name": "BillCreditNotes", "amount": -16 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 66.25, "details": [ { "name": "BillPayments", "amount": -13.75 }, { "name": "Bills", "amount": 80 } ] } ] } ] }, { "supplierId": "53", "supplierName": "Bank of AnyCity", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 63, "details": [ { "name": "Bills", "amount": 63 } ] } ] } ] }, { "supplierId": "282", "supplierName": "Becky's Bakery", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 490.5, "details": [ { "name": "BillPayments", "amount": -9.5 }, { "name": "Bills", "amount": 500 } ] } ] } ] }, { "supplierId": "24", "supplierName": "Brijesh Jain", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -69, "details": [ { "name": "BillCreditNotes", "amount": -69 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 52260, "details": [ { "name": "Bills", "amount": 52260 } ] } ] } ] }, { "supplierId": "25", "supplierName": "Brittney Hughes", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 70, "details": [ { "name": "Bills", "amount": 70 } ] } ] } ] }, { "supplierId": "26", "supplierName": "Burc Gunes", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 33.05, "details": [ { "name": "Bills", "amount": 33.05 } ] } ] } ] }, { "supplierId": "27", "supplierName": "Cass Hayden", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1450, "details": [ { "name": "Bills", "amount": 1500 }, { "name": "BillPayments", "amount": -50 } ] } ] } ] }, { "supplierId": "51", "supplierName": "City Water Co", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 7.25, "details": [ { "name": "Bills", "amount": 24 }, { "name": "BillPayments", "amount": -16.75 } ] } ] } ] }, { "supplierId": "297", "supplierName": "Codat Supplier", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -128, "details": [ { "name": "Bills", "amount": 0 }, { "name": "BillPayments", "amount": -25 }, { "name": "BillCreditNotes", "amount": -103 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -328.32, "details": [ { "name": "Bills", "amount": 0 }, { "name": "BillPayments", "amount": -328.32 } ] } ] } ] }, { "supplierId": "87", "supplierName": "Costco", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -17.85, "details": [ { "name": "BillPayments", "amount": -17.85 } ] } ] } ] }, { "supplierId": "57", "supplierName": "Hall's Promo Items", "agedCurrencyOutstanding": [ { "currency": "HKD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1041.09, "details": [ { "name": "Bills", "amount": 1041.09 } ] } ] } ] }, { "supplierId": "92", "supplierName": "Huw Thomas", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 25292, "details": [ { "name": "Bills", "amount": 25302 }, { "name": "BillPayments", "amount": -10 } ] } ] } ] }, { "supplierId": "85", "supplierName": "Jay's Farm", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -446.83, "details": [ { "name": "BillCreditNotes", "amount": -446.83 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 9759.68, "details": [ { "name": "Bills", "amount": 9822.46 }, { "name": "BillPayments", "amount": -62.78 } ] } ] } ] }, { "supplierId": "34", "supplierName": "Jennifer Hargreaves", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 239.01, "details": [ { "name": "Bills", "amount": 239.01 } ] } ] } ] }, { "supplierId": "37", "supplierName": "Kristina Gibson", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1710, "details": [ { "name": "BillCreditNotes", "amount": -1710 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 502.38, "details": [ { "name": "Bills", "amount": 502.38 } ] } ] } ] }, { "supplierId": "41", "supplierName": "Mark Howard", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 3000, "details": [ { "name": "Bills", "amount": 3000 } ] } ] } ] }, { "supplierId": "23", "supplierName": "Mr Andrew Thomas Haberbosch", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -21.2, "details": [ { "name": "BillCreditNotes", "amount": -21.2 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 54.09, "details": [ { "name": "Bills", "amount": 54.09 } ] } ] } ] }, { "supplierId": "54", "supplierName": "Organization of Outstanding Event Planners", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 390, "details": [ { "name": "Bills", "amount": 390 } ] } ] } ] }, { "supplierId": "47", "supplierName": "Sanjeev Kak", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 21, "details": [ { "name": "Bills", "amount": 21 } ] } ] } ] }, { "supplierId": "74", "supplierName": "TestPushCustomer3", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 200, "details": [ { "name": "Bills", "amount": 200 } ] } ] } ] }, { "supplierId": "86", "supplierName": "Vegan Farm", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -42.76, "details": [ { "name": "BillCreditNotes", "amount": -42.76 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1249.3, "details": [ { "name": "BillPayments", "amount": -504.24 }, { "name": "Bills", "amount": 1753.54 } ] } ] } ] }, { "supplierId": "58", "supplierName": "Venue Rental", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 461, "details": [ { "name": "Bills", "amount": 500 }, { "name": "BillPayments", "amount": -39 } ] } ] } ] } ] } }, "Sage 200cloud": { "value": { "generated": "2023-05-02T16:05:20.7939148Z", "reportDate": "2023-05-02T16:05:20.7474542Z", "data": [ { "supplierId": "CON002", "supplierName": "Concept Stationery Sub A", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 411.76, "details": [ { "name": "Bills", "amount": 782.56 }, { "name": "BillPayments", "amount": -370.8 } ] } ] } ] }, { "supplierId": "CON001", "supplierName": "Concept Stationery Supplies", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -167.1, "details": [ { "name": "BillCreditNotes", "amount": -167.1 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 5062.78, "details": [ { "name": "Bills", "amount": 5111.01 }, { "name": "BillPayments", "amount": -48.23 } ] } ] } ] }, { "supplierId": "MCN001", "supplierName": "McNally Computer Supplies", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 25802.03, "details": [ { "name": "Bills", "amount": 25934.03 }, { "name": "BillPayments", "amount": -132 } ] } ] } ] }, { "supplierId": "MEA001", "supplierName": "Mears Insurance", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -48, "details": [ { "name": "BillCreditNotes", "amount": -48 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1368.02, "details": [ { "name": "Bills", "amount": 1524 }, { "name": "BillPayments", "amount": -155.98 } ] } ] } ] }, { "supplierId": "NEW001", "supplierName": "Newtown Builders Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -13.21, "details": [ { "name": "BillCreditNotes", "amount": -13.21 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1024.13, "details": [ { "name": "Bills", "amount": 1041.61 }, { "name": "BillPayments", "amount": -17.48 } ] } ] } ] }, { "supplierId": "QUA001", "supplierName": "Quality Motors", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -105.64, "details": [ { "name": "BillCreditNotes", "amount": -105.64 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 155.92, "details": [ { "name": "Bills", "amount": 155.92 } ] } ] } ] }, { "supplierId": "RSP002", "supplierName": "Richard Sanderson-Pope", "agedCurrencyOutstanding": [ { "currency": "JPY", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 60000, "details": [ { "name": "Bills", "amount": 60000 } ] } ] } ] }, { "supplierId": "SDE001", "supplierName": "S D Enterprises", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1130.29, "details": [ { "name": "Bills", "amount": 1189.29 }, { "name": "BillPayments", "amount": -59 } ] } ] } ] }, { "supplierId": "STU001", "supplierName": "Studio Designs", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 562.06, "details": [ { "name": "Bills", "amount": 562.06 } ] } ] } ] }, { "supplierId": "SUP002", "supplierName": "Superclean", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 2055.3, "details": [ { "name": "Bills", "amount": 2055.3 } ] } ] } ] }, { "supplierId": "SUP001", "supplierName": "Superior Technologies Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 9433.71, "details": [ { "name": "Bills", "amount": 9433.71 } ] } ] } ] }, { "supplierId": "THO001", "supplierName": "Thompsons Electricals", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -135.13, "details": [ { "name": "BillCreditNotes", "amount": -135.13 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 576.04, "details": [ { "name": "Bills", "amount": 1091.04 }, { "name": "BillPayments", "amount": -515 } ] } ] } ] }, { "supplierId": "UNI001", "supplierName": "Unique Systems", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -103.4, "details": [ { "name": "BillCreditNotes", "amount": -103.4 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1104.16, "details": [ { "name": "Bills", "amount": 1104.16 } ] } ] } ] }, { "supplierId": "WAL001", "supplierName": "Wallace Office Equipment", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -70.76, "details": [ { "name": "BillCreditNotes", "amount": -70.76 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -55.52, "details": [ { "name": "Bills", "amount": 94.48 }, { "name": "BillPayments", "amount": -150 } ] } ] } ] }, { "supplierId": "WIS001", "supplierName": "Wise Electricals Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -35.01, "details": [ { "name": "BillCreditNotes", "amount": -35.01 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -221.75, "details": [ { "name": "Bills", "amount": -121.75 }, { "name": "BillPayments", "amount": -100 } ] } ] } ] }, { "supplierId": "WIS002", "supplierName": "Wiseman Paper Products", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 5868.13, "details": [ { "name": "Bills", "amount": 5868.13 } ] } ] } ] } ] } }, "Sage 50 (UK)": { "value": { "generated": "2023-05-02T16:05:20.0257207Z", "reportDate": "2023-05-02T16:05:19.9751677Z", "data": [ { "supplierId": "CON001", "supplierName": "Concept Stationery Supplies", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1644.39, "details": [ { "name": "Bills", "amount": 1644.39 } ] } ] } ] }, { "supplierId": "MCN001", "supplierName": "McNally Computer Supplies", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 24734.12, "details": [ { "name": "Bills", "amount": 24734.12 } ] } ] } ] }, { "supplierId": "NEW001", "supplierName": "Newtown Builders Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -0.01, "details": [ { "name": "BillCreditNotes", "amount": -0.01 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0.01, "details": [ { "name": "Bills", "amount": 0.01 } ] } ] } ] }, { "supplierId": "QUA001", "supplierName": "Quality Motors", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -42.63, "details": [ { "name": "BillCreditNotes", "amount": -42.63 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 72.85, "details": [ { "name": "Bills", "amount": 72.85 } ] } ] } ] }, { "supplierId": "SDE001", "supplierName": "S D Enterprises", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 352.5, "details": [ { "name": "Bills", "amount": 352.5 } ] } ] } ] }, { "supplierId": "SUP002", "supplierName": "Superclean", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1762.5, "details": [ { "name": "Bills", "amount": 1762.5 } ] } ] } ] }, { "supplierId": "SUP001", "supplierName": "Superior Technologies Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 9164.95, "details": [ { "name": "Bills", "amount": 9164.95 } ] } ] } ] }, { "supplierId": "THO001", "supplierName": "Thompsons Electricals", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -135.13, "details": [ { "name": "BillCreditNotes", "amount": -135.13 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 472.24, "details": [ { "name": "Bills", "amount": 972.24 }, { "name": "BillPayments", "amount": -500 } ] } ] } ] }, { "supplierId": "UNI001", "supplierName": "Unique Systems", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -103.4, "details": [ { "name": "BillCreditNotes", "amount": -103.4 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 744.16, "details": [ { "name": "Bills", "amount": 744.16 } ] } ] } ] }, { "supplierId": "WAL001", "supplierName": "Wallace Office Equipment", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -58.76, "details": [ { "name": "BillCreditNotes", "amount": -58.76 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -55.52, "details": [ { "name": "Bills", "amount": 94.48 }, { "name": "BillPayments", "amount": -150 } ] } ] } ] }, { "supplierId": "WIS001", "supplierName": "Wise Electricals Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -35.01, "details": [ { "name": "BillCreditNotes", "amount": -35.01 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 117.29, "details": [ { "name": "Bills", "amount": 117.29 } ] } ] } ] }, { "supplierId": "WIS002", "supplierName": "Wiseman Paper Products", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 5868.13, "details": [ { "name": "Bills", "amount": 5868.13 } ] } ] } ] } ] } }, "Sage Business Cloud Accounting": { "value": { "generated": "2023-05-02T16:05:21.3095542Z", "reportDate": "2023-05-02T16:05:21.1514485Z", "data": [ { "supplierId": "65179671e9ef424caff8b9006cd111c8", "supplierName": "5555 Abdul's Test Name", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -60, "details": [ { "name": "BillCreditNotes", "amount": -60 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1548.84, "details": [ { "name": "Bills", "amount": 1608.84 }, { "name": "BillPayments", "amount": -60 } ] } ] } ] }, { "supplierId": "cf7f44d693904944a6a7cf3de0887964", "supplierName": "Abdi Supplier", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -841570.32, "details": [ { "name": "BillCreditNotes", "amount": -841570.32 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 661901.14, "details": [ { "name": "Bills", "amount": 662062.14 }, { "name": "BillPayments", "amount": -161 } ] } ] } ] }, { "supplierId": "f82f0f59fbf44416b833562783388ee9", "supplierName": "Abe's Spider Hunting Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -38.8, "details": [ { "name": "Bills", "amount": 1.2 }, { "name": "BillPayments", "amount": -40 } ] } ] } ] }, { "supplierId": "ec716559789111e8aaa5027d54329956", "supplierName": "Bagels Limited", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -140.97, "details": [ { "name": "BillCreditNotes", "amount": -140.97 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1856307.16, "details": [ { "name": "BillPayments", "amount": -213 }, { "name": "Bills", "amount": 1856520.16 } ] } ] } ] }, { "supplierId": "b1354c4ae5db4d069acbcf49bee62215", "supplierName": "Boyer Inc", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 360000, "details": [ { "name": "Bills", "amount": 360000 } ] } ] } ] }, { "supplierId": "46b3d6acedcb4738a9646dc512562cda", "supplierName": "callum", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1.2, "details": [ { "name": "Bills", "amount": 1.2 } ] } ] } ] }, { "supplierId": "7e7450fadbb94d09abdaf609a51d05eb", "supplierName": "Debs UK Supplier", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -36, "details": [ { "name": "BillCreditNotes", "amount": -36 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1814652, "details": [ { "name": "Bills", "amount": 1814652 } ] } ] } ] }, { "supplierId": "bf6fc20701264c899a1ba96365aa9d70", "supplierName": "Eliana's", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -105.6, "details": [ { "name": "BillCreditNotes", "amount": -105.6 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 26.4, "details": [ { "name": "Bills", "amount": 26.4 } ] } ] } ] }, { "supplierId": "30862a4b2c084a4fa2e640f9ef371e4c", "supplierName": "Flour Inc", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 60, "details": [ { "name": "Bills", "amount": 60 } ] } ] } ] }, { "supplierId": "390ca10633cb4bf989961491e834b47a", "supplierName": "Jo Cheese", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 9, "details": [ { "name": "Bills", "amount": 9 } ] } ] } ] }, { "supplierId": "b10be78d0e9340a79743c538a0b481d0", "supplierName": "M7 Smith", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 65150090, "details": [ { "name": "Bills", "amount": 65150090 } ] } ] } ] }, { "supplierId": "693d3b961e744b02a6a260f4bada75b0", "supplierName": "Matt Ager Test EU Supplier", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -6841.33, "details": [ { "name": "BillCreditNotes", "amount": -6841.33 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 6841.33, "details": [ { "name": "Bills", "amount": 6841.33 } ] } ] } ] }, { "supplierId": "1edf56c368e14a35a050b3e8336e2272", "supplierName": "Mike B Commerce Test", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 300, "details": [ { "name": "Bills", "amount": 300 } ] } ] } ] }, { "supplierId": "c6d3fa5bf2634b148d0ee82b6fbb8fe3", "supplierName": "my shop supplier", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -120, "details": [ { "name": "BillCreditNotes", "amount": -120 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "supplierId": "cdeae2fcbe6447f698d2a59d68e4ad82", "supplierName": "Nic Supp", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -36, "details": [ { "name": "BillCreditNotes", "amount": -36 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 0, "details": [] } ] } ] }, { "supplierId": "2e14c8cfee3041a4a5e8a619b336f900", "supplierName": "Nic Supplies Ltd", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 30, "details": [ { "name": "Bills", "amount": 30 } ] } ] } ] }, { "supplierId": "c41981674176495f927f46ce663d46ac", "supplierName": "Ninetta Ponting", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -306, "details": [ { "name": "BillPayments", "amount": -306 } ] } ] } ] }, { "supplierId": "e2dd680fed99410982673f8fc2722357", "supplierName": "Supplier 70", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -70, "details": [ { "name": "BillPayments", "amount": -70 } ] } ] } ] }, { "supplierId": "8d61f7cd3a2f4ceea26ac5bca15e10da", "supplierName": "Supplier 71 (AUD)", "agedCurrencyOutstanding": [ { "currency": "AUD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": -701, "details": [ { "name": "BillPayments", "amount": -701 } ] } ] } ] }, { "supplierId": "7a67caeb261f40259f0948785090af0b", "supplierName": "supplier test", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 12014.4, "details": [ { "name": "Bills", "amount": 12014.4 } ] } ] } ] }, { "supplierId": "d884f637bb3a4e589d640085b31ad6ee", "supplierName": "Tasty Treats Icecreams", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -454, "details": [ { "name": "BillCreditNotes", "amount": -454 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 456, "details": [ { "name": "Bills", "amount": 456 } ] } ] } ] }, { "supplierId": "ca430e0d156011e8b45c025132dab352", "supplierName": "Test Supplier", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -1152.78, "details": [ { "name": "BillCreditNotes", "amount": -1152.78 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 14960.37, "details": [ { "name": "Bills", "amount": 15064.41 }, { "name": "BillPayments", "amount": -104.04 } ] } ] } ] }, { "supplierId": "2541e491791c485a96cc480cfde112d6", "supplierName": "Test Supplier 2", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -50, "details": [ { "name": "BillCreditNotes", "amount": -50 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 63338524.47, "details": [ { "name": "Bills", "amount": 63338524.47 } ] } ] } ] }, { "supplierId": "877aac191c3c40eda61115eea12641f7", "supplierName": "Test Supplier 3", "agedCurrencyOutstanding": [ { "currency": "EUR", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": -3535.61, "details": [ { "name": "BillCreditNotes", "amount": -3535.61 } ] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 50658.58, "details": [ { "name": "Bills", "amount": 50658.58 } ] } ] } ] }, { "supplierId": "d98e7afb4ca846dfbb12ca285f95f863", "supplierName": "Test Supplier 4 (US)", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 51872949, "details": [ { "name": "Bills", "amount": 51872949 } ] } ] } ] } ] } }, "Sage Intacct": { "value": { "generated": "2023-05-02T16:05:22.9252709Z", "reportDate": "2023-05-02T16:05:22.8758390Z", "data": [ { "supplierId": "3", "supplierName": "ADP", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 487.5, "details": [ { "name": "Bills", "amount": 487.5 } ] } ] } ] }, { "supplierId": "14", "supplierName": "Kristofferson Consulting", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 7200, "details": [ { "name": "Bills", "amount": 7200 } ] } ] } ] }, { "supplierId": "7", "supplierName": "Lenovo", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 190, "details": [ { "name": "Bills", "amount": 190 } ] } ] } ] }, { "supplierId": "8", "supplierName": "Worldwide Commercial", "agedCurrencyOutstanding": [ { "currency": "USD", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 10, "details": [ { "name": "Bills", "amount": 10 } ] } ] } ] } ] } }, "Xero": { "value": { "generated": "2023-05-02T16:05:20.3006654Z", "reportDate": "2023-05-02T16:05:20.2587933Z", "data": [ { "supplierId": "699f0091-b127-4796-9f15-41a2f42abeb2", "supplierName": "ABC Furniture", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1200, "details": [ { "name": "Bills", "amount": 1200 } ] } ] } ] }, { "supplierId": "362819c9-f285-4d09-ac95-26327863adac", "supplierName": "Bayside Club", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 130, "details": [ { "name": "Bills", "amount": 130 } ] } ] } ] }, { "supplierId": "2dc0ef7c-582f-4542-963b-dbdc069e4819", "supplierName": "Bayside Wholesale", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 961.21, "details": [ { "name": "Bills", "amount": 961.21 } ] } ] } ] }, { "supplierId": "51cbbfb0-8dc9-41aa-aad6-eb93b3cc40c6", "supplierName": "Capital Cab Co", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 242, "details": [ { "name": "Bills", "amount": 242 } ] } ] } ] }, { "supplierId": "3828f379-afa5-4b2a-9000-9c53d75ba1c6", "supplierName": "Central Copiers", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 1063.56, "details": [ { "name": "Bills", "amount": 1063.56 } ] } ] } ] }, { "supplierId": "8a593982-291c-4ec3-9a42-3dbccbc6e3c8", "supplierName": "MCO Cleaning Services", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 119.08, "details": [ { "name": "Bills", "amount": 119.08 } ] } ] } ] }, { "supplierId": "97cc88ca-f89b-41f0-b8b9-e750b6f2f1d9", "supplierName": "Net Connect", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 54.13, "details": [ { "name": "Bills", "amount": 54.13 } ] } ] } ] }, { "supplierId": "dec56ceb-65e9-43b3-ac98-7fe09eb37e31", "supplierName": "PowerDirect", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 244.45, "details": [ { "name": "Bills", "amount": 244.45 } ] } ] } ] }, { "supplierId": "f5a77e82-50e3-4340-a6e0-13d6a482a08a", "supplierName": "SMART Agency", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 4500, "details": [ { "name": "Bills", "amount": 4500 } ] } ] } ] }, { "supplierId": "3a0d40a2-2698-4cf5-b7b2-30133c632ab6", "supplierName": "Swanston Security", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 93.64, "details": [ { "name": "Bills", "amount": 93.64 } ] } ] } ] }, { "supplierId": "ac48c67d-3eea-44eb-96b1-9f7a89d9b761", "supplierName": "Xero", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 56.35, "details": [ { "name": "Bills", "amount": 56.35 } ] } ] } ] }, { "supplierId": "94a82e91-53da-4f87-a417-63d6a1607ced", "supplierName": "Young Bros Transport", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2023-04-02T00:00:00.0000000", "toDate": "2023-05-02T00:00:00.0000000", "amount": 0, "details": [] }, { "fromDate": "0001-01-01T00:00:00.0000000", "toDate": "2023-04-02T00:00:00.0000000", "amount": 125.03, "details": [ { "name": "Bills", "amount": 125.03 } ] } ] } ] } ] } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/Payment-Required" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/Not-Found" }, "429": { "$ref": "#/components/responses/Too-Many-Requests" }, "500": { "$ref": "#/components/responses/Internal-Server-Error" }, "503": { "$ref": "#/components/responses/Service-Unavailable" } } } } }, "components": { "schemas": { "Account": { "title": "Accounting: Account", "description": "> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.\n\nView the coverage for accounts in the Data coverage explorer.\n\n## Overview\n\nAccounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.\n\nThe categories for an account include:\n* Asset\n* Expense\n* Income\n* Liability\n* Equity.\n\nThe same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.\n\nAt the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.\n\nTo determine the list of allowed categories for a specific integration, you can:\n- Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/accounting-api#/operations/get-create-chartOfAccounts-model).\n- Refer to the integration's own documentation.\n\n> **Accounts with no category**\n>\n> If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.\n>\n> This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports.", "allOf": [ { "properties": { "id": { "type": "string", "description": "Identifier for the account, unique for the company.", "example": "1b6266d1-1e44-46c5-8eb5-a8f98e03124e" } } }, { "$ref": "#/components/schemas/Account/definitions/accountPrototype" }, { "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "accountPrototype": { "title": "Account prototype", "type": "object", "properties": { "nominalCode": { "type": "string", "nullable": true, "description": "Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system.", "example": "610" }, "name": { "type": "string", "nullable": true, "description": "Name of the account.", "example": "Accounts Receivable" }, "description": { "type": "string", "nullable": true, "description": "Description for the account.", "example": "Invoices the business has issued but has not yet collected payment on." }, "fullyQualifiedCategory": { "type": "string", "nullable": true, "description": "Full category of the account. \r\n\r\nFor example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation.", "example": "Asset.Current" }, "fullyQualifiedName": { "type": "string", "nullable": true, "description": "Full name of the account, for example:\n- `Cash On Hand`\n- `Rents Held In Trust`\n- `Fixed Asset`", "examples": [ "Cash On Hand", "Fixed Asset" ] }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency" }, "currentBalance": { "type": "number", "format": "decimal", "nullable": true, "description": "Current balance in the account.", "example": 0 }, "type": { "$ref": "#/components/schemas/Account/definitions/accountType" }, "status": { "$ref": "#/components/schemas/Account/definitions/accountStatus" }, "isBankAccount": { "type": "boolean", "description": "Confirms whether the account is a bank account or not." }, "validDatatypeLinks": { "type": "array", "nullable": true, "description": "The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/accounting-api#/schemas/ValidDataTypeLinks).", "items": { "$ref": "#/components/schemas/ValidDataTypeLinks" } }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, "accountRef": { "title": "Account reference", "type": "object", "description": "Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.", "properties": { "id": { "type": "string", "description": "'id' from the Accounts data type." }, "name": { "type": "string", "description": "'name' from the Accounts data type." } } }, "accountType": { "title": "Account type", "enum": [ "Unknown", "Asset", "Expense", "Income", "Liability", "Equity" ], "type": "string", "description": "Type of account", "example": "Asset" }, "accountStatus": { "title": "Account status", "enum": [ "Unknown", "Active", "Archived", "Pending" ], "type": "string", "description": "Status of the account", "example": "Active" } }, "type": "object" }, "Accounts": { "title": "Accounting: Accounts", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "AccountTransaction": { "title": "Accounting: Account transaction", "description": "> **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting software. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/banking-api#/operations/list-all-banking-transactions).\n\n> View the coverage for account transactions in the Data coverage explorer.\n\n## Overview\n\nIn Codat’s data model, account transactions represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.\n\nAccount transactions are created as a result of different business activities, for example:\n\n* Payments: for example, receiving money for payment against an invoice.\n* Bill payments: for example, spending money for a payment against a bill.\n* Direct costs: for example, withdrawing money from a bank account, either for cash purposes or to make a payment.\n* Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale.\n* Transfers: for example, transferring money between two bank accounts.\n\nAccount transactions is the parent data type of [payments](https://docs.codat.io/accounting-api#/schemas/Payment), [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer).", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the direct cost (unique to the company)." }, "transactionId": { "type": "string", "nullable": true, "description": "Identifier of the transaction (unique to the company)." }, "note": { "type": "string", "nullable": true, "description": "Additional information about the account transaction, if available." }, "bankAccountRef": { "$ref": "#/components/schemas/BankAccount/definitions/bankAccountRef", "description": "Reference to the bank account the account transaction is recorded against." }, "date": { "$ref": "#/components/schemas/DateTime", "description": "The date the account transaction was recorded in the platform." }, "status": { "enum": [ "Unknown", "Unreconciled", "Reconciled", "Void" ], "type": "string", "description": "The status of the account transaction." }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency" }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "lines": { "type": "array", "nullable": true, "description": "Array of account transaction lines.", "items": { "$ref": "#/components/schemas/AccountTransaction/definitions/accountTransactionLine" } }, "totalAmount": { "type": "number", "format": "decimal", "description": "Total amount of the account transactions, inclusive of tax." }, "metadata": { "$ref": "#/components/schemas/Metadata" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "accountTransactionLine": { "type": "object", "properties": { "description": { "type": "string", "nullable": true, "description": "Description of the account transaction." }, "recordRef": { "$ref": "#/components/schemas/AccountTransaction/definitions/accountTransactionLineRecordRef" }, "amount": { "type": "number", "format": "decimal", "description": "Amount in the bill payment currency." } } }, "accountTransactionLineRecordRef": { "type": "object", "title": "Record reference", "description": "Links an account transaction line to the underlying record that created it.", "properties": { "id": { "type": "string", "description": "'id' of the underlying record or data type." }, "dataType": { "type": "string", "description": "Name of underlying data type.", "enum": [ "bankTransactions", "billCreditNotes", "billPayments", "bills", "creditNotes", "directCosts", "directIncomes", "invoices", "journalEntries", "payments", "transfers" ], "example": "transfers" } } } } }, "AccountTransactions": { "title": "Accounting: Account transactions", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/AccountTransaction" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "AgedCreditorReport": { "title": "Accounting: Aged creditors report", "description": "The Aged Creditors report shows the total balance owed by a business to its suppliers over time.\n\nYou can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal.\n\nTotal assets or liabilities are grouped into 30-day periods for each supplier, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency.\n\n> It is not guaranteed that write-offs are included in the Aged Creditors report.\n\n## Underlying data\n\nThe Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier), [Bills](https://docs.codat.io/accounting-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment).\n\nTo generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again.\n\n> The Aged Creditor report runs based on the **issue dates** of the underlying data types rather than the due date.\n\n## Accessing the Aged Creditors report in Portal\n\nApart from returning the report via the API as JSON and query, you can also return the Aged Creditors report in the Codat portal.\n\n1. In the navigation bar, click **Companies**.\n2. Click the name of the company you want to generate the report for. The company's data page is displayed.\n3. Click the **Accounting** tab then click **Reports**.\n4. Select **Aged Creditors**.\n5. _(Optional)_ Edit the default reporting parameters.\n a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date. \n b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days).\n b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods).\n6. To run the report, click **Load aged creditors**.\n7. The report is generated and displayed at the bottom of the page.\n\nThe report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding bills or bill credit notes.", "type": "object", "properties": { "generated": { "$ref": "#/components/schemas/DateTime", "description": "Date and time the report was generated." }, "reportDate": { "$ref": "#/components/schemas/DateTime", "description": "Date the report is generated up to." }, "data": { "type": "array", "description": "Array of aged creditor.", "items": { "$ref": "#/components/schemas/AgedCreditorReport/definitions/agedCreditor" } } }, "examples": [ { "generated": "2022-10-23T00:00:00Z", "reportDate": "2022-10-23T00:00:00Z", "data": [ { "customerId": "f594cefb-7750-4c3a-bab2-b5322026dee9", "customerName": "John Doe", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2022-10-01T00:00:00Z", "toDate": "2022-10-31T00:00:00Z", "amount": 1547.5, "details": [ { "name": "Bills", "amount": 1547.5 } ] } ] } ] } ] } ], "definitions": { "agedCreditor": { "title": "Aged creditor", "type": "object", "properties": { "supplierId": { "type": "string", "description": "Supplier ID of the aged creditor.", "example": "f594cefb-7750-4c3a-bab2-b5322026dee9" }, "supplierName": { "type": "string", "description": "Supplier name of the aged creditor.", "example": "John Doe" }, "agedCurrencyOutstanding": { "type": "array", "description": "Array of aged creditors by currency.", "items": { "type": "object", "title": "Accounting: Aged currency outstanding", "properties": { "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency" }, "agedOutstandingAmounts": { "type": "array", "description": "Array of outstanding amounts by period.", "items": { "$ref": "#/components/schemas/AgedCreditorReport/definitions/agedCreditor/properties/agedCurrencyOutstanding/items/definitions/agedOutstandingAmount" } } }, "definitions": { "agedOutstandingAmount": { "type": "object", "title": "Aged outstanding amount", "properties": { "fromDate": { "$ref": "#/components/schemas/DateTime", "description": "Start date of period." }, "toDate": { "$ref": "#/components/schemas/DateTime", "description": "End date of period." }, "amount": { "type": "number", "format": "decimal", "description": "The amount outstanding." }, "details": { "type": "array", "description": "Array of details.", "items": { "$ref": "#/components/schemas/AgedCreditorReport/definitions/agedCreditor/properties/agedCurrencyOutstanding/items/definitions/agedOutstandingAmountDetail" } } } }, "agedOutstandingAmountDetail": { "type": "object", "title": "Amounts outstanding by data type", "properties": { "name": { "type": "string", "description": "Name of data type with outstanding amount for given period." }, "amount": { "type": "number", "format": "decimal", "description": "The amount outstanding." } } } } } } } } } }, "AgedDebtorReport": { "type": "object", "title": "Accounting: Aged debtors report", "description": "The Aged Debtors report shows the total outstanding balance due from customers to the business over time. \n\nYou can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal.\n\nTotal assets or liabilities are grouped into 30-day periods for each customer, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency.\n\n> It is not guaranteed that write-offs are included in the Aged Debtors report.\n\n## Underlying data\n\nThe Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/accounting-api#/schemas/Customer), [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/accounting-api#/schemas/Payment).\n\nTo generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again.\n\n> The Aged Debtors report runs based on the **issue dates** of the underlying data types rather than the due date.\n\n## Accessing the Aged Debtors report in Portal\n\nApart from returning the report via the API as JSON and query, you can also return the Aged Debtors report in the Codat portal.\n\n1. In the navigation bar, click **Companies**.\n2. Click the name of the company you want to generate the report for. The company's data page is displayed.\n3. Click the **Accounting** tab then click **Reports**.\n4. Select **Aged Debtors**.\n5. _(Optional)_ Edit the default reporting parameters.\n a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date. \n b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days).\n b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods).\n6. To run the report, click **Load aged debtors**.\n7. The report is generated and displayed at the bottom of the page.\n\nThe report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding invoices or credit notes.", "properties": { "generated": { "$ref": "#/components/schemas/DateTime", "description": "Date and time the report was generated." }, "reportDate": { "$ref": "#/components/schemas/DateTime", "description": "Date the report is generated up to." }, "data": { "type": "array", "description": "Array of aged debtors.", "items": { "$ref": "#/components/schemas/AgedDebtorReport/definitions/agedDebtor" } } }, "definitions": { "agedDebtor": { "title": "Aged debtor", "type": "object", "properties": { "customerId": { "type": "string", "description": "Customer ID of the aged debtor.", "example": "f594cefb-7750-4c3a-bab2-b5322026dee9" }, "customerName": { "type": "string", "description": "Customer name of the aged debtor.", "example": "John Doe" }, "agedCurrencyOutstanding": { "type": "array", "description": "Array of aged debtors by currency.", "items": { "$ref": "#/components/schemas/AgedCreditorReport/definitions/agedCreditor/properties/agedCurrencyOutstanding/items" } } } } }, "examples": [ { "generated": "2022-10-23T00:00:00Z", "reportDate": "2022-10-23T00:00:00Z", "data": [ { "customerId": "f594cefb-7750-4c3a-bab2-b5322026dee9", "customerName": "John Doe", "agedCurrencyOutstanding": [ { "currency": "GBP", "agedOutstandingAmounts": [ { "fromDate": "2022-10-01T00:00:00Z", "toDate": "2022-10-31T00:00:00Z", "amount": 1547.5, "details": [ { "name": "Invoices", "amount": 1547.5 } ] } ] } ] } ] } ] }, "Attachment": { "title": "Accounting: Attachment", "description": "The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes.\n\n> **Retrieving attachments**\n> \n> If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data.\n\nUnlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments.\n\nNote that different integrations have different requirements to file size and extension of attachments.\n\n| Integration | File size | File extension |\n|-------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Xero | 4 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP |\n| QuickBooks Online | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML |\n| NetSuite | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |\n| Dynamics 365 Business Central | 350 MB | Dynamics do not explicitly outline which file types are supported but they do state here that \"You can attach any type of file, such as text, image, or video files\". |\n\nView the coverage for each integration in the Data coverage explorer.\n", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the attachment, unique for the company in the accounting software." }, "name": { "type": "string", "nullable": true, "description": "Name of the attachment file." }, "contentType": { "type": "string", "nullable": true, "description": "File type of the attachment. This is represented by appending the file type to the [IETF standard file naming requirements](https://tools.ietf.org/html/rfc6838). For example, for a jpeg file the output is **image/jpeg**.\n\nSupported file types vary per platform. " }, "dateCreated": { "$ref": "#/components/schemas/DateTime" }, "fileSize": { "type": "integer", "format": "int32", "nullable": true, "description": "File size in bytes. For example, if this reads **46153**, then the file size is 46kb." }, "includeWhenSent": { "type": "boolean", "description": "If `true`, then the attachment is included with the associated invoice, bill or direct costs when it is printed, emailed, or sent to a customer, if the underlying accounting software allows this." } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "examples": [], "definitions": { "attachments": { "title": "Attachments", "type": "object", "properties": { "attachments": { "description": "An array of attachments related to the record.", "type": "array", "items": { "$ref": "#/components/schemas/Attachment" }, "nullable": true } } } } }, "AttachmentsDataset": { "x-internal": true, "type": "object", "properties": { "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" }, "nullable": true } }, "title": "Attachments" }, "AttachmentUpload": { "title": "Attachment upload", "type": "object", "x-internal": true, "required": [ "file" ], "properties": { "file": { "$ref": "#/components/schemas/AttachmentUpload/definitions/codatFile" } }, "definitions": { "codatFile": { "type": "string", "description": "The file to be uploaded as an attachment.", "format": "binary" } } }, "BalanceSheet": { "title": "Accounting: Balance sheet", "description": "> View the coverage for balance sheet in the Data coverage explorer.\n\n## Overview\n\nThe balance sheet is a snapshot of a company's accounts at a single point in time that provides a statement of the assets, liabilities and equity of an organization. It gives interested parties an idea of the company's financial position, in addition to displaying what the company owns and owes.\n\n> **Balance sheet or profit and loss report?**\n>\n> A profit and loss report summarises the total revenue, expenses, and profit or loss during a specified time period. A balance sheet report shows the financial position of a company at a specific moment in time.\n\n**Structure of this report**\nThis report will reflect the structure and line descriptions that the business has set in their own accounting software.\n\n**History**\nBy default, Codat pulls (up to) 24 months of balance sheets for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `balanceSheet` on the [data type settings endpoint](https://docs.codat.io/codat-api#/operations/update-sync-settings).\n\n**Want to pull this in a standardised structure?**\nOur [Enhanced Financials](https://docs.codat.io/lending/features/financial-statements-overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers.", "type": "object", "additionalProperties": false, "properties": { "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "Currency of the balance sheet." }, "reports": { "type": "array", "description": "An array of balance sheet reports.", "items": { "$ref": "#/components/schemas/BalanceSheet/definitions/balanceSheet" } }, "mostRecentAvailableMonth": { "$ref": "#/components/schemas/DateTime", "nullable": true, "description": "Most recent available monthly report data." }, "earliestAvailableMonth": { "$ref": "#/components/schemas/DateTime", "nullable": true, "description": "Earliest available monthly report data." } }, "required": [ "currency", "reports" ], "definitions": { "balanceSheet": { "type": "object", "properties": { "date": { "$ref": "#/components/schemas/DateTime", "description": "Point in time when a snapshot of a company's financial position is taken." }, "assets": { "$ref": "#/components/schemas/ReportLine", "description": "ReportLines for assets. For example, fixed and current assets." }, "liabilities": { "$ref": "#/components/schemas/ReportLine", "description": "ReportLines for liabilities. For example, current liabilities." }, "netAssets": { "type": "number", "format": "decimal", "description": "Value of net assets for a company in their base currency." }, "equity": { "$ref": "#/components/schemas/ReportLine", "description": "ReportLines for equities. For example, retained and current year earnings. See below." } }, "required": [ "netAssets" ] } } }, "BankAccount": { "title": "Accounting: Bank account", "description": "> **Accessing Bank Accounts through Banking API**\n> \n> This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. \n> \n> To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/schemas/Account)\n\n> View the coverage for bank accounts in the Data coverage explorer.\n\n## Overview\n\nA list of bank accounts associated with a company and a specific data connection.\n\nBank accounts data includes:\n* The name and ID of the account in the accounting software.\n* The currency and balance of the account.\n* The sort code and account number.", "type": "object", "allOf": [ { "properties": { "id": { "type": "string", "description": "Identifier for the account, unique for the company in the accounting software." } } }, { "$ref": "#/components/schemas/BankAccount/definitions/bankAccountPrototype" }, { "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "bankAccountPrototype": { "title": "Bank account prototype", "type": "object", "properties": { "accountName": { "type": "string", "nullable": true, "description": "Name of the bank account in the accounting software." }, "accountType": { "title": "Bank Account Type", "x-internal": true, "enum": [ "Unknown", "Credit", "Debit" ], "type": "string", "description": "The type of transactions and balances on the account. \nFor Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. \nFor Debit accounts, positive balances are assets, and positive transactions **increase** assets." }, "nominalCode": { "type": "string", "nullable": true, "description": "Code used to identify each nominal account for a business." }, "sortCode": { "type": "string", "nullable": true, "description": "Sort code for the bank account.\n\nXero integrations\nThe sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated." }, "accountNumber": { "type": "string", "nullable": true, "description": "Account number for the bank account.\n\nXero integrations\nOnly a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.\n\nFreeAgent integrations\nFor Credit accounts, only the last four digits are required. For other types, the field is optional." }, "iBan": { "type": "string", "nullable": true, "description": "International bank account number of the account. Often used when making or receiving international payments." }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "Base currency of the bank account." }, "balance": { "type": "number", "format": "decimal", "nullable": true, "description": "Balance of the bank account." }, "institution": { "type": "string", "nullable": true, "description": "The institution of the bank account." }, "availableBalance": { "type": "number", "format": "decimal", "nullable": true, "description": "Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example." }, "overdraftLimit": { "type": "number", "format": "decimal", "nullable": true, "description": "Pre-arranged overdraft limit of the account.\n\nThe value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`." }, "status": { "$ref": "#/components/schemas/BankAccount/definitions/bankAccountStatus" } } }, "bankAccountCreateResponse": { "title": "Create bank account response", "allOf": [ { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/BankAccount" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "bankAccountRef": { "title": "Bank account reference", "type": "object", "properties": { "id": { "type": "string", "description": "Bank account 'id' for the account transaction." }, "name": { "type": "string", "description": "bank account 'name' for the account transaction." } }, "description": "Links to the Account transactions data type." }, "bankAccounts": { "title": "Accounting: Bank accounts", "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccount" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "bankAccountStatus": { "title": "Account status", "enum": [ "Unknown", "Active", "Archived", "Pending" ], "type": "string", "description": "Status of the bank account.", "example": "Active" } } }, "BankAccounts": { "x-internal": true, "title": "Accounting: Bank accounts", "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccount" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "BankAccountTransaction": { "title": "Accounting: Bank account transaction", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the bank account transaction, unique for the company in the accounting software." }, "clearedOnDate": { "$ref": "#/components/schemas/DateTime" }, "description": { "type": "string", "nullable": true, "description": "Description of the bank transaction." }, "counterparty": { "type": "string", "nullable": true, "description": "The giving or receiving party such as a person or organization." }, "reference": { "type": "string", "nullable": true, "description": "An optional reference to the bank transaction." }, "reconciled": { "type": "boolean", "description": "`True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting software." }, "amount": { "type": "number", "format": "decimal", "description": "The amount transacted in the bank transaction." }, "balance": { "type": "number", "format": "decimal", "description": "The remaining balance in the account with ID `accountId`." }, "transactionType": { "$ref": "#/components/schemas/BankTransactions/allOf/0/properties/results/items/definitions/bankTransactionType" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ] }, "BankAccountTransactions": { "title": "Accounting: Bank account transactions", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccountTransaction" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "BankStatementAccount": { "type": "object", "title": "Accounting: Bank statement account", "properties": { "id": { "type": "string", "description": "Identifier for the bank account, unique for the company in the accounting software." }, "accountName": { "type": "string", "nullable": true, "description": "Name of the bank account in the accounting software." }, "fromDate": { "$ref": "#/components/schemas/DateTime" }, "toDate": { "$ref": "#/components/schemas/DateTime" }, "nominalCode": { "type": "string", "nullable": true, "description": "Code used to identify each nominal account for a business." }, "sortCode": { "type": "string", "nullable": true, "description": "Sort code for the bank account.\n\n**Xero integrations**\nThe sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated." }, "accountNumber": { "type": "string", "nullable": true, "description": "The bank account's account number." }, "iban": { "type": "string", "nullable": true, "description": "The bank account's [International Bank Account Number (IBAN)](https://en.wikipedia.org/wiki/International_Bank_Account_Number)." }, "currency": { "type": "string", "nullable": true, "description": "The bank account's base currency." }, "balance": { "type": "number", "format": "decimal", "nullable": true, "description": "The remaining balance in the bank account." }, "availableBalance": { "type": "number", "format": "decimal", "nullable": true, "description": "The available balancing remaining in the bank account." }, "modifiedDate": { "$ref": "#/components/schemas/ModifiedDates/allOf/0" }, "sourceModifiedDate": { "$ref": "#/components/schemas/ModifiedDates/allOf/1" }, "overdraftLimit": { "type": "number", "format": "decimal", "nullable": true, "description": "The bank account's overdraft limit." }, "institution": { "type": "string", "nullable": true, "description": "The bank account's institution." } } }, "BankTransactions": { "title": "Accounting: Accounting bank transactions", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "title": "Accounting: Bank account transaction", "description": "> **Accessing Bank Accounts through Banking API**\n> \n> This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. \n>\n> To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/operations/list-all-banking-transactions)\n\n> View the coverage for bank transactions in the Data coverage explorer.\n\n## Overview\n\nTransactional banking data for a specific company and account.\n\nBank transactions include the:\n* Amount of the transaction.\n* Current account balance.\n* Transaction type, for example, credit, debit, or transfer.", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the bank transaction, unique to the company in the accounting software." }, "accountId": { "type": "string", "nullable": true, "description": "Unique identifier to the `accountId` the bank transactions originates from." }, "clearedOnDate": { "$ref": "#/components/schemas/DateTime" }, "description": { "type": "string", "nullable": true, "description": "Description of the bank transaction." }, "reconciled": { "type": "boolean", "description": "`True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting software." }, "amount": { "type": "number", "format": "decimal", "description": "The amount transacted in the bank transaction." }, "balance": { "type": "number", "format": "decimal", "description": "The remaining balance in the account with ID `accountId`." }, "transactionType": { "$ref": "#/components/schemas/BankTransactions/allOf/0/properties/results/items/definitions/bankTransactionType" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "bankTransactionType": { "title": "Bank transaction type", "description": "Type of transaction for the bank statement line.", "type": "string", "enum": [ "Unknown", "Credit", "Debit", "Int", "Div", "Fee", "SerChg", "Dep", "Atm", "Pos", "Xfer", "Check", "Payment", "Cash", "DirectDep", "DirectDebit", "RepeatPmt", "Other" ] } } } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "BankTransactionsResponse": { "$ref": "#/components/schemas/BankTransactions" }, "Bill": { "title": "Accounting: Bill", "description": "> **Invoices or bills?**\n>\n> We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company has received an invoice, and owes money to someone else (accounts payable) we call this a Bill.\n>\n> See [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for the accounts receivable equivalent of bills.\n\nView the coverage for bills in the Data coverage explorer.\n\n## Overview\n\nIn Codat, a bill contains details of:\n* When the bill was recorded in the accounting system.\n* How much the bill is for and the currency of the amount.\n* Who the bill was received from — the *supplier*.\n* What the bill is for — the *line items*.\n\nSome accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's *expenses*.\n\nYou can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model.", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the bill, unique for the company in the accounting software." }, "reference": { "type": "string", "nullable": true, "description": "User-friendly reference for the bill." }, "supplierRef": { "$ref": "#/components/schemas/Supplier/definitions/supplierRef" }, "purchaseOrderRefs": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/PurchaseOrder/definitions/purchaseOrderRef" } }, "issueDate": { "allOf": [ { "description": "Date of the bill as recorded in the accounting software." }, { "$ref": "#/components/schemas/DateTime" } ] }, "dueDate": { "allOf": [ { "description": "Date the supplier is due to be paid." }, { "$ref": "#/components/schemas/DateTime" } ] }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency" }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "lineItems": { "type": "array", "nullable": true, "description": "Array of Bill line items.", "items": { "$ref": "#/components/schemas/Bill/definitions/billLineItem" } }, "withholdingTax": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Name assigned to withheld tax." }, "amount": { "type": "number", "format": "decimal", "description": "Amount of tax withheld." } }, "required": [ "amount", "name" ] } }, "status": { "$ref": "#/components/schemas/Bill/definitions/billStatus" }, "subTotal": { "type": "number", "format": "decimal", "description": "Total amount of the bill, excluding any taxes." }, "taxAmount": { "type": "number", "format": "decimal", "description": "Amount of tax on the bill." }, "totalAmount": { "type": "number", "format": "decimal", "description": "Amount of the bill, including tax." }, "amountDue": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount outstanding on the bill." }, "note": { "type": "string", "nullable": true, "description": "Any private, company notes about the bill, such as payment information." }, "paymentAllocations": { "type": "array", "nullable": true, "description": "An array of payment allocations.", "items": { "$ref": "#/components/schemas/DirectCost/definitions/directCostPrototype/properties/paymentAllocations/items" } }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "required": [ "issueDate", "status", "subTotal", "taxAmount", "totalAmount" ], "definitions": { "billStatus": { "description": "Current state of the bill.", "type": "string", "enum": [ "Unknown", "Open", "PartiallyPaid", "Paid", "Void", "Draft" ] }, "billLineItem": { "title": "Bill line item", "type": "object", "properties": { "lineNumber": { "type": "string", "nullable": true, "description": "The bill line's number." }, "description": { "type": "string", "nullable": true, "description": "Friendly name of the goods or services received." }, "unitAmount": { "type": "number", "format": "decimal", "description": "Price of each unit of goods or services." }, "quantity": { "type": "number", "format": "decimal", "description": "Number of units of goods or services received." }, "unitOfMeasurement": { "type": "string", "nullable": true, "description": "The measurement which defines a unit for this item (e.g. 'kilogram', 'litre')." }, "discountAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Numerical value of any discounts applied.\n\nDo not use to apply discounts in Oracle NetSuite—see Oracle NetSuite integration reference." }, "subTotal": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount of the line, inclusive of discounts but exclusive of tax." }, "taxAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount of tax for the line." }, "totalAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Total amount of the line, including tax." }, "discountPercentage": { "type": "number", "format": "decimal", "nullable": true, "description": "Percentage rate of any discount applied to the bill." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "Reference to the account to which the line item is linked." }, "taxRateRef": { "$ref": "#/components/schemas/TaxRate/definitions/taxRateRef", "description": "Reference to the tax rate to which the line item is linked." }, "itemRef": { "$ref": "#/components/schemas/Item/definitions/itemRef", "description": "Reference to the product, service type, or inventory item to which the line item is linked." }, "purchaseOrderLineRef": { "allOf": [ { "$ref": "#/components/schemas/ItemReceipt/definitions/itemReceiptLineItem/properties/purchaseOrderLineRef/allOf/0" }, { "description": "Reference to the purchase order line this line was generated from." } ] }, "trackingCategoryRefs": { "type": "array", "nullable": true, "description": "Collection of categories against which this item is tracked.", "items": { "$ref": "#/components/schemas/TrackingCategory/definitions/trackingCategoryRef" } }, "tracking": { "$ref": "#/components/schemas/BillCreditNote/definitions/billCreditNoteLineItem/properties/tracking" }, "isDirectCost": { "type": "boolean", "description": "The bill is a direct cost if `True`." } }, "required": [ "unitAmount", "quantity" ] } } }, "BillCreditNote": { "title": "Accounting: Bill credit note", "description": "> **Bill credit notes or credit notes?**\n> \n> In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote).\n\nView the coverage for bill credit notes in the Data coverage explorer.\n\n## Overview\n\nA bill credit note is issued by a supplier for the purpose of recording credit. For example, if a supplier was unable to fulfil an order that was placed by a business, or delivered damaged goods, they would issue a bill credit note. A bill credit note reduces the amount a business owes to the supplier. It can be refunded to the business or used to pay off future bills.\n\nIn the Codat API, a bill credit note is an accounts payable record issued by a [supplier](https://docs.codat.io/accounting-api#/schemas/Supplier). \n\nA bill credit note includes details of:\n* The original and remaining credit.\n* Any allocations of the credit against other records, such as [bills](https://docs.codat.io/accounting-api#/schemas/Bill).\n* The supplier that issued the bill credit note.", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the bill credit note that is unique to a company in the accounting software.", "example": "1509398f-98e2-436d-8a5d-c042e0c74ffc" }, "billCreditNoteNumber": { "type": "string", "nullable": true, "description": "Friendly reference for the bill credit note.", "example": "91fe2a83-e161-4c21-929d-c5c10c4b07e5" }, "supplierRef": { "$ref": "#/components/schemas/Supplier/definitions/supplierRef" }, "withholdingTax": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/Bill/allOf/0/properties/withholdingTax/items" } }, "totalAmount": { "type": "number", "format": "decimal", "description": "Total amount of credit that has been applied to the business' account with the supplier, including discounts and tax.", "example": 805.78 }, "totalDiscount": { "type": "number", "format": "decimal", "description": "Total value of any discounts applied.", "example": 0 }, "subTotal": { "type": "number", "format": "decimal", "description": "Total amount of the bill credit note, including discounts but excluding tax.", "example": 805.78 }, "totalTaxAmount": { "type": "number", "format": "decimal", "description": "Amount of tax included in the bill credit note.", "example": 0 }, "discountPercentage": { "type": "number", "format": "decimal", "description": "Percentage rate of any discount applied to the bill credit note.", "example": 0 }, "remainingCredit": { "type": "number", "format": "decimal", "description": "Amount of the bill credit note that is still outstanding.", "example": 0 }, "status": { "$ref": "#/components/schemas/BillCreditNote/definitions/billCreditNoteStatus" }, "issueDate": { "$ref": "#/components/schemas/DateTime", "description": "Date the bill credit note was issued by the supplier.", "example": "2022-03-15T00:00:00" }, "allocatedOnDate": { "$ref": "#/components/schemas/DateTime", "nullable": true, "description": "Date the bill credit note was fully refunded or allocated.", "example": "2022-09-15T16:35:00" }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "Currency of the bill credit note." }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "lineItems": { "type": "array", "nullable": true, "description": "An array of line ", "items": { "$ref": "#/components/schemas/BillCreditNote/definitions/billCreditNoteLineItem" } }, "paymentAllocations": { "nullable": true, "type": "array", "description": "An array of payment allocations.", "items": { "$ref": "#/components/schemas/DirectCost/definitions/directCostPrototype/properties/paymentAllocations/items" } }, "createdFromRefs": { "nullable": true, "type": "array", "description": "An array of records the credit note was created from.", "items": { "$ref": "#/components/schemas/DirectCost/definitions/tracking/properties/invoiceTo" } }, "note": { "type": "string", "nullable": true, "description": "Any additional information about the bill credit note.", "example": "Bill Credit Note with 1 line items, totaling 805.78" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" }, "metadata": { "$ref": "#/components/schemas/Metadata" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "required": [ "totalAmount", "totalDiscount", "subTotal", "totalTaxAmount", "discountPercentage", "status" ], "definitions": { "billCreditNoteStatus": { "type": "string", "description": "Current state of the bill credit note", "enum": [ "Unknown", "Draft", "Submitted", "Paid", "Void", "PartiallyPaid" ], "example": "Paid" }, "billCreditNoteLineItem": { "type": "object", "properties": { "description": { "type": "string", "nullable": true, "description": "Friendly name of each line item. For example, the goods or service for which credit has been received." }, "unitAmount": { "type": "number", "format": "decimal", "description": "Unit price of the goods or service." }, "quantity": { "type": "number", "format": "decimal", "description": "Number of units of the goods or service for which credit has been received." }, "unitOfMeasurement": { "type": "string", "nullable": true, "description": "The measurement which defines a unit for this item (e.g. 'kilogram', 'litre')." }, "discountAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Value of any discounts applied." }, "subTotal": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount of credit associated with the line item, including discounts but excluding tax." }, "taxAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount of tax associated with the line item." }, "totalAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Total amount of the line item, including discounts and tax." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef" }, "discountPercentage": { "type": "number", "format": "decimal", "nullable": true, "description": "Percentage rate of any discount applied to the line item." }, "taxRateRef": { "$ref": "#/components/schemas/TaxRate/definitions/taxRateRef" }, "itemRef": { "$ref": "#/components/schemas/Item/definitions/itemRef", "description": "Reference to the item the line is linked to." }, "createdFromLineRef": { "$ref": "#/components/schemas/ItemReceipt/definitions/itemReceiptLineItem/properties/purchaseOrderLineRef/allOf/0", "description": "Reference to the line of the item that the current line was created from." }, "trackingCategoryRefs": { "type": "array", "nullable": true, "deprecated": true, "description": "Reference to the tracking categories to which the line item is linked.", "items": { "$ref": "#/components/schemas/TrackingCategory/definitions/trackingCategoryRef" } }, "tracking": { "title": "Tracking", "x-internal": true, "type": "object", "description": "Categories, and a project and customer, against which the item is tracked.", "properties": { "categoryRefs": { "type": "array", "items": { "$ref": "#/components/schemas/TrackingCategory/definitions/trackingCategoryRef" } }, "customerRef": { "$ref": "#/components/schemas/Customer/definitions/accountingCustomerRef" }, "projectRef": { "$ref": "#/components/schemas/ProjectRef" }, "isBilledTo": { "$ref": "#/components/schemas/BillCreditNote/definitions/billCreditNoteLineItem/properties/tracking/definitions/billedToType" }, "isRebilledTo": { "$ref": "#/components/schemas/BillCreditNote/definitions/billCreditNoteLineItem/properties/tracking/definitions/billedToType" } }, "required": [ "categoryRefs", "isBilledTo", "isRebilledTo" ], "definitions": { "billedToType": { "type": "string", "description": "Defines if the invoice or credit note is billed/rebilled to a project or customer.", "enum": [ "Unknown", "NotApplicable", "Customer", "Project" ] } } } }, "required": [ "unitAmount", "quantity" ] } }, "examples": [ { "id": "6a0e9dfb-87b0-47d3-aaaf-9753ae9e757d", "billCreditNoteNumber": "14763237", "totalAmount": 693, "remainingCredit": 693, "status": "Submitted", "issueDate": "2019-02-18T16:03:07.268Z", "note": "Track separately", "currency": "USD", "lineItems": [ { "description": "AcmeMagnet", "unitAmount": 25, "discountAmount": 0, "quantity": 4, "subTotal": 100, "taxAmount": 10, "totalAmount": 110, "itemRef": { "id": "3" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498" }, "accountRef": { "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3" }, "trackingCategoryRefs": [ { "id": "department_1", "name": "ACMERockets" }, { "id": "costcode_2", "name": "ACM2-ACMESigns" } ], "createdFromLineRef": [ { "id": "8462", "dataType": "bill", "lineNumber": 1 } ] }, { "description": "ACMEDisintegratingPistol", "unitAmount": 25, "discountAmount": 0, "quantity": 3, "subTotal": 75, "taxAmount": 7.5, "totalAmount": 82.5, "itemRef": { "id": "3abf0883-03f7-44c6-bc15-1372522d25e1" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498" }, "accountRef": { "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3" } }, { "description": "ACMEWhippedCreamDispenser", "unitAmount": 52, "discountAmount": 0, "quantity": 6, "subTotal": 312, "taxAmount": 31.2, "totalAmount": 343.2, "itemRef": { "id": "3691f3d9-0ff7-4358-8a93-bed31c1b4b03" }, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498" }, "accountRef": { "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3" } }, { "description": "ACMEJetPropelledPogoStick", "unitAmount": 130, "discountAmount": 0, "quantity": 1, "subTotal": 130, "taxAmount": 27.3, "totalAmount": 157.3, "itemRef": { "id": "075410d4-7edc-4936-ba52-9e1e43cbe300" }, "taxRateRef": { "id": "d606732b-db18-44d7-823b-7f15f42c32ea" }, "accountRef": { "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3" } } ], "supplierRef": { "id": "67C6A7A1-5E84-4AC4-B950-24A114E379D0", "supplierName": "Chin's Gas and Oil" }, "createdFromLineRef": { "id": "8462", "dataType": "bills", "line": 1 } } ] }, "BillCreditNotes": { "title": "Accounting: Bill credit notes", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/BillCreditNote" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "BillPayment": { "title": "Accounting: Bill payment", "description": "> **Bill payments or payments?** \n> \n> We distinguish between transactions where the company received money vs. paid money. If the transaction represents a company spending money (accounts payable) we call this a Bill payment.\n>\n> See [payments](https://docs.codat.io/accounting-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote).\n\n> View the coverage for bill payments in the Data coverage explorer.\n\n## Overview\n\nBill payments include all accounts payable transaction data ([bills](https://docs.codat.io/accounting-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/accounting-api#/schemas/BillCreditNote)).\n\nA bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to:\n\n- A payment made against a bill — for example, a credit card payment, cheque payment, or cash payment.\n- An allocation of a supplier's credit note to a bill or perhaps a refund.\n- A bill payment made directly to an accounts payable account. This could be an overpayment or a prepayment, or a refund of a payment made directly to an accounts payable account.\n\nDepending on the bill payments which are allowed by the underlying accounting software, some of these types may be combined. Please see the example data section for samples of what these cases look like.\n\nIn Codat, a bill payment contains details of:\n\n- When the bill payment was recorded in the accounting system.\n- How much it is for and in the currency.\n- Who the payment has been paid to, the _supplier_.\n- The types of bill payments, the _line items_. \n\nSome accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) data model.\n\nBill payments is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).\n\n---\n\n## Bill payment types\n\n### Payment of a bill\n\nA payment paying a single bill should have the following properties:\n\n- A `totalAmount` indicating the amount of the bill that was paid. This is always positive.\n- A `lines` array containing one element with the following properties:\n - An `amount` equal to the `totalAmount` above.\n - A `links` array containing one element with the following properties:\n - A `type` indicating the type of link, in this case a `Bill`.\n - An `id` containing the ID of the bill that was paid.\n - An amount of `-totalAmount` (negative `totalAmount`), indicating that the entirety of the paid amount is allocated to the bill.\n\n### Payment of multiple bills\n\nIt is possible for one payment to pay multiple bills. This can be represented using two possible formats, depending on how the supplier keeps their books:\n\n1. The payment has multiple entries in its **lines** array, one for each bill that is paid. Each line will follow the above example for paying a bill, and the rules detailed in the data model.\n2. The payment has a line with multiple links to each bill. This occurs when the proportion of the original payment allocated to each bill is not available.\n\nEach line is the same as those described above, with the **amount** indicating how much of the payment is allocated to the bill. The **amount** on the lines sum to the **totalAmount** on the payment.\n\n> Pushing batch payments to Xero\n> \n> When pushing a single bill payment to Xero to pay multiple bills, only the first format is supported—multiple entries in the payment **lines** array.\n\n### Payments and refunds on account\n\nA payment on account, that is a payment that doesn’t pay a specific bill, has one entry in its lines array.\n\nThe line has the following properties:\n\n- A **totalAmount** indicating the amount paid by a supplier or refunded to them by a company. A payment to the supplier is always negative. A refund is always positive.\n- A **links** array containing one element with the following properties:\n - A **type** indicating the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`.\n - The **id** containing the ID of the supplier.\n - An amount for the link is `0` **totalAmount** or the amount of the payment or refund.\n\nIt is possible to have a payment that is part on account and part allocated to a bill. Each line should follow the examples above.\n\n### Using a credit note to pay a bill\n\nThe payment of a bill using a credit note has one entry in its `lines` array. This **line** has the following properties:\n\n- An **amount** indicating the amount of money moved, which in this case is `0`, as the credit note and bill allocation must balance each other.\n- A **links** array containing two elements:\n - The first link has:\n - A **type** indicating the type of link, in this case a `Bill`.\n - An **id** containing the ID of the bill that was paid.\n - The second link has:\n - A **type** indicating the type of link, in this case a `CreditNote`.\n - An **id** containing the ID of the credit note used by this payment.\n\nThe **amount** field on the **line** equals the **totalAmount** on the payment.\n\n### Refunding a credit note\n\nA bill payment refunding a credit note has one entry in its **lines** array. This line has the following properties:\n\n- An **amount** indicating the amount of the credit note that was refunded. This is always negative, indicating that it is a refund.\n- A **links** array containing one element with the following properties:\n - A **type** indicating the type of `link`, in this case a `CreditNote`.\n - An **id** containing the ID of the credit note that was refunded.\n\nThe **totalAmount** field on the payment equals the line's **amount** field. These are both negative, as this is money leaving accounts payable.\n\n### Refunding a payment\n\nIf a payment is refunded, for example, when a company overpaid a bill and the overpayment is returned, there are two payment records: \n\n- One for the incoming overpayment.\n- Another for the outgoing refund.\n\nThe payment issuing the refund is identified by the fact that the **totalAmount** is negative. This payment has one entry in its lines array that have the following properties:\n\n- An **amount** indicating the amount that was refunded. This is always negative.\n- A **links** array containing one element with the following properties:\n - A **type** indicating the type of a the link, in this case a `BillPayment`.\n - An **id** containing the ID of the payment that was refunded.\n\nThe **amount** field on the line equals the **totalAmount** on the payment and is negative as this is money leaving accounts payable.\n\nThe payment that was refunded can be identified as it has a line where the `amount` on its `line` is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was partly used to pay an bill. For example, a £1,050 payment paying a £1,000 bill with a refund of £50 has two lines: \n\n- One for £1,000 linked to the bill that was paid\n- Another for £50 linked to the payment that refunded the over payment. This link is of type `Refund` but the ID corresponds to a bill payment.\n\nThe line linked to the bill payment has the following properties:\n\n- An **amount** indicating the amount that was refunded. This is positive as its money that was added to accounts payable, but is balanced out by the negative amount of the refund.\n- A **links** array containing one element with the following properties:\n - A **type** indicating the type of the link, in this case a `Refund`.\n - An **id** containing the ID of the payment that refunded this line.\n\n> Linked payments\n> \n> Not all accounting software support linked payments in this way. In these platforms you may see a payment on account and a refund on account.\n\n## Foreign currencies\n\nThere are two types of currency rate that are detailed in the bill payments data type: \n\nPayment currency rate: \n\n- Base currency of the accounts payable account.\n- Foreign currency of the bill payment.\n\nPayment line link currency rate: \n\n- Base currency of the item that the link represents.\n- Foreign currency of the payment.\n\nThese two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a bill payment is applied to an item in a currency that does not match either:\n\n- The base currency for the accounts payable account. \n- The currency of the item.\n", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the bill payment, unique for the company in the accounting software.", "example": "3d5a8e00-d108-4045-8823-7f342676cffa" }, "supplierRef": { "allOf": [ { "$ref": "#/components/schemas/Supplier/definitions/supplierRef" }, { "description": "Supplier against which the payment is recorded in the accounting software." } ] }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "Account the payment is linked to in the accounting software." }, "totalAmount": { "type": "number", "format": "decimal", "description": "Amount of the payment in the payment currency. This value never changes and represents the amount of money that is paid into the supplier's account.", "example": 1329.54 }, "currency": { "allOf": [ { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency" }, { "description": "ISO currency code in which the bill payment is recorded in the accounting software." } ] }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "date": { "allOf": [ { "$ref": "#/components/schemas/DateTime" }, { "description": "Date the bill payment was recorded in the accounting software." } ] }, "note": { "type": "string", "nullable": true, "description": "Additional information associated with the payment.", "example": "Bill Payment against bill c13e37b6-dfaa-4894-b3be-9fe97bda9f44" }, "paymentMethodRef": { "allOf": [ { "$ref": "#/components/schemas/PaymentMethodRef" }, { "description": "The Payment Method to which the payment is linked in the accounting software." } ] }, "lines": { "type": "array", "nullable": true, "description": "An array of bill payment lines.", "items": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLine" } }, "reference": { "type": "string", "nullable": true, "description": "Additional information associated with the payment." }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "required": [ "date" ], "definitions": { "billPaymentLine": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "description": "Amount in the bill payment currency." }, "links": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink" } }, "allocatedOnDate": { "$ref": "#/components/schemas/DateTime", "description": "AllocatedOnDate must be specified and be later than the issue date of the bill." } }, "required": [ "amount" ] }, "billPaymentLineLink": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLinkType" }, "id": { "type": "string", "nullable": true, "description": "Unique identifier of the transaction represented by the link." }, "amount": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount by which the balance of the linked entity is altered, in the currency of the linked entity.\n\n- A negative link amount reduces the outstanding amount on the accounts payable account.\n- A positive link amount increases the outstanding amount on the accounts payable account." }, "currencyRate": { "title": "Currency rate", "type": "number", "format": "decimal", "nullable": true, "description": "Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.\n\nCurrency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. \n\nIt is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.\n\nWhere the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places). \n\nFor accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.\n\n## Examples with base currency of GBP\n\n| Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (GBP) |\n| :--------------- | :------------- | :------------ | :------------------------- |\n| **USD** | $20 | 0.781 | £15.62 |\n| **EUR** | €20 | 0.885 | £17.70 |\n| **RUB** | ₽20 | 0.011 | £0.22 |\n\n## Examples with base currency of USD\n\n| Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (USD) |\n| :--------------- | :------------- | :------------ | :------------------------- |\n| **GBP** | £20 | 1.277 | $25.54 |\n| **EUR** | €20 | 1.134 | $22.68 |\n| **RUB** | ₽20 | 0.015 | $0.30 |\n\n\n### Integration-specific details\n\n| Integration | Scenario | System behavior |\n|-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. |" } }, "required": [ "type" ] }, "billPaymentLineLinkType": { "description": "Types of links to bill payment lines.", "type": "string", "enum": [ "Unknown", "Unlinked", "Bill", "Other", "CreditNote", "BillPayment", "PaymentOnAccount", "Refund", "ManualJournal", "Discount" ] } }, "examples": [ { "totalAmount": 1000, "lines": [ { "amount": 1000, "links": [ { "type": "Bill", "id": "x", "amount": -1000 } ] } ] }, { "totalAmount": 0, "lines": [ { "amount": 0, "links": [ { "type": "Bill", "id": "x", "amount": -1000 }, { "type": "CreditNote", "id": "y", "amount": 1000 } ] } ] }, { "totalAmount": 2000, "lines": [ { "amount": 1000, "links": [ { "type": "Bill", "id": "x", "amount": -1000 } ] }, { "amount": 1000, "links": [ { "type": "PaymentOnAccount", "id": "y", "amount": -1000 } ] } ] }, { "totalAmount": -1000, "lines": [ { "amount": -1000, "links": [ { "type": "CreditNote", "id": "y", "amount": 1000 } ] } ] }, { "totalAmount": -1000, "lines": [ { "amount": -1000, "links": [ { "type": "PaymentOnAccount", "id": "y", "amount": 1000 } ] } ] }, { "totalAmount": 250, "lines": [ { "amount": 0, "links": [ { "type": "Bill", "id": "x", "amount": -750 }, { "type": "CreditNote", "id": "y", "amount": 750 } ] }, { "amount": 250, "links": [ { "type": "Bill", "id": "x", "amount": -250 } ] } ] }, { "totalAmount": 1000, "lines": [ { "amount": 1000, "links": [ { "type": "Bill", "id": "x", "amount": -1000 } ] } ], "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z" }, { "totalAmount": 2000, "lines": [ { "amount": 0, "links": [ { "type": "Bill", "id": "x", "amount": -1000 }, { "type": "CreditNote", "id": "y", "amount": 1000 } ] }, { "amount": 0, "links": [ { "type": "Bill", "id": "x", "amount": -1000 }, { "type": "CreditNote", "id": "z", "amount": 1000 } ] }, { "amount": 1000, "links": [ { "type": "Bill", "id": "x", "amount": -1000 } ] }, { "amount": 1000, "links": [ { "type": "PaymentOnAccount", "id": "customer-001", "amount": -1000 } ] } ] }, { "totalAmount": 0, "lines": [ { "amount": 0, "links": [ { "type": "Bill", "id": "w", "amount": -1000 }, { "type": "Bill", "id": "x", "amount": -1000 }, { "type": "CreditNote", "id": "y", "amount": 1000 }, { "type": "CreditNote", "id": "z", "amount": 1000 } ] } ] }, { "totalAmount": 1000, "lines": [ { "amount": 1000, "links": [ { "type": "Bill", "id": "x", "amount": -1000 } ] } ], "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z" }, { "id": "001", "totalAmount": 5000, "date": "1901-01-01", "lines": [ { "amount": 1000, "links": [ { "type": "Bill", "id": "x", "amount": -1000 } ] }, { "amount": 4000, "links": [ { "type": "PaymentOnAccount", "id": "y", "amount": -4000 } ] } ] }, { "id": "001", "totalAmount": 5000, "date": "1901-01-01", "lines": [ { "amount": 1000, "links": [ { "type": "Bill", "id": "x", "amount": -1000 } ] }, { "amount": 1000, "links": [ { "type": "Bill", "id": "y", "amount": -1000 } ] }, { "amount": 3000, "links": [ { "type": "PaymentOnAccount", "id": "y", "amount": -3000 } ] } ] }, { "totalAmount": 500, "lines": [ { "amount": 500, "links": [ { "type": "Bill", "id": "a", "amount": -1000 }, { "type": "Bill", "id": "b", "amount": -1000 }, { "type": "CreditNote", "id": "y", "amount": 750 }, { "type": "CreditNote", "id": "z", "amount": 750 } ] } ] } ] }, "BillPayments": { "title": "Accounting: Bill payments", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/BillPayment" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "Bills": { "title": "Accounting: Bills", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Bill" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "CashFlowStatement": { "title": "Accounting: Cash flow statement", "description": "> View the coverage for cash flow statement in the Data coverage explorer.\n\n> **Operating activities only** \n> \n> Currently, the cash flow statement shows cash that flows into and out of the company from operating activities *only*. Operating activities generate cash from the sale of goods or services.\n\n## Overview\n\nA cash flow statement is a financial report that records all cash that is received or spent by a company during a given period. It gives you a clearer picture of the company’s performance, and their ability to pay creditors and finance growth.\n\n> **Cash flow statement or balance sheet?**\n> \n> Look at the cash flow statement to understand a company's ability to pay its bills. Although the balance sheet may show healthy earnings at a specific point in time, the cash flow statement allows you to see whether the company is meeting its financial commitments, such as paying creditors or its employees.", "type": "object", "properties": { "reports": { "description": "Array of cash flow statements.", "type": "array", "items": { "$ref": "#/components/schemas/CashFlowStatement/definitions/cashFlowStatement" } }, "reportBasis": { "$ref": "#/components/schemas/CashFlowStatement/definitions/reportBasis" }, "reportInput": { "$ref": "#/components/schemas/CashFlowStatement/definitions/reportInput" }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "Currency of all values in the cash flow statement." }, "mostRecentAvailableMonth": { "$ref": "#/components/schemas/DateTime", "nullable": true }, "earliestAvailableMonth": { "$ref": "#/components/schemas/DateTime", "nullable": true } }, "required": [ "reports", "reportBasis", "reportInput", "currency" ], "definitions": { "reportBasis": { "title": "Report basis", "description": "Accounting method used when aggregating the report data. In this case, `Cash`.", "type": "string", "enum": [ "Unknown", "Accrual", "Cash" ] }, "reportInput": { "description": "Accounting method used to prepare the cash flow statement.", "type": "string", "enum": [ "Unknown", "Indirect", "Direct" ] }, "cashFlowStatement": { "title": "Cash flow statement", "type": "object", "properties": { "fromDate": { "$ref": "#/components/schemas/DateTime", "description": "Start date for the reporting period." }, "toDate": { "$ref": "#/components/schemas/DateTime", "description": "End date for the reporting period." }, "cashReceipts": { "$ref": "#/components/schemas/ReportLine", "description": "ReportLines for cash receipts from the sale of goods." }, "cashPayments": { "$ref": "#/components/schemas/ReportLine", "description": "ReportLines for cash payments to suppliers for the purchase of goods or services." } } } } }, "CompanyDataset": { "title": "Accounting: Company profile", "description": "> View the coverage for company profile in the Data coverage explorer.\n\nCompany info provides standard details about a linked company such as their address, phone number, and company registration.\n\n> **Company information or companies?**\n> \n> Company profile is standard information that is held in the accounting software about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources.", "type": "object", "properties": { "companyName": { "type": "string", "nullable": true, "description": "Name of the linked company." }, "accountingPlatformRef": { "type": "string", "nullable": true, "description": "Identifier or reference for the company in the accounting software." }, "companyLegalName": { "type": "string", "nullable": true, "description": "Registered legal name of the linked company." }, "addresses": { "type": "array", "nullable": true, "description": "An array of Addresses.", "items": { "title": "Accounting: Address", "x-internal": true, "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CompanyDataset/properties/addresses/items/definitions/accountingAddressType" }, "line1": { "type": "string", "nullable": true, "description": "Line 1 of the customer address." }, "line2": { "type": "string", "nullable": true, "description": "Line 2 of the customer address." }, "city": { "type": "string", "nullable": true, "description": "City of the customer address." }, "region": { "type": "string", "nullable": true, "description": "Region of the customer address." }, "country": { "type": "string", "nullable": true, "description": "Country of the customer address." }, "postalCode": { "type": "string", "nullable": true, "description": "Postal code or zip code." } }, "required": [ "type" ], "definitions": { "accountingAddressType": { "description": "The type of the address", "type": "string", "enum": [ "Unknown", "Billing", "Delivery" ] } } } }, "phoneNumbers": { "type": "array", "nullable": true, "description": "An array of phone numbers.", "items": { "title": "Phone", "type": "object", "x-internal": true, "properties": { "number": { "type": "string", "nullable": true, "examples": [ "+44 25691 154789", "(877) 492-8687", "01224 658 999" ], "description": "A phone number." }, "type": { "$ref": "#/components/schemas/CompanyDataset/properties/phoneNumbers/items/definitions/phoneNumberType" } }, "required": [ "type" ], "definitions": { "phoneNumberType": { "description": "The type of phone number", "type": "string", "enum": [ "Primary", "Landline", "Mobile", "Fax", "Unknown" ] } } } }, "webLinks": { "type": "array", "nullable": true, "description": "An array of weblinks.", "items": { "title": "Weblink", "description": "Weblink associated with the company.", "type": "object", "properties": { "type": { "description": "The type of the weblink.", "type": "string", "enum": [ "Website", "Social", "Unknown" ] }, "url": { "description": "The full URL for the weblink.", "type": "string", "format": "url" } }, "example": { "type": "Website", "url": "https://codat.io" } } }, "ledgerLockDate": { "$ref": "#/components/schemas/DateTime", "description": "If set in the accounting software, the date (in the ISO 8601 date/time format) after which accounting transactions cannot be edited. Commonly used when books are closed at year-end." }, "registrationNumber": { "type": "string", "nullable": true, "description": "Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House." }, "taxNumber": { "type": "string", "nullable": true, "description": "Company tax number." }, "financialYearStartDate": { "$ref": "#/components/schemas/DateTime", "description": "Start date of the financial year for the company." }, "baseCurrency": { "type": "string", "nullable": true, "description": "Currency set in the accounting software of the linked company. Used by the currency rate." }, "sourceUrls": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true, "description": "URL addresses for the accounting source.\n\nFor example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero)." }, "createdDate": { "$ref": "#/components/schemas/DateTime", "description": "Date the linked company was created in the accounting software." }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } }, "examples": [ { "companyName": "ACME Corporation", "accountingPlatformRef": "4444e827-401b-4925-92cb-d79086bf3b6b", "companyLegalName": "ACME Corporation Ltd.", "addresses": [ { "type": "Billing", "line1": "Warner House", "line2": "98 Theobald's Road", "city": "London", "region": "", "country": "United Kingdom", "postalcode": "WC1X 8WB" }, { "type": "Unknown", "line1": "123 Sierra Way", "line2": "", "city": "San Pablo", "region": "CA", "country": "", "postalCode": "87999" } ], "phoneNumbers": [ { "number": "010 1234 5678", "type": "Landline" } ], "webLinks": [ { "type": "Website", "url": "https://www.wbsl.com/" } ], "ledgerLockDate": "2019-03-04T12:08:01.881Z", "registrationNumber": "1234567890", "taxNumber": "GB 123456789", "financialYearStartDate": "2019-04-01T00:00:00Z", "baseCurrency": "USD", "sourceUrls": { "url1": "https://go.xero.com/organisationlogin/default.aspx?shortcode=!rxs0Q", "url2": "https://reporting.xero.com/!rxs0Q" }, "createdDate": "2020-02-03T16:42:02Z" } ] }, "CreateAccountResponse": { "title": "Accounting: Create account response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Account" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateBankAccountResponse": { "title": "Accounting: Create bank account response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/BankAccount" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateBankTransactions": { "title": "Accounting: Create bank account transactions", "type": "object", "properties": { "accountId": { "$ref": "#/components/parameters/bankAccountId/schema" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/CreateBankTransactions/definitions/CreateBankAccountTransaction" } } }, "definitions": { "CreateBankAccountTransaction": { "title": "Bank account transaction", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/BankAccountTransaction/allOf/0/properties/id" }, "amount": { "$ref": "#/components/schemas/BankAccountTransaction/allOf/0/properties/amount" }, "date": { "$ref": "#/components/schemas/DateTime" }, "description": { "$ref": "#/components/schemas/BankAccountTransaction/allOf/0/properties/description", "nullable": false }, "balance": { "$ref": "#/components/schemas/BankAccountTransaction/allOf/0/properties/balance" } } } } }, "CreateBankTransactionsResponse": { "title": "Accounting: Create/update bank transaction response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateBankTransactions" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateBillCreditNoteResponse": { "title": "Accounting: Create bill credit note response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/BillCreditNote" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateBillPaymentResponse": { "title": "Accounting: Create bill payment response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/BillPayment" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateBillResponse": { "title": "Accounting: Create bill response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Bill" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateCreditNoteResponse": { "title": "Accounting: Create credit note response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreditNote" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateCustomerResponse": { "title": "Accounting: Create customer response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Customer" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateDirectCostResponse": { "title": "Accounting: Create direct cost response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DirectCost" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateDirectIncomeResponse": { "title": "Accounting: Create direct income response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DirectIncome" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateInvoiceResponse": { "title": "Accounting: Create invoice response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Invoice" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateItemResponse": { "title": "Accounting: Create item response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Item" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateJournalEntryResponse": { "title": "Accounting: Create journal entry response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/JournalEntry" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateJournalResponse": { "title": "Accounting: Create journal response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Journal" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreatePaymentResponse": { "title": "Accounting: Create payment response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Payment" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreatePurchaseOrderResponse": { "title": "Accounting: Create purchase order response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PurchaseOrder" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateSupplierResponse": { "title": "Accounting: Create supplier response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Supplier" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreateTransferResponse": { "title": "Accounting: Create transfer response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Transfer" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "CreditNote": { "title": "Accounting: Credit note", "description": "> View the coverage for credit notes in the Data coverage explorer.\n\n## Overview\n\nThink of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can either reduce the amount owed or cancel out an invoice entirely.\n\nIn the Codat system a credit note is issued to a [customer's](https://docs.codat.io/accounting-api#/schemas/Customer) accounts receivable. \n\nIt contains details of:\n* The amount of credit remaining and its status.\n* Payment allocations against the payments type, in this case an invoice.\n* Which customers the credit notes have been issued to.", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the credit note, unique to the company in the accounting software." }, "creditNoteNumber": { "type": "string", "nullable": true, "description": "Friendly reference for the credit note." }, "customerRef": { "$ref": "#/components/schemas/Customer/definitions/accountingCustomerRef", "description": "Reference to the customer the credit note has been issued to." }, "withholdingTax": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/Bill/allOf/0/properties/withholdingTax/items" } }, "totalAmount": { "type": "number", "format": "decimal", "description": "Total amount of credit that has been applied to the customer's accounts receivable" }, "totalDiscount": { "type": "number", "format": "decimal", "description": "Any discounts applied to the credit note amount." }, "subTotal": { "type": "number", "format": "decimal", "description": "Value of the credit note, including discounts and excluding tax." }, "additionalTaxAmount": { "type": "number", "format": "decimal", "description": "Additional tax amount applied to credit note." }, "additionalTaxPercentage": { "type": "number", "format": "decimal", "description": "Percentage rate of any additional tax applied to the credit note." }, "totalTaxAmount": { "type": "number", "format": "decimal", "description": "Any tax applied to the credit note amount." }, "discountPercentage": { "type": "number", "format": "decimal", "description": "Percentage rate (from 0 to 100) of discounts applied to the credit note." }, "remainingCredit": { "type": "number", "format": "decimal", "description": "Unused balance of totalAmount originally raised." }, "status": { "$ref": "#/components/schemas/CreditNote/definitions/creditNoteStatus", "description": "Current state of the credit note." }, "issueDate": { "$ref": "#/components/schemas/DateTime", "description": "Date of the credit note as recorded in the accounting system." }, "allocatedOnDate": { "$ref": "#/components/schemas/DateTime", "description": "Date on which the credit note was fully allocated." }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "Currency of the credit note." }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "lineItems": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/CreditNote/definitions/creditNoteLineItem" } }, "paymentAllocations": { "type": "array", "nullable": true, "description": "An array of payment allocations.", "items": { "$ref": "#/components/schemas/DirectCost/definitions/directCostPrototype/properties/paymentAllocations/items" } }, "note": { "type": "string", "nullable": true, "description": "Any additional information about the credit note. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when a credit note is emailed from the accounting software to the customer." }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "required": [ "totalAmount", "totalDiscount", "subTotal", "totalTaxAmount", "discountPercentage", "remainingCredit", "status" ], "definitions": { "creditNoteStatus": { "title": "Credit note status", "description": "Current state of the credit note.", "type": "string", "enum": [ "Unknown", "Draft", "Submitted", "Paid", "Void", "PartiallyPaid" ] }, "creditNoteLineItem": { "type": "object", "properties": { "description": { "type": "string", "nullable": true, "description": "Friendly name of each line item. For example, the goods or service for which credit has been issued." }, "unitAmount": { "type": "number", "format": "decimal", "description": "Unit price of the goods or service." }, "quantity": { "type": "number", "format": "decimal", "description": "Number of units of the goods or service for which credit has been issued." }, "discountAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Value of any discounts applied." }, "subTotal": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount of credit associated with the line item, including discounts but excluding tax." }, "taxAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount of tax associated with the line item." }, "totalAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Total amount of the line item, including discounts and tax." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "Reference to the account to which the line item is linked." }, "discountPercentage": { "type": "number", "format": "decimal", "nullable": true, "description": "Percentage rate of any discount applied to the line item." }, "taxRateRef": { "$ref": "#/components/schemas/TaxRate/definitions/taxRateRef", "description": "Reference to the tax rate to which the line item is linked." }, "itemRef": { "$ref": "#/components/schemas/Item/definitions/itemRef", "description": "Reference to the item the line is linked to." }, "trackingCategoryRefs": { "type": "array", "nullable": true, "deprecated": true, "description": "Reference to the tracking categories to which the line item is linked.", "items": { "$ref": "#/components/schemas/TrackingCategory/definitions/trackingCategoryRef" } }, "tracking": { "title": "Tracking", "x-internal": true, "type": "object", "description": "Categories, and a project and customer, against which the item is tracked.", "properties": { "categoryRefs": { "type": "array", "items": { "$ref": "#/components/schemas/TrackingCategory/definitions/trackingCategoryRef" } }, "customerRef": { "$ref": "#/components/schemas/Customer/definitions/accountingCustomerRef" }, "projectRef": { "$ref": "#/components/schemas/ProjectRef" }, "isBilledTo": { "$ref": "#/components/schemas/CreditNote/definitions/creditNoteLineItem/properties/tracking/definitions/billedToType" }, "isRebilledTo": { "$ref": "#/components/schemas/CreditNote/definitions/creditNoteLineItem/properties/tracking/definitions/billedToType" }, "recordRef": { "$ref": "#/components/schemas/DirectCost/definitions/tracking/properties/invoiceTo" } }, "required": [ "categoryRefs", "isBilledTo", "isRebilledTo" ], "definitions": { "billedToType": { "type": "string", "enum": [ "Unknown", "NotApplicable", "Project" ], "description": "Defines if the bill or bill credit note is billed/rebilled to a project." } } }, "isDirectIncome": { "type": "boolean", "description": "The credit note is a direct income if `True`." } }, "required": [ "unitAmount", "quantity" ] } }, "examples": [ [ { "id": "0316bd24-8a01-4a3a-a0e5-a73f14ebcbec", "creditNoteNumber": "5239277", "customerRef": { "id": "b5511228-b9ef-4713-91b1-ad2cf60eadb1", "companyName": "Tool Hire Company" }, "totalAmount": 550, "totalDiscount": 0, "subTotal": 0, "totalTaxAmount": 0, "discountPercentage": 0, "remainingCredit": 550, "status": "Submitted", "issueDate": "2018-03-28T21:28:58.249Z", "allocatedOnDate": null, "note": "More information available on request.", "currency": "USD", "currencyRate": null, "lineItems": [ { "description": "Anvil10000Lb", "unitAmount": 50, "quantity": 10, "discountAmount": 0, "subTotal": 500, "taxAmount": 50, "totalAmount": 550, "accountRef": { "id": "3f267b10-757d-44c0-bef9-20f70cc8fbe3", "name": null }, "discountPercentage": null, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": null }, "itemRef": { "id": "1", "name": null } } ], "paymentAllocations": [], "modifiedDate": null, "sourceModifiedDate": null } ] ] }, "CreditNotes": { "title": "Accounting: Credit notes", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "Customer": { "title": "Accounting: Customer", "description": "> View the coverage for customers in the Data coverage explorer.\n\n## Overview\n\nA customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers).\n\nCustomers' data links to accounts receivable [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice).\n", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the customer, unique to the company in the accounting software." }, "customerName": { "type": "string", "nullable": true, "description": "Name of the customer as recorded in the accounting system, typically the company name." }, "contactName": { "type": "string", "nullable": true, "description": "Name of the main contact for the identified customer." }, "emailAddress": { "type": "string", "nullable": true, "description": "Email address the customer can be contacted by." }, "defaultCurrency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "Default currency the transactional data of the customer is recorded in." }, "phone": { "type": "string", "nullable": true, "description": "Phone number the customer can be contacted by." }, "addresses": { "type": "array", "nullable": true, "description": "An array of Addresses.", "items": { "$ref": "#/components/schemas/CompanyDataset/properties/addresses/items" } }, "contacts": { "type": "array", "nullable": true, "description": "An array of Contacts.", "items": { "$ref": "#/components/schemas/Customer/definitions/contact" } }, "registrationNumber": { "type": "string", "nullable": true, "description": "Company number. In the UK, this is typically the Companies House company registration number." }, "taxNumber": { "type": "string", "nullable": true, "description": "Company tax number." }, "status": { "$ref": "#/components/schemas/Customer/definitions/customerStatus", "description": "Current state of the customer." }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "required": [ "status" ], "definitions": { "accountingCustomerRef": { "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "`id` from the Customers data type" }, "companyName": { "type": "string", "nullable": true, "description": "`customerName` from the Customer data type" } }, "required": [ "id" ] }, "customerStatus": { "description": "Status of customer.", "type": "string", "enum": [ "Unknown", "Active", "Archived" ] }, "contact": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Name of a contact for a customer." }, "email": { "type": "string", "nullable": true, "description": "Email of a contact for a customer." }, "phone": { "type": "array", "nullable": true, "description": "An array of Phone numbers.", "items": { "$ref": "#/components/schemas/CompanyDataset/properties/phoneNumbers/items" } }, "address": { "$ref": "#/components/schemas/CompanyDataset/properties/addresses/items", "description": "An object of Address information." }, "status": { "$ref": "#/components/schemas/Customer/definitions/customerStatus" }, "modifiedDate": { "$ref": "#/components/schemas/DateTime" } }, "required": [ "status" ] } } }, "Customers": { "title": "Accounting: Customers", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "Dataset": { "title": "Dataset", "x-internal": true, "required": [ "companyId", "connectionId", "id", "isCompleted", "isErrored", "progress", "requested", "status" ], "type": "object", "properties": { "datasetLogsUrl": { "type": "string", "format": "uri", "nullable": true, "description": "URI to the dataset's logs." }, "id": { "type": "string", "format": "uuid", "description": "Identifier for the dataset." }, "companyId": { "$ref": "#/components/parameters/companyId/schema" }, "connectionId": { "$ref": "#/components/parameters/connectionId/schema" }, "dataType": { "$ref": "#/components/schemas/DataType" }, "status": { "$ref": "#/components/schemas/Dataset/definitions/datasetStatus" }, "errorMessage": { "type": "string", "nullable": true, "description": "A brief message about the error." }, "requested": { "$ref": "#/components/schemas/DateTime" }, "completed": { "$ref": "#/components/schemas/DateTime", "nullable": true }, "progress": { "type": "integer", "format": "int32", "description": "An integer signifying the progress of the dataset." }, "isCompleted": { "type": "boolean", "description": "`True` if the dataset completed successfully." }, "isErrored": { "type": "boolean", "description": "`True` if the dataset entered an error state." }, "validationInformationUrl": { "type": "string", "nullable": true, "format": "uri", "description": "URI to the dataset's validation information." } }, "definitions": { "datasetStatus": { "title": "Dataset status", "type": "string", "description": "The current status of the dataset.", "enum": [ "Initial", "Queued", "Fetching", "MapQueued", "Mapping", "Complete", "FetchError", "MapError", "InternalError", "ProcessingQueued", "Processing", "ProcessingError", "ValidationQueued", "Validating", "ValidationError", "AuthError", "Cancelled", "NotSupported", "RateLimitError", "PermissionsError", "PrerequisiteNotMet" ] } } }, "DataType": { "title": "Data types", "x-internal": true, "type": "string", "description": "Available data types", "enum": [ "accountTransactions", "balanceSheet", "bankAccounts", "bankTransactions", "billCreditNotes", "billPayments", "bills", "cashFlowStatement", "chartOfAccounts", "company", "creditNotes", "customers", "directCosts", "directIncomes", "invoices", "itemReceipts", "items", "journalEntries", "journals", "paymentMethods", "payments", "profitAndLoss", "purchaseOrders", "salesOrders", "suppliers", "taxRates", "trackingCategories", "transfers", "banking-accountBalances", "banking-accounts", "banking-transactionCategories", "banking-transactions", "commerce-companyInfo", "commerce-customers", "commerce-disputes", "commerce-locations", "commerce-orders", "commerce-paymentMethods", "commerce-payments", "commerce-productCategories", "commerce-products", "commerce-taxComponents", "commerce-transactions" ], "example": "invoices" }, "DateTime": { "title": "Date time", "type": "string", "examples": [ "2022-10-23T00:00:00.000Z", "2022-10-23T00:00:00.000Z" ], "description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced." }, "DirectCost": { "title": "Accounting: Direct cost", "description": "> **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting software.\n\n> View the coverage for direct costs in the Data coverage explorer.\n\n## Overview\n\nDirect costs are the expenses associated with a business' operations. For example, purchases of raw materials and service fees are considered direct costs.\n\nDirect costs include:\n * Purchasing an item and paying it off at the point of the purchase\n * Receiving cash from a refunded item if the refund is made by the supplier\n * Withdrawing money from a bank account \n * Writing a cheque\n\nDirect costs is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the direct cost, unique for the company." } } }, { "$ref": "#/components/schemas/DirectCost/definitions/directCostPrototype" }, { "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "directCostPrototype": { "type": "object", "properties": { "reference": { "type": "string", "nullable": true, "description": "User-friendly reference for the direct cost." }, "note": { "type": "string", "nullable": true, "description": "A note attached to the direct cost." }, "contactRef": { "$ref": "#/components/schemas/JournalEntry/definitions/journalLine/properties/contactRef", "description": "A customer or supplier associated with the direct cost." }, "issueDate": { "$ref": "#/components/schemas/DateTime", "description": "Date of the direct cost as recorded in the accounting software.Date of the direct cost as recorded in the accounting software." }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "Currency of the direct cost." }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "lineItems": { "type": "array", "description": "An array of line items.", "items": { "$ref": "#/components/schemas/DirectCost/definitions/directCostLineItem" } }, "paymentAllocations": { "type": "array", "description": "An array of payment allocations.", "items": { "title": "Accounting: Payment allocation", "type": "object", "properties": { "payment": { "$ref": "#/components/schemas/DirectCost/definitions/directCostPrototype/properties/paymentAllocations/items/definitions/paymentAllocationPayment" }, "allocation": { "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "The currency of the transaction." }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "allocatedOnDate": { "$ref": "#/components/schemas/DateTime", "description": "The date the payment was allocated." }, "totalAmount": { "type": "number", "format": "decimal", "description": "The total amount that has been allocated." } } } }, "required": [ "payment", "allocation" ], "definitions": { "paymentAllocationPayment": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the allocated payment." }, "note": { "type": "string", "nullable": true, "description": "Notes attached to the allocated payment." }, "reference": { "type": "string", "nullable": true, "description": "Reference to the allocated payment." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "The account that the allocated payment is made from or to." }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "Currency the payment has been made in." }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "paidOnDate": { "$ref": "#/components/schemas/DateTime", "description": "The date the payment was paid." }, "totalAmount": { "type": "number", "format": "decimal", "description": "Total amount that was paid." } } } } } }, "subTotal": { "type": "number", "format": "decimal", "description": "The total amount of the direct costs, excluding any taxes." }, "taxAmount": { "type": "number", "format": "decimal", "description": "The total amount of tax on the direct costs." }, "totalAmount": { "type": "number", "format": "decimal", "description": "The amount of the direct costs, inclusive of tax." }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } }, "required": [ "issueDate", "currency", "lineItems", "paymentAllocations", "subTotal", "taxAmount", "totalAmount" ] }, "directCostLineItem": { "type": "object", "properties": { "description": { "type": "string", "nullable": true, "description": "Friendly name of the goods or services." }, "unitAmount": { "type": "number", "format": "decimal", "description": "Price of each unit of goods or services.\nNote: If the platform does not provide this information, the unit amount will be mapped to the total amount." }, "quantity": { "type": "number", "format": "decimal", "description": "Number of units of goods or services received.\n\nNote: If the platform does not provide this information, the quantity will be mapped as 1." }, "discountAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Discount amount for the line before tax." }, "discountPercentage": { "type": "number", "format": "decimal", "nullable": true, "description": "Discount percentage for the line before tax." }, "subTotal": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount of the line, inclusive of discounts but exclusive of tax." }, "taxAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount of tax for the line." }, "totalAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Total amount of the line, including tax." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "Reference to the account to which the line item is linked." }, "taxRateRef": { "$ref": "#/components/schemas/TaxRate/definitions/taxRateRef", "description": "Reference to the tax rate to which the the line item is linked." }, "itemRef": { "$ref": "#/components/schemas/Item/definitions/itemRef", "description": "Reference to the product, service type, or inventory item to which the direct cost is linked." }, "trackingCategoryRefs": { "type": "array", "nullable": true, "deprecated": true, "description": "Collection of categories against which this direct cost is tracked.", "items": { "$ref": "#/components/schemas/TrackingCategory/definitions/trackingCategoryRef" } }, "tracking": { "$ref": "#/components/schemas/DirectCost/definitions/tracking" } }, "required": [ "unitAmount", "quantity" ] }, "tracking": { "title": "Invoiceable tracking", "required": [ "recordRefs" ], "type": "object", "properties": { "recordRefs": { "type": "array", "items": { "$ref": "#/components/schemas/ItemReceipt/definitions/itemReceiptLineItem/properties/tracking/definitions/trackingRecordRef" } }, "invoiceTo": { "type": "object", "x-internal": true, "title": "Record reference", "description": "Links the current record to the underlying record or data type that created it. \n\nFor example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. ", "properties": { "id": { "type": "string", "description": "'id' of the underlying record or data type." }, "dataType": { "type": "string", "description": "Allowed name of the 'dataType'.", "examples": [ "journalEntry", "invoice", "accountTransaction", "transfer" ] } } } }, "additionalProperties": false }, "invoiceTo": { "type": "object", "title": "Invoice to", "description": "Links to the customer the direct cost is associated.", "properties": { "id": { "type": "string", "description": "'id' of the underlying record or data type." }, "dataType": { "type": "string", "description": "Name of underlying data type.", "enum": [ "customers" ], "example": "customers" } } } } }, "DirectCosts": { "title": "Accounting: Direct costs", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/DirectCost" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "DirectIncome": { "title": "Accounting: Direct income", "description": "> **Language tip:** Direct incomes may also be referred to as **Receive transactions**, **Receive money transactions**, **Sales receipts**, or **Cash sales** in various accounting software.\n\n> View the coverage for direct incomes in the Data coverage explorer.\n\n## Overview\n\nDirect incomes are incomes received directly from the business' operations. For example, cash sales of items to a customer, referral commissions, and service fee refunds are considered direct incomes.\n\nDirect incomes include: \n\n- Selling an item directly to a contact, and receiving payment at the point of the sale.\n- Refunding an item in cash to a contact.\n- Depositing money into a bank account.\n\nDirect incomes is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).\n", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the direct income, unique for the company." }, "reference": { "type": "string", "nullable": true, "description": "User-friendly reference for the direct income." }, "note": { "type": "string", "nullable": true, "description": "An optional note on the direct income that can be used to assign the direct income with a reference ID in your application." }, "contactRef": { "$ref": "#/components/schemas/JournalEntry/definitions/journalLine/properties/contactRef", "description": "A customer or supplier associated with the direct income." }, "issueDate": { "$ref": "#/components/schemas/DateTime", "description": "The date of the direct income as recorded in the accounting software." }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "The currency of the direct income." }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "lineItems": { "type": "array", "description": "An array of line items.", "items": { "$ref": "#/components/schemas/DirectIncome/definitions/directIncomeLineItem" } }, "paymentAllocations": { "type": "array", "items": { "$ref": "#/components/schemas/DirectCost/definitions/directCostPrototype/properties/paymentAllocations/items" } }, "subTotal": { "type": "number", "format": "decimal", "description": "The total amount of the direct incomes, excluding any taxes." }, "taxAmount": { "type": "number", "format": "decimal", "description": "The total amount of tax on the direct incomes." }, "totalAmount": { "type": "number", "format": "decimal", "description": "The amount of the direct incomes, inclusive of tax." }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "required": [ "issueDate", "currency", "lineItems", "paymentAllocations", "subTotal", "taxAmount", "totalAmount" ], "definitions": { "directIncomeLineItem": { "type": "object", "properties": { "description": { "type": "string", "nullable": true, "description": "A user-friendly name of the goods or services." }, "unitAmount": { "type": "number", "format": "decimal", "description": "The price of each unit of goods or services.\nNote: If the platform does not provide this information, the unit amount will be mapped to the total amount." }, "quantity": { "type": "number", "format": "decimal", "description": "The number of units of goods or services received.\n\nNote: If the platform does not provide this information, the quantity will be mapped as 1." }, "discountAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Discount amount for the line before tax." }, "discountPercentage": { "type": "number", "format": "decimal", "nullable": true, "description": "Discount percentage for the line before tax." }, "subTotal": { "type": "number", "format": "decimal", "nullable": true, "description": "The amount of the line, inclusive of discounts, but exclusive of tax." }, "taxAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "The amount of tax for the line.\nNote: If the platform does not provide this information, the quantity will be mapped as 0.00." }, "totalAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "The total amount of the line, including tax." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "Reference to the account to which the line item is linked." }, "taxRateRef": { "$ref": "#/components/schemas/TaxRate/definitions/taxRateRef", "description": "Reference to the tax rate to which the line item is linked." }, "itemRef": { "$ref": "#/components/schemas/Item/definitions/itemRef", "description": "Reference to the product, service type, or inventory item to which the direct cost is linked." }, "trackingCategoryRefs": { "type": "array", "nullable": true, "description": "An array of categories against which this direct cost is tracked.", "items": { "$ref": "#/components/schemas/TrackingCategory/definitions/trackingCategoryRef" } } }, "required": [ "unitAmount", "quantity" ] } } }, "DirectIncomes": { "title": "Accounting: Direct incomes", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/DirectIncome" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "ErrorMessage": { "title": "Error message", "type": "object", "x-internal": true, "properties": { "statusCode": { "type": "integer", "description": "The HTTP status code returned by the error." }, "service": { "type": "string", "description": "Codat's service the returned the error." }, "error": { "type": "string", "description": "A brief description of the error." }, "correlationId": { "type": "string", "description": "Unique identifier used to propagate to all downstream services and determine the source of the error." }, "validation": { "$ref": "#/components/schemas/ErrorMessage/definitions/errorValidation" }, "canBeRetried": { "type": "string", "description": "`True` if the error occurred transiently and can be retried." }, "detailedErrorCode": { "type": "integer", "description": "Machine readable error code used to automate processes based on the code returned." } }, "definitions": { "errorValidation": { "title": "Validation error", "type": "object", "nullable": true, "description": "A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.", "properties": { "errors": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ErrorMessage/definitions/errorValidationItem" } }, "warnings": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ErrorMessage/definitions/errorValidationItem" } } } }, "errorValidationItem": { "title": "Validation error item", "type": "object", "properties": { "itemId": { "type": "string", "nullable": true, "description": "Unique identifier for a validation item." }, "message": { "type": "string", "nullable": true, "description": "A message outlining validation item's issue." }, "validatorName": { "type": "string", "nullable": true, "description": "Name of validator." } } } } }, "Invoice": { "title": "Accounting: Invoice", "description": "> **Invoices or bills?**\n>\n> We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company issued an invoice, and is owed money (accounts receivable) we call this an Invoice.\n>\n> See [Bills](https://docs.codat.io/accounting-api#/schemas/Bill) for the accounts payable equivalent of bills.\n\nView the coverage for invoices in the Data coverage explorer.\n\n## Overview\n\nAn invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/accounting-api#/schemas/Customer).\n\nIn Codat, an invoice contains details of:\n\n- The timeline of the invoice—when it was raised, marked as paid, last edited, and so on.\n- How much the invoice is for, what portion of the invoice is tax or discounts, and what currency the amounts are represented in. \n- Who the invoice has been raised to; the _customer_.\n- The breakdown of what the invoice is for; the _line items_.\n- Any [payments](https://docs.codat.io/accounting-api#/schemas/Payment) assigned to the invoice; the _payment allocations_.\n\n> **Invoice PDF downloads** \n>\n> You can download a PDF version of an invoice for supported integrations.\n> \n> The filename will be invoice-{number}.pdf.\n\n> **Referencing an invoice in Sage 50 and ClearBooks**\n>\n> In Sage 50 and ClearBooks, you may prefer to use the **invoiceNumber** to identify an invoice rather than the invoice **id**. Each time a draft invoice is submitted or printed, the draft **id** becomes void and a submitted invoice with a new **id** exists in its place. In both platforms, the **invoiceNumber** should remain the same.", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the invoice, unique to the company in the accounting software." }, "invoiceNumber": { "type": "string", "nullable": true, "description": "Friendly reference for the invoice. If available, this appears in the file name of invoice attachments." }, "customerRef": { "$ref": "#/components/schemas/Customer/definitions/accountingCustomerRef", "description": "Reference to the customer the invoice has been issued to." }, "salesOrderRefs": { "type": "array", "nullable": true, "description": "List of references to related Sales orders.", "items": { "$ref": "#/components/schemas/SalesOrder/definitions/salesOrderRef" } }, "issueDate": { "$ref": "#/components/schemas/DateTime", "description": "Date of the invoice as recorded in the accounting system." }, "dueDate": { "$ref": "#/components/schemas/DateTime", "description": "Date the customer is due to be paid by." }, "paidOnDate": { "$ref": "#/components/schemas/DateTime", "description": "Date the invoice was marked as paid in the accounting system. If this field is not available from the accounting software, it is calculated by Codat using associated payments." }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "Currency of the invoice." }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "lineItems": { "type": "array", "nullable": true, "description": "An array of line items.", "items": { "$ref": "#/components/schemas/Invoice/definitions/invoiceLineItem" } }, "paymentAllocations": { "type": "array", "nullable": true, "description": "An array of payment allocations.", "items": { "$ref": "#/components/schemas/DirectCost/definitions/directCostPrototype/properties/paymentAllocations/items" } }, "withholdingTax": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/Bill/allOf/0/properties/withholdingTax/items" } }, "totalDiscount": { "type": "number", "format": "decimal", "nullable": true, "description": "Numerical value of discounts applied to the invoice." }, "subTotal": { "type": "number", "format": "decimal", "nullable": true, "description": "Total amount of the invoice excluding any taxes." }, "additionalTaxAmount": { "type": "number", "format": "decimal", "description": "Additional tax amount applied to invoice." }, "additionalTaxPercentage": { "type": "number", "format": "decimal", "description": "Percentage rate of any additional tax applied to the invoice." }, "totalTaxAmount": { "type": "number", "format": "decimal", "description": "Amount of tax on the invoice." }, "totalAmount": { "type": "number", "format": "decimal", "description": "Amount of the invoice, inclusive of tax." }, "amountDue": { "type": "number", "format": "decimal", "description": "Amount outstanding on the invoice." }, "discountPercentage": { "type": "number", "format": "decimal", "nullable": true, "description": "Percentage rate (from 0 to 100) of discounts applied to the invoice. For example: A 5% discount will return a value of `5`, not `0.05`." }, "status": { "$ref": "#/components/schemas/Invoice/definitions/invoiceStatus" }, "note": { "type": "string", "nullable": true, "description": "Any additional information about the invoice. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when an invoice is emailed from the accounting software to the customer." }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "required": [ "issueDate", "totalTaxAmount", "totalAmount", "amountDue", "status" ], "definitions": { "invoiceLineItem": { "type": "object", "properties": { "description": { "type": "string", "nullable": true, "description": "Friendly name of the goods or services provided." }, "unitAmount": { "type": "number", "format": "decimal", "description": "Price of each unit of goods or services." }, "quantity": { "type": "number", "format": "decimal", "description": "Number of units of goods or services provided." }, "discountAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Numerical value of any discounts applied." }, "subTotal": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount of the line, inclusive of discounts but exclusive of tax." }, "taxAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount of tax for the line." }, "totalAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Total amount of the line, including tax. When pushing invoices to Xero, the total amount is exclusive of tax to allow automatic calculations if a tax rate or tax amount is not specified." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "Reference to the account to which the line item is linked." }, "discountPercentage": { "type": "number", "format": "decimal", "nullable": true, "description": "Percentage rate (from 0 to 100) of any discounts applied to the unit amount." }, "taxRateRef": { "$ref": "#/components/schemas/TaxRate/definitions/taxRateRef", "description": "Reference to the tax rate to which the line item is linked." }, "itemRef": { "$ref": "#/components/schemas/Item/definitions/itemRef", "description": "Reference to the item the line is linked to." }, "trackingCategoryRefs": { "type": "array", "nullable": true, "description": "Reference to the tracking categories to which the line item is linked.", "items": { "$ref": "#/components/schemas/TrackingCategory/definitions/trackingCategoryRef" } }, "tracking": { "$ref": "#/components/schemas/CreditNote/definitions/creditNoteLineItem/properties/tracking" }, "isDirectIncome": { "type": "boolean", "description": "The invoice is a direct income if `True`." } }, "required": [ "unitAmount", "quantity" ] }, "invoiceStatus": { "type": "string", "enum": [ "Unknown", "Draft", "Submitted", "PartiallyPaid", "Paid", "Void" ], "description": "Current state of the invoice:\n\n- `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email.\n- `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it (amountDue == totalAmount).\n- `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount (0 < amountDue < totalAmount).\n- `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid (amountDue == 0).\n- `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account." } } }, "Invoices": { "title": "Accounting: Invoices", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "Item": { "title": "Accounting: Item", "description": "> View the coverage for items in the Data coverage explorer.\n\n## Overview\n\n**Items** allow your customers to save and track details of the products and services that they buy and sell.\n", "type": "object", "allOf": [ { "properties": { "id": { "type": "string", "description": "Identifier for the item that is unique to a company in the accounting software." } } }, { "$ref": "#/components/schemas/Item/definitions/itemPrototype" }, { "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "required": [ "itemStatus", "type", "isBillItem", "isInvoiceItem" ], "definitions": { "itemPrototype": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "Name of the item in the accounting software." }, "code": { "type": "string", "nullable": true, "description": "Friendly reference for the item." }, "itemStatus": { "$ref": "#/components/schemas/Item/definitions/itemStatus" }, "type": { "$ref": "#/components/schemas/Item/definitions/itemType" }, "isBillItem": { "type": "boolean", "description": "Whether you can use this item for bills." }, "billItem": { "$ref": "#/components/schemas/Item/definitions/billItem" }, "isInvoiceItem": { "type": "boolean", "description": "Whether you can use this item for invoices." }, "invoiceItem": { "$ref": "#/components/schemas/Item/definitions/invoiceItem" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, "itemRef": { "title": "Item reference", "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Unique identifier for the item in the accounting software." }, "name": { "type": "string", "nullable": true, "description": "Name of the item in the accounting software." } }, "required": [ "id" ] }, "itemStatus": { "title": "Item status", "type": "string", "enum": [ "Unknown", "Active", "Archived" ], "description": "Current state of the item, either:\n\n- `Active`: Available for use\n- `Archived`: Unavailable\n- `Unknown`\n\nDue to a [limitation in Xero's API](https://docs.codat.io/integrations/accounting/xero/xero-faq#why-do-all-of-my-items-from-xero-have-their-status-as-unknown), all items from Xero are mapped as `Unknown`." }, "itemType": { "title": "Item type", "type": "string", "description": "Type of the item.", "enum": [ "Unknown", "Inventory", "NonInventory", "Service" ] }, "billItem": { "title": "Bill item", "type": "object", "description": "Item details that are only for bills.", "properties": { "description": { "type": "string", "nullable": true, "description": "Short description of the product or service that has been bought by the customer." }, "unitPrice": { "type": "number", "format": "decimal", "nullable": true, "description": "Unit price of the product or service." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "Reference of the account to which the item is linked." }, "taxRateRef": { "$ref": "#/components/schemas/TaxRate/definitions/taxRateRef", "description": "Reference of the tax rate to which the item is linked." } } }, "invoiceItem": { "title": "Invoice item", "type": "object", "description": "Item details that are only for bills.", "properties": { "description": { "type": "string", "nullable": true, "description": "Short description of the product or service that has been bought by the customer." }, "unitPrice": { "type": "number", "format": "decimal", "nullable": true, "description": "Unit price of the product or service." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "Reference of the account to which the item is linked." }, "taxRateRef": { "$ref": "#/components/schemas/TaxRate/definitions/taxRateRef" } } } } }, "ItemReceipt": { "title": "Item Receipt", "description": "An item receipt records the receipt of items into a SMBs inventory. It links to a [purchase order](https://docs.codat.io/codat-api#/schemas/AccountingPurchaseOrder) and acts as an acknowledgement of items received.\n\n> **Language tip:** Item receipts may also be referred to as **Purchase receipt**, or **PO receiver inventory** in various accounting software.\n\nADD SOMETHING ABOUT USAGE. E.g. a use case. or an example situation of where it can be used. ", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the item receipt, unique for the company in the accounting software." }, "supplierRef": { "$ref": "#/components/schemas/Supplier/definitions/supplierRef" }, "purchaseOrderRefs": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/PurchaseOrder/definitions/purchaseOrderRef" } }, "status": { "$ref": "#/components/schemas/ItemReceipt/definitions/itemReceiptStatus" }, "note": { "type": "string", "nullable": true, "description": "Any private, company notes about the item receipt, such as payment information." }, "reference": { "type": "string", "nullable": true, "description": "User-friendly reference for the item receipt." }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency" }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "receivedDate": { "allOf": [ { "description": "Date the items was received and was recorded in the platform." }, { "$ref": "#/components/schemas/DateTime" } ] }, "lineItems": { "type": "array", "nullable": true, "description": "Array of Item Receipt line items.", "items": { "$ref": "#/components/schemas/ItemReceipt/definitions/itemReceiptLineItem" } }, "subTotal": { "type": "number", "format": "decimal", "description": "Total amount of the item receipt, excluding any taxes." }, "totalAmount": { "type": "number", "format": "decimal", "description": "Amount of the item receipt, including tax." }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "itemReceiptStatus": { "description": "Current status of the item receipt.", "type": "string", "enum": [ "Unknown", "Draft", "Received", "Rejected", "Void" ] }, "itemReceiptLineItem": { "title": "Item receipt line item", "type": "object", "properties": { "lineNumber": { "type": "string", "nullable": true, "description": "The item receipt line's number." }, "description": { "type": "string", "nullable": true, "description": "Friendly name of the item or services received." }, "unitAmount": { "type": "number", "format": "decimal", "description": "Price of each unit of item or services." }, "quantity": { "type": "number", "format": "decimal", "description": "Number of units of item or services received." }, "unitOfMeasurement": { "type": "string", "nullable": true, "description": "The measurement which defines a unit for this item (e.g. 'kilogram', 'litre')." }, "subTotal": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount of the line, inclusive of discounts but exclusive of tax." }, "totalAmount": { "type": "number", "format": "decimal", "nullable": true, "description": "Total amount of the line, including tax." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "Reference to the account to which the line item is linked." }, "itemRef": { "$ref": "#/components/schemas/Item/definitions/itemRef", "description": "Reference to the product, service type, or inventory item to which the line item is linked." }, "purchaseOrderLineRef": { "allOf": [ { "type": "object", "x-internal": true, "title": "Record line reference", "description": "Links the current record line to the underlying record line that created it. \n\nFor example, if a bill is generated from a purchase order, this property allows you to connect the bill line item to the purchase order line item in our data model. ", "properties": { "id": { "type": "string", "description": "'id' of the underlying record." }, "dataType": { "type": "string", "description": "Allowed name of the 'dataType'.", "enum": [ "purchaseOrders", "bills" ] }, "lineNumber": { "type": "string", "description": "Line number of the underlying record." } } }, { "description": "Reference to the item receipt line this line was generated from." } ] }, "tracking": { "title": "Tracking", "type": "object", "properties": { "recordRefs": { "type": "array", "items": { "$ref": "#/components/schemas/ItemReceipt/definitions/itemReceiptLineItem/properties/tracking/definitions/trackingRecordRef" }, "nullable": true } }, "definitions": { "trackingRecordRef": { "type": "object", "title": "Record reference", "description": "Links to the customer or tracking category.", "properties": { "id": { "type": "string", "description": "'id' of the underlying record or data type." }, "dataType": { "type": "string", "description": "Name of underlying data type.", "enum": [ "customers", "suppliers", "trackingCategories" ], "example": "trackingCategories" } } } } } } } } }, "ItemReceipts": { "title": "Item receipts", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ItemReceipt" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "Items": { "title": "Accounting: Items", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "Journal": { "title": "Accounting: Journal", "description": "> **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) data type\n\n> View the coverage for journals in the Data coverage explorer.\n\n## Overview\n\nIn accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/accounting-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business.\n\nWhen a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries.\n\nSuch journals can be divided into two categories:\n\n- Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal.\n- General journals: journals used to record transactions that fall outside the scope of the special journals.\n\nMultiple journals or subjournals are used in the following Codat integrations:\n\n- [Sage Intacct](https://docs.codat.io/integrations/accounting/sage-intacct/accounting-sage-intacct) (mandatory)\n- [Exact Online](https://docs.codat.io/integrations/accounting/exact-online/accounting-exact-online) (mandatory)\n- [Oracle NetSuite](https://docs.codat.io/integrations/accounting/netsuite/accounting-netsuite) (optional)\n\n> When pushing journal entries to an accounting software that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object.\n", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Journal ID." } } }, { "$ref": "#/components/schemas/Journal/definitions/journalPrototype" }, { "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "journalPrototype": { "type": "object", "properties": { "journalCode": { "type": "string", "nullable": true, "description": "Native journal number or code." }, "name": { "type": "string", "nullable": true, "description": "Journal name.\nThe maximum length for a journal name is 256 characters. All characters above that number will be truncated." }, "type": { "type": "string", "nullable": true, "description": "The type of the journal." }, "parentId": { "type": "string", "nullable": true, "description": "Parent journal ID.\nIf the journal is a parent journal, this value is not present." }, "hasChildren": { "type": "boolean", "description": "If the journal has child journals, this value is true. If it doesn’t, it is false." }, "createdOn": { "$ref": "#/components/schemas/DateTime", "description": "Journal creation date." }, "status": { "$ref": "#/components/schemas/Journal/definitions/journalStatus" } } }, "journalRef": { "title": "Journal reference", "type": "object", "additionalProperties": false, "description": "Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals).", "properties": { "id": { "minLength": 1, "type": "string", "description": "GUID of the underlying journal." }, "name": { "type": "string", "maxLength": 256, "nullable": true, "description": "Name of journal" } }, "required": [ "id" ] }, "journalStatus": { "type": "string", "description": "Current journal status.", "enum": [ "Unknown", "Active", "Archived" ] } } }, "JournalEntries": { "title": "Accounting: Journal entries", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntry" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "JournalEntry": { "title": "Accounting: Journal entry", "description": "> **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/accounting-api#/schemas/Journal) data type\n\n> View the coverage for journal entries in the Data coverage explorer.\n\n## Overview\n\nA journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/accounting-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance.\n\nA journal entry line item is a single transaction line on the journal entry. For example: \n\n- When a journal entry is recording a receipt of cash, the credit to accounts receivable and the debit to cash are separate line items. \n- When a company needs to recognise revenue from an annual contract on a monthly basis, on receipt of cash for month one, they make a debit to deferred income and a credit to revenue.\n\nIn Codat a journal entry contains details of:\n\n- The date on which the entry was created and posted.\n- Itemised lines, including amounts and currency.\n- A reference to the associated accounts.\n- A reference to the underlying record. For example, the invoice, bill, or other data type that triggered the posting of the journal entry to the general ledger. \n\n> **Pushing journal entries** \n> Codat only supports journal entries in the base currency of the company that are pushed into accounts denominated in the same base currency.", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the journal entry for the company in the accounting software." }, "description": { "type": "string", "nullable": true, "description": "Optional description of the journal entry." }, "postedOn": { "$ref": "#/components/schemas/DateTime", "description": "Date on which the journal entry was posted to the accounting software, and had an impact on the general ledger. This may be different from the creation date.\n\nFor example, a user creates a journal entry on Monday and saves it as draft, which has no impact on the general ledger. On Thursday, they return to the entry and post it.\n\nThe **createdOn** date shows as Monday.\nThe **postedOn** date shows as Thursday.\nJournal entries can also be backdated, so the **postedOn** date may be earlier than the **createdOn** date." }, "createdOn": { "$ref": "#/components/schemas/DateTime", "description": "Date on which the journal was created in the accounting software." }, "updatedOn": { "$ref": "#/components/schemas/DateTime", "description": "Date on which the journal was last updated in the accounting software." }, "journalRef": { "$ref": "#/components/schemas/Journal/definitions/journalRef" }, "journalLines": { "type": "array", "nullable": true, "description": "An array of journal lines.", "items": { "$ref": "#/components/schemas/JournalEntry/definitions/journalLine" } }, "recordRef": { "$ref": "#/components/schemas/JournalEntry/definitions/journalEntryRecordRef" }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "journalLine": { "type": "object", "properties": { "description": { "type": "string", "nullable": true, "description": "Description of the journal line item." }, "netAmount": { "type": "number", "format": "decimal", "description": "Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative." }, "currency": { "type": "string", "nullable": true, "description": "Currency for the journal line item." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef" }, "tracking": { "$ref": "#/components/schemas/ItemReceipt/definitions/itemReceiptLineItem/properties/tracking", "description": "List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.)" }, "contactRef": { "title": "Contact reference", "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Unique identifier for a customer or supplier." }, "dataType": { "type": "string", "nullable": true, "description": "Allowed name of the 'dataType'.", "enum": [ "customers", "suppliers" ] } }, "required": [ "id" ] } }, "required": [ "netAmount" ] }, "journalEntryRecordRef": { "type": "object", "title": "Record reference", "description": "Links a journal entry to the underlying record that created it.", "properties": { "id": { "type": "string", "description": "'id' of the underlying record or data type." }, "dataType": { "type": "string", "description": "Name of underlying data type.", "enum": [ "bankTransactions", "billCreditNotes", "billPayments", "bills", "creditNotes", "directCosts", "directIncomes", "invoices", "journalEntries", "payments", "transfers" ], "example": "transfers" } } } } }, "Journals": { "title": "Accounting: Journals", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Journal" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "Metadata": { "title": "Metadata", "type": "object", "x-internal": true, "properties": { "isDeleted": { "type": "boolean", "description": "Indicates whether the record has been deleted in the third-party system this record originated from.", "nullable": true } } }, "ModifiedDates": { "title": "Modified dates", "x-internal": true, "allOf": [ { "title": "ModifiedDate", "x-internal": true, "type": "object", "properties": { "modifiedDate": { "allOf": [ { "$ref": "#/components/schemas/DateTime" }, { "description": "The date when the record was last fetched from the data source and updated in Codat’s data cache. \n\nUse it to identify and retrieve records that have changed since your last fetch. For example, filtering `modifiedDate` to today will provide new records updated in Codat today.\n\nThis date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports ([read more](https://docs.codat.io/using-the-api/modified-dates#modified-date)).\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." } ] } } }, { "title": "Source Modified Date", "x-internal": true, "type": "object", "nullable": true, "properties": { "sourceModifiedDate": { "allOf": [ { "$ref": "#/components/schemas/DateTime" }, { "description": "The date when a record was last modified in the source platform, usually by the business or a business process. For example, when payments are made against an invoice. \n\nIt is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when:\n - Pulling attachments\n - The integration platform does not provide modification dates for a data type\n - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred\n - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." } ] } } } ] }, "PagingInfo": { "type": "object", "title": "Pagination information", "x-internal": true, "properties": { "pageNumber": { "type": "integer", "description": "Current page number." }, "pageSize": { "type": "integer", "description": "Number of items to return in results array.", "maximum": 2000 }, "totalResults": { "type": "integer", "description": "Total number of items." }, "_links": { "$ref": "#/components/schemas/PagingInfo/definitions/links" } }, "definitions": { "links": { "title": "Hal Links", "type": "object", "required": [ "self", "current" ], "properties": { "self": { "$ref": "#/components/schemas/PagingInfo/definitions/halRef" }, "current": { "$ref": "#/components/schemas/PagingInfo/definitions/halRef" }, "next": { "$ref": "#/components/schemas/PagingInfo/definitions/halRef" }, "previous": { "$ref": "#/components/schemas/PagingInfo/definitions/halRef" } }, "examples": [ { "self": { "href": "/companies" }, "current": { "href": "/companies?page=1&pageSize=10" } } ] }, "halRef": { "title": "Hypertext reference", "type": "object", "properties": { "href": { "type": "string", "format": "uri-reference", "description": "Uri hypertext reference." } } } }, "required": [ "pageNumber", "pageSize", "totalResults", "_links" ], "examples": [ { "pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": { "self": { "href": "/companies/{id}/data/{dataType}" }, "current": { "href": "/companies/{id}/data/{dataType}?page=1&pageSize=10" } } } ] }, "Payment": { "title": "Accounting: Payment", "description": "> **Payments or bill payments?**\n>\n> In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/accounting-api#/schemas/Bill) and credit notes against bills.\n\n> View the coverage for payments in the Data coverage explorer.\n\n## Overview\n\nPayments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote).\n\nA payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to:\n\n- A payment made against an invoice, like a credit card, cheque, or cash payment.\n- An allocation of a customer's credit note, either to an invoice or maybe a refund.\n- A payment made directly to that accounts receivable account. This might be an overpayment or a prepayment. It might also be the refund of a payment made directly to an accounts receivable account.\n\nDepending on the payments allowed by the underlying accounting software, some payment types may be combined. Please see the example for more details.\n\nIn Codat, a payment contains details of:\n\n- When the payment was recorded in the accounting system.\n- How much it is for and in what currency that amount is in.\n- Who the payment was _paid by_ – the _customer_.\n- The payment method used.\n- The breakdown of the types of payments – the _line items_.\n\nPayments is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).\n\n## Payment types\n\n## Payment of an invoice\n\nA payment paying a single invoice has one entry in its `lines` array. This **line** has the following properties:\n\n- An _amount_ that indicates the amount of the invoice that was paid. This is always positive.\n- A **links** array containing one element with the following properties:\n - A **type** that indicates the type of **link**, in this case an `Invoice`.\n - An **id** that contains the ID of the invoice that was paid.\n - An **amount** for the link. The sum of the **line.amount** and the **links.amount** must equal `0`.\n\nThe **amount** field on the **line** equals the **totalAmount** on the payment.\n\n## Payment of multiple invoices\n\nA single payment can pay multiple invoices. This can be represented in one of two formats depending on how the customer keeps their books:\n\n- The payment has multiple entries in its **lines** array, one for each invoice that is paid. Each line follows the example and rules described in [Payment of an invoice](#payment-of-an-invoice).\n- The payment has a line with multiple links to each invoice. This occurs when the proportion of the original payment allocated to each invoice is not available.\n\nEach **line** has the same properties as those described in [Payment of an invoice](#payment-of-an-invoice), with the **amount** indicating how much of the payment was allocated to the invoice. The sum of line amounts equals the **totalAmount** on the payment.\n\n## Payments and refunds on account\n\nA payment on account, that is a payment that doesn’t pay a specific invoice, has one entry in its lines array. The **line** has the following properties:\n\n- A **totalAmount** that indicates the amount paid by a customer or refunded to them by a company. A payment to the customer is always negative. A refund is always positive.\n- A **links** array containing one element with the following properties:\n- A **type** that indicates the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`.\n- The **id** containing the ID of the customer.\n- The **amount** for the link is `0` – the **totalAmount** _or_ the amount of the payment or refund.\n\nIt is possible to have a payment that is part _on account_ and part _allocated_ to an invoice. Each line should follow the examples above.\n\n## Using a credit note to pay an invoice\n\nThe payment of an invoice using a credit note has one entry in its **lines** array. This **line** has the following properties:\n\n- An **amount** that indicates the amount of money moved, which in this case is `0`, as the credit note and invoice allocation must balance each other.\n- A **links** array containing two elements:\n - The first **link** has:\n - A **type** that indicates the type of **link**, in this case an `Invoice`.\n - An **id** that contains the ID of the invoice that was paid.\n - The second **link** has:\n - A **type** that indicates the type of **link**, in this case a `CreditNote`.\n - An **id** that contains the ID of the credit note used by this payment.\n\nThe **amount** field on the **line** equals the **totalAmount** on the payment.\n\n## Refunding a credit note\n\nA payment refunding a credit note has one entry in its **lines** array. This **line** has the following properties:\n\n- An **amount** that indicates the amount of the credit note that was refunded. This is always negative for a refund.\n- A **links** array that contains one element with the following properties:\n - A **type** that indicates the type of **link**, in this case a `CreditNote`.\n - An **id** that contains the ID of the credit note that was refunded.\n\nThe **totalAmount** field on the payment equals the **amount** field of the **line**. These are both negative, as this is money leaving accounts receivable.\n\n## Refunding a payment\n\nIf a payment is refunded, for example, if a customer overpaid an invoice and the overpayment is returned to the customer, there are two payment records:\n\n- One for the incoming over payment.\n- Another for the outgoing refund.\n\nThe payment issuing the refund has a negative **totalAmount**. This payment also has one entry in its lines array with the following properties:\n\n- An **amount** that indicates the amount that was refunded. This is always negative.\n- A **links** array that contains one element with the following properties:\n - A **type** that indicates the type of **link**, in this case a `Payment`.\n - An **id** that contains the ID of the payment that was refunded.\n\nThe **amount** field on the **line** equals the **totalAmount** on the payment and is negative, as this is money leaving accounts receivable.\n\nThe payment that was refunded has a line where the **amount** is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was used to partly pay an invoice.\n\nFor example: A £1,050 payment on a £1,000 invoice with a refund of £50 has two lines:\n\n- One for £1,000 linked to the invoice that was paid.\n- Another for £50 linked to the payment that refunded the overpayment with a** type** of `Refund` and an ID that corresponds to the payment.\n\nThe **line** linked to the payment has the following properties:\n\n- An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund.\n- A **links** array containing one element with the following properties:\n - A **type** that indicates the type of **link**, in this case a `Refund`.\n - An **id** that contains the ID of the payment that refunded this line.\n\n> **Support for linked payments**\n>\n> Not all accounting software support linking payments in this way. In some platforms, you may see a payment on account and a refund on account.\n\n## Foreign currencies\n\nThere are two types of currency rate that are included in the payments data type:\n\nPayment currency rate:\n\n- Base currency of the accounts receivable account.\n- Foreign currency of the payment.\n\nPayment line link currency rate:\n\n- Base currency of the item the link represents.\n- Foreign currency of the payment.\n\nThese two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either:\n\n- The base currency for the accounts receivable account.\n- The currency of the item.\n\n ```json title=\"Currency rate example\"\n {\n \"id\": \"123\",\n \"note\": \"\",\n \"totalAmount\": 99.99,\n \"currency\": \"GBP\",\n \"lines\": [\n {\n \"amount\": 99.99,\n \"links\": [\n {\n \"type\": \"Invoice\",\n \"id\": \"178\",\n \"amount\": -50,\n \"currencyRate\": 1.9998\n }\n ]\n }\n ]\n }\n ```\n\n\n\n## Example data\n\n> **Object properties**\n>\n> For the sake of brevity, the examples here may omit properties from objects. For the full object definition, see [Payments](https://api.codat.io/swagger/index.html#/Payments).\n\n## Simple examples\n\n ```json title=\"Payment for invoice\"\n {\n \"totalAmount\": 1000,\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Allocation of credit note\"\n {\n \"totalAmount\": 0,\n \"lines\": [\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Payment of invoice and payment on account\"\n {\n \"totalAmount\": 2000,\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"y\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Refund of credit note\"\n {\n \"totalAmount\": -1000,\n \"lines\": [\n {\n \"amount\" : -1000,\n \"links\" : [\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Refund on accounts receivable account\"\n {\n \"totalAmount\": -1000,\n \"lines\": [\n {\n \"amount\" : -1000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Linked refund on accounts receivable account\"\n {\n \"id\" : \"payment-001\",\n \"totalAmount\": 1000,\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Refund\",\n \"id\" : \"refund-001\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n {\n \"id\" : \"refund-001\",\n \"totalAmount\": -1000,\n \"lines\": [\n {\n \"amount\" : -1000,\n \"links\" : [\n {\n \"type\" : \"Payment\",\n \"id\" : \"payment-001\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Using a credit note and cash to pay an invoice\"\n {\n \"totalAmount\": 250,\n \"lines\": [\n {\n \"amount\": 0,\n \"links\": [\n {\n \"type\": \"Invoice\",\n \"id\": \"x\",\n \"amount\": -750\n }, \n {\n \"type\": \"CreditNote\",\n \"id\": \"y\",\n \"amount\": 750\n }\n ]\n },\n {\n \"amount\": 250,\n \"links\": [\n {\n \"type\": \"Invoice\",\n \"id\": \"x\",\n \"amount\": -250\n }\n ]\n }\n ]\n }\n ```\n\n\n\n## Complex examples\n\n ```json title=\"Use two credit notes and 1000 in to \"bank\" (cash, cheque etc.) to pay invoice\"\n {\n \"totalAmount\": 1000,\n \"lines\": [\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"z\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Pay an invoice with two credit notes and cash, with 1000 left 'on account'\"\n {\n \"totalAmount\": 2000,\n \"lines\": [\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"z\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"customer-001\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Two credit notes pay two invoices with no allocation amount specified\"\n {\n \"totalAmount\": 0,\n \"lines\": [\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"w\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"z\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash\"\n {\n \"totalAmount\": 2000,\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"w\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"Invoice\",\n \"id\" : \"u\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"z\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Refund\",\n \"id\" : \"refund-001\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n {\n \"id\" : \"refund-001\",\n \"totalAmount\": -1000,\n \"lines\": [\n {\n \"amount\" : -1000,\n \"links\" : [\n {\n \"type\" : \"Payment\",\n \"id\" : \"payment-001\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\nIn this example, a payment on account is used to pay the same invoice in January and again in February.\n\n ```json title=\"January\"\n {\n \"id\": \"001\",\n \"totalAmount\": 5000,\n \"date\" : \"1901-01-01\",\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"Invoice-x\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 4000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"PaymentOnAccount-y\",\n \"amount\" : -4000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"February\"\n {\n \"id\": \"001\",\n \"totalAmount\": 5000,\n \"date\" : \"1901-02-01\",\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"Invoice-x\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"Invoice-y\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 3000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"PaymentOnAccount-y\",\n \"amount\" : -3000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Two credit notes and some cash pay two invoices with no allocations specified\"\n {\n \"totalAmount\": 500,\n \"lines\": [\n {\n \"amount\": 500,\n \"links\": [{\n \"type\": \"Invoice\",\n \"id\": \"a\",\n \"amount\": -1000\n }, {\n \"type\": \"Invoice\",\n \"id\": \"b\",\n \"amount\": -1000\n }, {\n \"type\": \"CreditNote\",\n \"id\": \"y\",\n \"amount\": 750\n },{\n \"type\": \"CreditNote\",\n \"id\": \"z\",\n \"amount\": 750\n }\n ]\n }\n ]\n }\n ```", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the payment, unique to the company in the accounting software." }, "customerRef": { "$ref": "#/components/schemas/Customer/definitions/accountingCustomerRef", "description": "Customer the payment is recorded against in the accounting software." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "Account the payment is recorded against in the accounting software." }, "paymentMethodRef": { "$ref": "#/components/schemas/PaymentMethodRef", "description": "The Payment Method to which the payment is linked in the accounting software." }, "totalAmount": { "type": "number", "format": "decimal", "description": "Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account." }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "ISO currency code recorded for the payment in the accounting software." }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "date": { "$ref": "#/components/schemas/DateTime", "description": "Date the payment was recorded in the accounting software." }, "note": { "type": "string", "nullable": true, "description": "Any additional information associated with the payment." }, "lines": { "type": "array", "nullable": true, "description": "An array of payment lines.", "items": { "$ref": "#/components/schemas/Payment/definitions/paymentLine" } }, "reference": { "type": "string", "nullable": true, "description": "Friendly reference for the payment." }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "required": [ "date" ], "definitions": { "paymentLine": { "title": "Payment Line", "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "description": "Amount in the payment currency." }, "links": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/Payment/definitions/paymentLineLink" } }, "allocatedOnDate": { "$ref": "#/components/schemas/DateTime", "description": "The date the payment was allocated." } }, "required": [ "amount" ] }, "paymentLineLink": { "title": "Payment Line Link", "type": "object", "additionalProperties": false, "properties": { "type": { "$ref": "#/components/schemas/Payment/definitions/paymentLinkType" }, "id": { "type": "string", "description": "Unique identifier of the transaction represented by the link." }, "amount": { "type": "number", "format": "decimal", "nullable": true, "description": "Amount by which the balance of the linked entity is altered, in the currency of the linked entity. \nA negative link amount _reduces_ the outstanding amount on the accounts receivable account. \nA positive link amount _increases_ the outstanding amount on the accounts receivable account." }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" } }, "required": [ "type" ] }, "paymentLinkType": { "title": "Payment Link Type", "type": "string", "enum": [ "Unknown", "Unlinked", "Invoice", "CreditNote", "Other", "Refund", "Payment", "PaymentOnAccount", "ManualJournal", "Discount" ], "description": "Types of payment line links, either: \n`Unknown` \n`Unlinked` - Not used \n`Invoice` - ID refers to the invoice \n`CreditNote` - ID refers to the credit note \n`Refund` - ID refers to the sibling payment \n`Payment` - ID refers to the sibling payment \n`PaymentOnAccount` - ID refers to the customer \n`Other` - ID refers to the customer \n`Manual Journal` \n`Discount` - ID refers to the payment" } } }, "PaymentMethod": { "title": "Accounting: Payment method", "description": "> View the coverage for payment methods in the Data coverage explorer.\n\n## Overview\n\nA Payment Method represents the payment method(s) used to pay a Bill. Payment Methods are referenced on [Bill Payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) and [Payments](https://docs.codat.io/accounting-api#/schemas/Payment).", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the payment method." }, "name": { "type": "string", "nullable": true, "description": "Name of the payment method." }, "type": { "$ref": "#/components/schemas/PaymentMethod/definitions/paymentMethodType" }, "status": { "description": "Status of the Payment Method.", "x-internal": true, "type": "string", "enum": [ "Unknown", "Active", "Archived" ] }, "metadata": { "$ref": "#/components/schemas/Metadata" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "paymentMethodType": { "description": "Method of payment.", "type": "string", "enum": [ "Unknown", "Cash", "Check", "CreditCard", "DebitCard", "BankTransfer", "Other" ] } } }, "PaymentMethodRef": { "type": "object", "title": "Payment method reference", "description": "The payment method the record is linked to in the accounting or commerce software.", "properties": { "id": { "description": "The unique identifier of the location being referenced.", "type": "string" }, "name": { "description": "Name of the location being referenced.", "type": "string" } }, "required": [ "id" ], "example": { "id": "EILBDVJVNUAGVKRQ", "name": "AliPay" } }, "PaymentMethods": { "title": "Accounting: Payment methods", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "Payments": { "title": "Accounting: Payments", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "ProfitAndLossReport": { "title": "Accounting: Profit and loss report", "description": "> **Language tip:** Profit and loss statement is also referred to as **income statement** under US GAAP (Generally Accepted Accounting Principles).\n\n> View the coverage for profit and loss in the Data coverage explorer.\n\n## Overview\n\nThe purpose of a profit and loss report is to present the financial performance of a company over a specified time period.\n\nA profit and loss report shows a company's total income and expenses for a specified period of time and whether a profit or loss has been made.\n\n> **Profit and loss or balance sheet?** \n> Profit and loss reports summarise the total revenue, expenses, and profit or loss over a specified time period. A balance sheet report presents all assets, liability, and equity for a given date.\n\n\n**Structure of this report** \nThis report will reflect the structure and line descriptions that the business has set in their own accounting software.\n\n**History** \nBy default, Codat pulls (up to) 24 months of profit and loss history for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `profitAndLoss` on the [data type settings endpoint](https://docs.codat.io/codat-api#/operations/post-profile-syncSettings).\n\n**Want to pull this in a standardised structure?** \nOur [Enhanced Financials](https://docs.codat.io/lending/features/financial-statements-overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers.", "type": "object", "properties": { "reports": { "type": "array", "description": "An array of profit and loss reports.", "items": { "$ref": "#/components/schemas/ProfitAndLossReport/definitions/profitAndLossReport" } }, "reportBasis": { "$ref": "#/components/schemas/ProfitAndLossReport/definitions/reportBasis" }, "currency": { "minLength": 1, "type": "string", "description": "Base currency of the company in which the profit and loss report is presented." }, "mostRecentAvailableMonth": { "$ref": "#/components/schemas/DateTime", "description": "Most recent available monthly report data." }, "earliestAvailableMonth": { "$ref": "#/components/schemas/DateTime", "description": "Earliest available monthly report data." } }, "required": [ "reports", "reportBasis", "currency" ], "definitions": { "reportBasis": { "enum": [ "Unknown", "Accrual", "Cash" ], "type": "string", "description": "The basis of a report." }, "profitAndLossReport": { "type": "object", "additionalProperties": false, "properties": { "fromDate": { "$ref": "#/components/schemas/DateTime", "description": "Date from which the report data begins." }, "toDate": { "$ref": "#/components/schemas/DateTime", "description": "Date on which the report data ends." }, "income": { "$ref": "#/components/schemas/ReportLine", "description": "ReportLine items for income in the given date range." }, "costOfSales": { "$ref": "#/components/schemas/ReportLine", "description": "ReportLine items for cost of sales in the given date range." }, "grossProfit": { "type": "number", "format": "decimal", "description": "Gross profit of the company in the given date range." }, "expenses": { "$ref": "#/components/schemas/ReportLine", "description": "ReportLine items for expenses in the given date range." }, "netOperatingProfit": { "type": "number", "format": "decimal", "description": "Net operating profit of the company in the given date range." }, "otherExpenses": { "$ref": "#/components/schemas/ReportLine", "description": "ReportLine items for other expenses in the given date range." }, "otherIncome": { "$ref": "#/components/schemas/ReportLine", "description": "ReportLine items for other income in the given date range." }, "netOtherIncome": { "type": "number", "format": "decimal", "description": "Net other income of the company in the given date range." }, "netProfit": { "type": "number", "format": "decimal", "description": "Net profit of the company in the given date range." } }, "required": [ "grossProfit", "netOperatingProfit", "netOtherIncome", "netProfit" ] } } }, "ProjectRef": { "title": "Accounting: Project reference", "x-internal": true, "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Unique identifier to the project reference." }, "name": { "type": "string", "nullable": true, "description": "The project's name." } } }, "PurchaseOrder": { "title": "Accounting: Purchase order", "description": "> View the coverage for purchase orders in the Data coverage explorer.\n\n## Overview\n\nPurchase orders represent a business's intent to purchase goods or services from a supplier and normally include information such as expected delivery dates and shipping details. \n\nThis information can be used to provide visibility on a business's expected payables and to track a purchase through the full procurement process.", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the purchase order, unique for the company in the accounting software." }, "purchaseOrderNumber": { "type": "string", "nullable": true, "description": "Friendly reference for the purchase order, commonly generated by the accounting software." }, "issueDate": { "$ref": "#/components/schemas/DateTime", "description": "Date of the purchase order as recorded in the accounting software." }, "paymentDueDate": { "$ref": "#/components/schemas/DateTime", "nullable": true, "description": "Date the supplier is due to be paid." }, "expectedDeliveryDate": { "$ref": "#/components/schemas/DateTime", "nullable": true, "description": "Expected delivery date for any goods that have been ordered." }, "deliveryDate": { "$ref": "#/components/schemas/DateTime", "nullable": true, "description": "Actual delivery date for any goods that have been ordered." }, "note": { "type": "string", "nullable": true, "description": "Any additional information associated with the purchase order." }, "shipTo": { "$ref": "#/components/schemas/SalesOrder/allOf/0/properties/shipTo", "description": "Delivery details for any goods that have been ordered." }, "supplierRef": { "$ref": "#/components/schemas/Supplier/definitions/supplierRef", "description": "Supplier that the purchase order is recorded against in the accounting system." }, "status": { "$ref": "#/components/schemas/PurchaseOrder/definitions/purchaseOrderStatus" }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "Currency of the purchase order." }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "lineItems": { "type": "array", "nullable": true, "description": "Array of line items.", "items": { "$ref": "#/components/schemas/PurchaseOrder/definitions/purchaseOrderLineItem" } }, "totalDiscount": { "type": "number", "format": "decimal", "description": "Total value of any discounts applied to the purchase order." }, "subTotal": { "type": "number", "format": "decimal", "description": "Total amount of the purchase order, including discounts but excluding tax." }, "totalTaxAmount": { "type": "number", "format": "decimal", "description": "\t\nTotal amount of tax included in the purchase order." }, "totalAmount": { "type": "number", "format": "decimal", "description": "Total amount of the purchase order, including discounts and tax." }, "createdBy": { "description": "The user who created the purchase order in the accounting system", "title": "User", "type": "object", "properties": { "firstName": { "type": "string", "nullable": true, "description": "First name of the user." }, "lastName": { "type": "string", "nullable": true, "description": "Last name of the user." }, "email": { "type": "string", "nullable": true, "description": "Email address of the user." } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "purchaseOrderRef": { "title": "Purchase order Reference", "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Identifier for the purchase order, unique for the company in the accounting software." }, "purchaseOrderNumber": { "type": "string", "nullable": true, "description": "Friendly reference for the purchase order, commonly generated by the accounting software." } } }, "purchaseOrderLineItem": { "title": "Purchase order line item", "type": "object", "properties": { "lineNumber": { "type": "string", "nullable": true, "description": "The purchase order line's number." }, "description": { "type": "string", "nullable": true, "description": "Description of the goods / services that have been ordered." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "Reference to the account to which the line item is linked." }, "itemRef": { "$ref": "#/components/schemas/Item/definitions/itemRef", "description": "Reference to the product or inventory item to which the line item is linked." }, "trackingCategoryRefs": { "type": "array", "nullable": true, "description": "Reference to the tracking categories to which the line item is linked.", "items": { "$ref": "#/components/schemas/TrackingCategory/definitions/trackingCategoryRef" } }, "unitAmount": { "type": "number", "format": "decimal", "description": "Price of each unit." }, "quantity": { "type": "number", "format": "decimal", "description": "Number of units that have been ordered." }, "unitOfMeasurement": { "type": "string", "nullable": true, "description": "The measurement which defines a unit for this item (e.g. 'kilogram', 'litre')." }, "discountAmount": { "type": "number", "format": "decimal", "description": "Value of any discounts applied." }, "discountPercentage": { "type": "number", "format": "decimal", "description": "Percentage rate (from 0 to 100) of any discounts applied to the unit amount." }, "subTotal": { "type": "number", "format": "decimal", "description": "Amount of the line, inclusive of discounts but exclusive of tax." }, "taxAmount": { "type": "number", "format": "decimal", "description": "Amount of tax for the line." }, "taxRateRef": { "$ref": "#/components/schemas/TaxRate/definitions/taxRateRef", "description": "Reference to the tax rate to which the line item is linked." }, "totalAmount": { "type": "number", "format": "decimal", "description": "Total amount of the line, inclusive of discounts and tax." } } }, "purchaseOrderStatus": { "description": "Current state of the purchase order", "type": "string", "enum": [ "Unknown", "Draft", "Open", "Closed", "Void" ] } }, "examples": [ { "id": "7e2380af-b51f-4393-92d7-6ff0382da26c", "purchaseOrderNumber": "89443280", "issueDate": "2020-10-24T00:00:00Z", "deliveryDate": "2021-02-02T00:00:00Z", "expectedDeliveryDate": "2021-01-29T00:00:00Z", "paymentDueDate": "2021-09-13T00:00:00Z", "note": "purchaseorder with 1 line items, totalling 1138.5", "supplierRef": { "id": "7ff6add1-b0e7-496f-b655-48e20c8fdb2e", "supplierName": "Carlton Innovations" }, "shipTo": { "contact": { "name": "Carlton Innovations", "email": "sales@carltoninnov.com", "phone": "" }, "address": { "type": "Billing", "line1": "1 Carolyns Circle", "line2": "", "city": "Dallas", "region": "Texas", "country": "USA", "postalCode": "511210" } }, "status": "Closed", "currency": "GBP", "currencyRate": 1, "lineItems": [ { "description": "Electric Eye purchase", "accountRef": { "id": "13931cbf-ea06-4d6e-9538-a8457fa66011", "name": "Cost of Goods Sold" }, "itemRef": { "id": "9409d23d-1011-432e-98a4-591fcd8d5404", "name": "ACME Electric Eye" }, "trackingCategoryRefs": [], "unitAmount": 115, "quantity": 9, "discountAmount": 0, "discountPercentage": 0, "subTotal": 1035, "taxAmount": 103.5, "taxRateRef": { "id": "6c88aff3-7cb9-4980-a3d3-443e72e02498", "name": "ACME Sales Tax (10%)" }, "totalAmount": 1138.5 } ], "totalDiscount": 0, "subTotal": 1035, "totalTaxAmount": 103.5, "totalAmount": 1138.5, "createdBy": { "firstName": "John", "lastName": "Smith", "email": "john.smith@codat.io" }, "modifiedDate": "2020-11-17T21:11:20Z", "sourceModifiedDate": "2020-10-25T06:37:33Z" } ] }, "PurchaseOrders": { "title": "Accounting: Purchase orders", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrder" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "PushOperationSummary": { "title": "Push operation", "type": "object", "x-internal": true, "properties": { "changes": { "type": "array", "nullable": true, "description": "Contains a single entry that communicates which record has changed and the manner in which it changed. ", "items": { "$ref": "#/components/schemas/PushOperationSummary/definitions/pushOperationChange" } }, "dataType": { "$ref": "#/components/schemas/DataType", "description": "The type of data being pushed, eg invoices, customers." }, "companyId": { "$ref": "#/components/parameters/companyId/schema" }, "pushOperationKey": { "type": "string", "format": "uuid", "description": "A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted." }, "dataConnectionKey": { "$ref": "#/components/parameters/connectionId/schema" }, "requestedOnUtc": { "$ref": "#/components/schemas/DateTime", "description": "The datetime when the push was requested." }, "completedOnUtc": { "$ref": "#/components/schemas/DateTime", "description": "The datetime when the push was completed, null if Pending." }, "timeoutInMinutes": { "type": "integer", "format": "int32", "nullable": true, "description": "Number of minutes the push operation must complete within before it times out." }, "timeoutInSeconds": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true, "description": "Number of seconds the push operation must complete within before it times out." }, "status": { "$ref": "#/components/schemas/PushOperationSummary/definitions/pushOperationStatus" }, "errorMessage": { "type": "string", "nullable": true, "description": "A message about the error." }, "validation": { "$ref": "#/components/schemas/PushOperationSummary/definitions/validation" }, "statusCode": { "type": "integer", "description": "Push status code." } }, "required": [ "companyId", "pushOperationKey", "dataConnectionKey", "requestedOnUtc", "status", "statusCode" ], "definitions": { "validation": { "type": "object", "title": "Validation", "description": "A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.", "properties": { "errors": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/PushOperationSummary/definitions/validationItem" } }, "warnings": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/PushOperationSummary/definitions/validationItem" } } } }, "validationItem": { "title": "Validation item", "type": "object", "properties": { "itemId": { "type": "string", "nullable": true, "description": "Unique identifier for a validation item." }, "message": { "type": "string", "nullable": true, "description": "A message outlining validation item's issue." }, "validatorName": { "type": "string", "nullable": true, "description": "Name of validator." } }, "additionalProperties": false }, "pushChangeType": { "title": "Push change type", "description": "Type of change being applied to record in third party platform.", "type": "string", "enum": [ "Unknown", "Created", "Modified", "Deleted", "AttachmentUploaded" ] }, "pushOperationRef": { "title": "Push operation reference", "x-internal": true, "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for a push operation." }, "dataType": { "$ref": "#/components/schemas/DataType", "nullable": true } }, "additionalProperties": false }, "pushOperationStatus": { "title": "Push operation status", "type": "string", "enum": [ "Pending", "Failed", "Success", "TimedOut" ], "description": "The current status of the push operation." }, "pushOperationChange": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PushOperationSummary/definitions/pushChangeType" }, "recordRef": { "$ref": "#/components/schemas/PushOperationSummary/definitions/pushOperationRef" }, "attachmentId": { "type": "string", "description": "Unique identifier for the attachment created otherwise null.", "nullable": true } } } } }, "PushOption": { "title": "Push option", "x-internal": true, "required": [ "displayName", "required", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionType" }, "displayName": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/displayName" }, "description": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description" }, "required": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty" }, "nullable": true }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionChoice" }, "nullable": true }, "validation": { "$ref": "#/components/schemas/PushOption/definitions/pushValidationInfo", "nullable": true } }, "definitions": { "pushOptionProperty": { "title": "Push Option Property", "required": [ "description", "displayName", "required", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionType" }, "displayName": { "minLength": 1, "type": "string", "description": "The property's display name." }, "description": { "type": "string", "description": "A description of the property." }, "required": { "type": "boolean", "description": "The property is required if `True`." }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty" }, "nullable": true }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionChoice" }, "nullable": true }, "validation": { "$ref": "#/components/schemas/PushOption/definitions/pushValidationInfo" } } }, "pushValidationInfo": { "title": "Push validation info", "type": "object", "properties": { "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/PushOption/definitions/pushFieldValidation" }, "nullable": true }, "information": { "type": "array", "items": { "$ref": "#/components/schemas/PushOption/definitions/pushFieldValidation" }, "nullable": true } }, "additionalProperties": false }, "pushFieldValidation": { "title": "Push field validation", "required": [ "details" ], "type": "object", "properties": { "field": { "type": "string", "description": "Field name that resulted in the validation issue." }, "details": { "minLength": 1, "type": "string", "description": "Details on the validation issue." }, "ref": { "type": "string", "format": "uri", "nullable": true, "description": "Unique reference identifier for the validation issue." } }, "additionalProperties": false }, "pushOptionType": { "title": "Option Type", "description": "The option type.", "enum": [ "Array", "Object", "String", "Number", "Boolean", "DateTime", "File", "MultiPart" ], "type": "string" }, "pushOptionChoice": { "title": "Push Option Choice", "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "description": "Allowed value for field." }, "type": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionType" }, "displayName": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/displayName" }, "description": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description" }, "required": { "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required" } } } } }, "ReportLine": { "x-internal": true, "type": "object", "title": "Accounting: Report line", "properties": { "accountId": { "type": "string", "nullable": true, "description": "Identifier for the account, unique for the company in the accounting software." }, "name": { "type": "string", "nullable": true, "description": "Name of the report line item." }, "value": { "type": "number", "format": "decimal", "description": "Numerical value of the line item." }, "items": { "type": "array", "nullable": true, "description": "An array of ReportLine items.", "items": { "$ref": "#/components/schemas/ReportLine" } } }, "required": [ "value" ] }, "SalesOrder": { "title": "Accounting: Sales order", "description": "> View the coverage for sales orders in the Data coverage explorer.\n\n## Overview\n\nA sales order represents a customer's intention to purchase goods or services from a seller and usually includes information such as the expected delivery date and shipping details. This information can be used to provide visibility on a business's expected receivables and to track sales through the full procurement process.\n\nA sales order is typically converted to an [invoice](https://docs.codat.io/accounting-api#/schemas/Invoice) after approval.", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the sales order, unique for the company in the accounting software." }, "salesOrderNumber": { "type": "string", "nullable": true, "description": "Friendly reference for the sales order, commonly generated by the accounting software." }, "customerPurchaseOrderNumber": { "type": "string", "nullable": true, "description": "A customer-supplied identifier for the purchase order in the customer's system." }, "issueDate": { "$ref": "#/components/schemas/DateTime", "description": "Date of the sales order as recorded in the accounting software." }, "expectedDeliveryDate": { "$ref": "#/components/schemas/DateTime", "nullable": true, "description": "Expected delivery date for any goods that have been ordered." }, "note": { "type": "string", "nullable": true, "description": "Any additional information associated with the sales order." }, "shipTo": { "description": "Delivery details for any goods that have been ordered.", "title": "Ship to", "type": "object", "properties": { "contact": { "type": "object", "description": "Details of the named contact at the delivery address.", "properties": { "name": { "type": "string", "nullable": true, "description": "Name of the contact at the delivery address." }, "email": { "type": "string", "nullable": true, "description": "Email address of the contact at the delivery address." }, "phone": { "type": "string", "nullable": true, "description": "Phone number of the contact at the delivery address." } } }, "address": { "$ref": "#/components/schemas/CompanyDataset/properties/addresses/items", "description": "Delivery address for any goods that have been ordered." } } }, "customerRef": { "$ref": "#/components/schemas/Customer/definitions/accountingCustomerRef", "description": "The customer that the sales order is recorded against in the accounting system." }, "status": { "$ref": "#/components/schemas/SalesOrder/definitions/salesOrderStatus" }, "invoicingStatus": { "$ref": "#/components/schemas/SalesOrder/definitions/salesOrderInvoiceStatus" }, "currency": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount/properties/currency", "description": "Currency of the sales order." }, "currencyRate": { "$ref": "#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate" }, "lineItems": { "type": "array", "nullable": true, "description": "An array of line items.", "items": { "$ref": "#/components/schemas/SalesOrder/definitions/salesOrderLineItem" } }, "totalDiscount": { "type": "number", "format": "decimal", "description": "Total value of any discounts applied to the sales order." }, "subTotal": { "type": "number", "format": "decimal", "description": "Total amount of the sales order, including discounts but excluding tax." }, "totalTaxAmount": { "type": "number", "format": "decimal", "description": "Total amount of tax included in the sales order." }, "totalAmount": { "type": "number", "format": "decimal", "description": "Total amount of the sales order, including discounts and tax." }, "metadata": { "$ref": "#/components/schemas/Metadata" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "salesOrderRef": { "title": "Sales order reference", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier to a record in `dataType`." }, "dataType": { "type": "string", "description": "The underlying data type associated to the reference `id`.", "enum": [ "salesOrders" ] } } }, "salesOrderStatus": { "type": "string", "description": "Current state of the sales order.", "enum": [ "Unknown", "Draft", "Open", "Closed", "Void" ] }, "salesOrderInvoiceStatus": { "title": "Sales order invoice status", "description": "If the sales order is converted to an invoice, or will be in future, the invoicingStatus field indicates the current stage of the invoicing process.", "type": "string", "enum": [ "Unknown", "PartiallyInvoiced", "Invoiced", "NotInvoiced" ] }, "salesOrderLineItem": { "title": "Invoice line item", "type": "object", "properties": { "description": { "type": "string", "nullable": true, "description": "Description of the goods or services that have been ordered." }, "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "Reference to the account to which the line item is linked." }, "itemRef": { "$ref": "#/components/schemas/Item/definitions/itemRef", "description": "Reference to the product or inventory item to which the line item is linked." }, "tracking": { "$ref": "#/components/schemas/ItemReceipt/definitions/itemReceiptLineItem/properties/tracking" }, "unitAmount": { "type": "number", "format": "decimal", "description": "Price of each unit." }, "quantity": { "type": "number", "format": "decimal", "description": "Number of units that have been ordered." }, "discountAmount": { "type": "number", "format": "decimal", "description": "Value of any discounts applied." }, "discountPercentage": { "type": "number", "format": "decimal", "description": "Percentage rate (from 0 to 100) of any discounts applied to the unit amount." }, "subTotal": { "type": "number", "format": "decimal", "description": "Amount of the line, inclusive of discounts but exclusive of tax." }, "taxAmount": { "type": "number", "format": "decimal", "description": "Amount of tax for the line." }, "taxRateRef": { "$ref": "#/components/schemas/TaxRate/definitions/taxRateRef", "description": "Reference to the tax rate to which the line item is linked." }, "totalAmount": { "type": "number", "format": "decimal", "description": "Total amount of the line, inclusive of discounts and tax." } } } }, "examples": [ { "id": "string", "salesOrderNumber": "string", "customerPurchaseOrd erNumber": "string", "issueDate": "2022-10-23T00:00:00Z", "expectedDeliveryDate": "2022-10-23T00:00:00Z", "note": "string", "shipTo": { "contact": { "name": "string", "email": "string", "phone": "string" }, "address": { "type": "Unknown", "line1": "string", "line2": "string", "city": "string", "region": "string", "country": "string", "postalCode": "string" } }, "customerRef": { "id": "string", "companyName": "string" }, "status": "Unknown", "invoicingStatus": "Unknown", "currency": "GBP", "currencyRate": 0, "lineItems": [ { "description": "string", "accountRef": { "id": "string", "name": "string" }, "itemRef": { "id": "string", "name": "string" }, "tracking": { "recordRefs": [ "string" ] }, "unitAmount": 0, "quantity": 0, "discountAmount": 0, "discountPercentage": 0, "subTotal": 0, "taxAmount": 0, "taxRateRef": { "id": "string", "name": "string", "effectiveTaxRate": 0 }, "totalAmount": 0 } ], "totalDiscount": 0, "subTotal": 0, "totalTaxAmount": 0, "totalAmount": 0, "metadata": { "isDeleted": true }, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z" } ] }, "SalesOrders": { "title": "Accounting: Sales orders", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrder" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "SupplementalData": { "title": "Supplemental data", "type": "object", "x-internal": true, "description": "Supplemental data is additional data you can include in our standard data types. \n\nIt is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data.", "properties": { "content": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true }, "nullable": true } } }, "Supplier": { "title": "Accounting: Supplier", "description": "> View the coverage for suppliers in the Data coverage explorer.\n\n## Overview\n\nFrom the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/accounting-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/accounting-api#/schemas/Bill).", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the supplier, unique to the company in the accounting software." }, "supplierName": { "type": "string", "nullable": true, "description": "Name of the supplier as recorded in the accounting system, typically the company name." }, "contactName": { "type": "string", "nullable": true, "description": "Name of the main contact for the supplier." }, "emailAddress": { "type": "string", "nullable": true, "description": "Email address that the supplier may be contacted on." }, "phone": { "type": "string", "nullable": true, "description": "Phone number that the supplier may be contacted on.", "examples": [ "+44 25691 154789", "(877) 492-8687", "01224 658 999" ] }, "addresses": { "type": "array", "nullable": true, "description": "An array of Addresses.", "items": { "$ref": "#/components/schemas/CompanyDataset/properties/addresses/items" } }, "registrationNumber": { "type": "string", "nullable": true, "description": "Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House." }, "taxNumber": { "type": "string", "nullable": true, "description": "Supplier's company tax number." }, "status": { "$ref": "#/components/schemas/Supplier/definitions/supplierStatus" }, "defaultCurrency": { "type": "string", "nullable": true, "description": "Default currency the supplier's transactional data is recorded in." }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "required": [ "status" ], "definitions": { "supplierRef": { "title": "Supplier reference", "description": "Reference to the supplier the record relates to.", "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "The supplier's unique ID" }, "supplierName": { "type": "string", "nullable": true, "description": "The supplier's name" } }, "required": [ "id" ] }, "supplierStatus": { "description": "Status of the supplier.", "type": "string", "enum": [ "Unknown", "Active", "Archived" ] } }, "examples": [ { "id": "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F", "supplierName": "Kelly's Industrial Supplies", "contactName": "Kelly's Industrial Supplies", "emailAddress": "sales@kellysupplies.com", "phone": "07999 999999", "addresses": [ { "type": "Billing", "line1": "Unit 51", "line2": "Bakersfield Industrial Estate", "city": "Bakersfield", "region": "California", "country": "USA", "postalcode": "93308" } ], "registrationNumber": "string", "taxNumber": "string", "status": "Unknown", "defaultCurrency": "string", "metadata": { "isDeleted": true }, "supplementalData": { "content": { "property1": { "property1": null, "property2": null }, "property2": { "property1": null, "property2": null } } }, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z" } ] }, "Suppliers": { "title": "Suppliers", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Supplier" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "TaxRate": { "title": "Accounting: Tax rate", "description": "> View the coverage for tax rates in the Data coverage explorer.\n\n## Overview\n\nAccounting systems typically store a set of taxes and associated rates within the accounting software. This means that users don't have to look up or remember the rates for each type of tax. For example, applying the tax \"UK sales VAT\" to line items of an invoice adds the correct rate of 20%.\n\n### Tax components\n\nIn some cases, a tax is made up of multiple sub taxes, often called _components_ of the tax. For example, you may have an item that is charged a tax rate called \"City import tax (8%)\" that has two components:\n\n- A city tax of 5%\n- An import tax of 3%\n\n> **Effective tax rates**\n> - Where there are multiple components of a tax, each component may be calculated on the original amount and added together. Alternatively, one tax may be calculated on the sub-total of the original amount plus another tax, which is referred to as _compounding_. When there is compounding, the effective tax rate is the rate that, if applied to the original amount, would result in the total amount of tax with compounding.\n>\n> **Example:** \n> A tax has two components. Both components have a rate of 10%, and one component is compound. In this case, there is a total tax rate of 20% but an effective tax rate of 21%.\n>\n> - For QuickBooks Online, Codat doesn't use compound rates. Instead, the calculated effective tax rate for each component is shown. This means that the effective and total rates are the same because the total tax rate is a sum of the component rates.", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for the tax rate, unique for the company in the accounting software." }, "name": { "type": "string", "nullable": true, "description": "Codat-augmented name of the tax rate in the accounting software." }, "code": { "type": "string", "nullable": true, "description": "Code for the tax rate from the accounting software." }, "status": { "$ref": "#/components/schemas/TaxRate/definitions/taxRateStatus" }, "effectiveTaxRate": { "type": "number", "format": "decimal", "nullable": true, "description": "See Effective tax rates description." }, "totalTaxRate": { "type": "number", "format": "decimal", "nullable": true, "description": "Total (not compounded) sum of the components of a tax rate." }, "components": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/TaxRate/definitions/taxRateComponent" } }, "validDatatypeLinks": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ValidDataTypeLinks" } }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "taxRateRef": { "title": "Tax rate reference", "type": "object", "description": "Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate.\n\nFound on:\n\n- Bill line items\n- Bill Credit Note line items\n- Credit Note line items\n- Direct incomes line items\n- Invoice line items\n- Items", "properties": { "id": { "type": "string", "description": "Unique identifier for the tax rate in the accounting software." }, "name": { "type": "string", "description": "Name of the tax rate in the accounting software." }, "effectiveTaxRate": { "type": "number", "format": "decimal", "description": "Applicable tax rate." } } }, "taxRateStatus": { "title": "Tax rate status", "description": "Status of the tax rate in the accounting software. \n- `Active` - An active tax rate in use by a company. \n- `Archived` - A tax rate that has been archived or is inactive in the accounting software. \n- `Unknown` - Where the status of the tax rate cannot be determined from the underlying platform.", "type": "string", "enum": [ "Unknown", "Active", "Archived" ] }, "taxRateComponent": { "title": "Tax Rate Component", "type": "object", "description": "A tax rate can be made up of multiple sub taxes, often called components of the tax.", "additionalProperties": false, "properties": { "name": { "type": "string", "nullable": true, "description": "Name of the tax rate component." }, "rate": { "type": "number", "format": "decimal", "nullable": true, "description": "The rate of the tax rate component, usually a percentage." }, "isCompound": { "type": "boolean", "description": "A flag to indicate with the tax is calculated using the principle of compounding. " } }, "required": [ "isCompound" ] } } }, "TaxRates": { "title": "Accounting: Tax rates", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRate" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "TrackingCategories": { "title": "Accounting: Tracking categories", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/TrackingCategory" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "TrackingCategory": { "title": "Accounting: Tracking category", "description": "Details of a category used for tracking transactions.\n\n> Language tip\n>\n> Parameters used to track types of spend in various parts of an organization can be called **dimensions**, **projects**, **classes**, or **locations** in different accounting software. In Codat, we refer to these as tracking categories.\n\nView the coverage for tracking categories in the Data coverage explorer.\n\n## Overview\n\nTracking categories are used to monitor cost centres and control budgets that sit outside the standard chart of accounts. Customers may use tracking categories to group together and track the income and costs of specific departments, projects, locations or customers.\n\nFrom their accounting system, customers can: \n\n- Create and maintain tracking categories and tracking category types.\n- View all tracking categories that are available for use.\n- View the relationships between the categories.\n- Assign invoices, bills, credit notes, or bill credit notes to one or more categories.\n- View the categories that a transaction belongs to.\n- View all transactions in a tracking category.\n\n### Tracking categories per platform\n\nReview the platform-specific tracking categories that Codat supports, and the level they are assigned to in the source platform. \n\n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
PlatformTracking categoryTracking level
Dynamics 365DimensionsLine item
FreshbooksExpense categoriesLine item
MYOBCategoriesTransaction
NetsuiteClassesLine item
LocationsLine item
DepartmentsLine item
Custom segmentsLine item
QuickBooks DesktopClassesLine item or transaction level
LocationsTransaction
QuickBooks OnlineClassesLine item or transaction level
LocationsTransaction
Sage 200Cost centersLine item
DepartmentsLine item
Analysis codesTransaction
Sage 50DepartmentsLine item
CostcodesLine item
ProjectsLine item
Sage IntacctDimensionsLine item
XeroTracking categoriesLine item
\n\n> **Example use case**\n>\n> Monitor the budget for your annual conference using a tracking category called 'AnnualConference2020' with the **type** set to **Costing**.\n\nIf a tracking category has a parent category, the ID of that parent category is displayed. There is also a `hasChildren` field that shows whether there are child subcategories nested beneath. ", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the item, unique per tracking category.", "nullable": true }, "name": { "type": "string", "description": "The name of the tracking category.", "nullable": true }, "status": { "$ref": "#/components/schemas/TrackingCategory/definitions/status" }, "parentId": { "type": "string", "description": "The identifier for this item's immediate parent.", "nullable": true }, "hasChildren": { "type": "boolean", "description": "Boolean value indicating whether this category has SubCategories." }, "metadata": { "$ref": "#/components/schemas/Metadata" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "trackingCategoryRef": { "required": [ "id" ], "type": "object", "description": "References a category against which the item is tracked.", "deprecated": true, "properties": { "id": { "minLength": 1, "type": "string", "description": "Unique identifier to the tracking category." }, "name": { "type": "string", "nullable": true, "description": "Name of tracking category." } } }, "status": { "title": "Tracking category status", "type": "string", "description": "Current state of the tracking category.", "enum": [ "Unknown", "Active", "Archived" ] } }, "examples": [ { "id": "string", "name": "string", "status": "Unknown", "parentId": "string", "hasChildren": true, "modifiedDate": "2022-10-23T00:00:00Z", "sourceModifiedDate": "2022-10-23T00:00:00Z" } ] }, "TrackingCategoryTree": { "title": "Accounting: Tracking category tree", "description": "The full structure of a specific tracking category including any child or subcategories.", "type": "object", "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the item, unique per tracking category", "nullable": true }, "name": { "type": "string", "description": "The name of the tracking category", "nullable": true }, "status": { "$ref": "#/components/schemas/TrackingCategory/definitions/status" }, "parentId": { "type": "string", "description": "The identifier for this item's immediate parent", "nullable": true }, "hasChildren": { "type": "boolean", "description": "Boolean value indicating whether this category has SubCategories" }, "subCategories": { "type": "array", "nullable": true, "description": "A collection of subcategories that are nested beneath this category.", "items": { "$ref": "#/components/schemas/TrackingCategoryTree" } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ] }, "Transfer": { "title": "Accounting: Transfer", "description": "> View the coverage for transfers in the Data coverage explorer.\n\nA transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction).", "allOf": [ { "properties": { "id": { "type": "string", "description": "Unique identifier for the transfer." }, "description": { "type": "string", "nullable": true, "description": "Description of the transfer." }, "contactRef": { "$ref": "#/components/schemas/JournalEntry/definitions/journalLine/properties/contactRef", "description": "The customer or supplier for the transfer, if available." }, "date": { "$ref": "#/components/schemas/DateTime", "description": "The day on which the transfer was made." }, "from": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount", "description": "The details of the accounts the transfer is moving from." }, "to": { "$ref": "#/components/schemas/Transfer/definitions/transferAccount", "description": "The details of the accounts the transfer is moving to." }, "status": { "description": "The status of the transfer in the account", "type": "string", "enum": [ "Unknown", "Unreconciled", "Reconciled", "Void" ], "nullable": true }, "trackingCategoryRefs": { "type": "array", "nullable": true, "description": "Reference to the tracking categories this transfer is being tracked against.", "items": { "$ref": "#/components/schemas/TrackingCategory/definitions/trackingCategoryRef" } }, "depositedRecordRefs": { "type": "array", "nullable": true, "description": "List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer.", "items": { "$ref": "#/components/schemas/DirectCost/definitions/tracking/properties/invoiceTo" } }, "metadata": { "$ref": "#/components/schemas/Metadata" }, "supplementalData": { "$ref": "#/components/schemas/SupplementalData" } } }, { "$ref": "#/components/schemas/ModifiedDates" } ], "definitions": { "transferAccount": { "title": "Transfer account", "description": "Account details of the account sending or receiving the transfer.", "type": "object", "properties": { "accountRef": { "$ref": "#/components/schemas/Account/definitions/accountRef", "description": "The account that the transfer is moving from or to." }, "currency": { "title": "Currency", "x-internal": true, "type": "string", "description": "The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.\n\n## Unknown currencies\n\nIn line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. \n\nThere are only a very small number of edge cases where this currency code is returned by the Codat system.", "format": "ISO4217", "examples": [ "GBP", "USD", "EUR" ] }, "amount": { "type": "number", "format": "decimal", "description": "The amount transferred between accounts." } } } }, "type": "object" }, "Transfers": { "title": "Accounting: Transfers", "x-internal": true, "allOf": [ { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Transfer" } } } }, { "$ref": "#/components/schemas/PagingInfo" } ] }, "UpdateBankAccountResponse": { "title": "Accounting: Update bank account response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/BankAccount" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "UpdateBillCreditNoteResponse": { "title": "Accounting: Update bill credit note response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/BillCreditNote" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "UpdateBillResponse": { "title": "Accounting: Update bill response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Bill" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "UpdateCreditNoteResponse": { "title": "Accounting: Update credit note response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreditNote" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "UpdateCustomerResponse": { "title": "Accounting: Update customer response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Customer" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "UpdateInvoiceResponse": { "title": "Accounting: Update invoice response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Invoice" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "UpdatePurchaseOrderResponse": { "title": "Accounting: Update purchase order response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PurchaseOrder" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "UpdateSupplierResponse": { "title": "Accounting: Update supplier response", "x-internal": true, "allOf": [ { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Supplier" }, { "deprecated": true } ] } } }, { "$ref": "#/components/schemas/PushOperationSummary" } ] }, "ValidDataTypeLinks": { "title": "Valid data type links", "description": "When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.\n\nFor example, `validDatatypeLinks` might indicate the following references:\n\n- Which tax rates are valid to use on the line item of a bill.\n- Which items can be used when creating an invoice. \n\nYou can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example.\n\n## `validDatatypeLinks` example\n\nThe following example uses the `Accounting.Accounts` data type. It shows that, on the linked integration, this account is valid as the account on a payment or bill payment; and as the account referenced on the line item of a direct income or direct cost. Because there is no valid link to Invoices or Bills, using this account on those data types will result in an error.\n\n```json validDatatypeLinks for an account\n{\n \"id\": \"bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4\",\n \"nominalCode\": \"090\",\n \"name\": \"Business Bank Account\",\n #...\n \"validDatatypeLinks\": [\n {\n \"property\": \"Id\",\n \"links\": [\n \"Payment.AccountRef.Id\",\n \"BillPayment.AccountRef.Id\",\n \"DirectIncome.LineItems.AccountRef.Id\",\n \"DirectCost.LineItems.AccountRef.Id\"\n ]\n }\n ]\n }\n```\n\n\n\n## Support for `validDatatypeLinks`\n\nCodat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations. \n\nIf you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap.", "type": "object", "properties": { "property": { "type": "string", "nullable": true, "description": "The property from the account that can be linked." }, "links": { "type": "array", "nullable": true, "description": "Supported `dataTypes` that the record can be linked to.", "items": { "type": "string" } } } } }, "parameters": { "companyId": { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "8a210b68-6988-11ed-a1eb-0242ac120002", "description": "Unique identifier for your SMB in Codat." }, "description": "Unique identifier for a company." }, "connectionId": { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "description": "Unique identifier for a company's data connection." }, "description": "Unique identifier for a connection." }, "page": { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "minimum": 1, "example": 1, "default": 1 }, "description": "Page number. [Read more](https://docs.codat.io/using-the-api/paging)." }, "pageSize": { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100, "example": 100, "minimum": 1, "maximum": 5000 }, "description": "Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)." }, "query": { "name": "query", "in": "query", "required": false, "schema": { "type": "string" }, "example": "id=e3334455-1aed-4e71-ab43-6bccf12092ee", "description": "Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)." }, "orderBy": { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "example": "-modifiedDate" }, "description": "Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)." }, "timeoutInMinutes": { "name": "timeoutInMinutes", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Time limit for the push operation to complete before it is timed out." }, "forceUpdate": { "name": "forceUpdate", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting software, if they're different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check." }, "allowSyncOnPushComplete": { "name": "allowSyncOnPushComplete", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "Allow a sync upon push completion." }, "accountId": { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for an account." }, "transferId": { "name": "transferId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a transfer." }, "periodLength": { "name": "periodLength", "description": "Number of months defining the period of interest.", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "example": 4 } }, "periodsToCompare": { "name": "periodsToCompare", "description": "Number of periods with `periodLength` to compare.", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32", "example": 20 } }, "startMonth": { "name": "startMonth", "in": "query", "schema": { "$ref": "#/components/schemas/DateTime" }, "description": "The month the report starts from." }, "bankAccountId": { "name": "bankAccountId", "in": "path", "required": true, "schema": { "type": "string", "description": "Unique identifier for a bank account.", "examples": [ "13d946f0-c5d5-42bc-b092-97ece17923ab", "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2", "7110701885", "EILBDVJVNUAGVKRQ", "Checking 0202" ] }, "description": "Unique identifier for a bank account." }, "invoiceId": { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for an invoice." }, "attachmentId": { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "8a210b68-6988-11ed-a1eb-0242ac120002" }, "description": "Unique identifier for an attachment." }, "customerId": { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a customer." }, "supplierId": { "name": "supplierId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a supplier." }, "billId": { "name": "billId", "in": "path", "required": true, "schema": { "type": "string", "examples": [ "13d946f0-c5d5-42bc-b092-97ece17923ab", "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2", 7110701885, "EILBDVJVNUAGVKRQ" ] }, "description": "Unique identifier for a bill." }, "directCostId": { "name": "directCostId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a direct cost." }, "directIncomeId": { "name": "directIncomeId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a direct income." }, "journalId": { "name": "journalId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for a journal." }, "journalEntryId": { "name": "journalEntryId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a journal entry." }, "billPaymentId": { "name": "billPaymentId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a bill payment." }, "billCreditNoteId": { "name": "billCreditNoteId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a bill credit note." }, "creditNoteId": { "name": "creditNoteId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a credit note." }, "itemId": { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for an item." }, "itemReceiptId": { "name": "itemReceiptId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for an item receipt." }, "paymentMethodId": { "name": "paymentMethodId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a payment method." }, "paymentId": { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a payment." }, "purchaseOrderId": { "name": "purchaseOrderId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a purchase order." }, "salesOrderId": { "name": "salesOrderId", "in": "path", "required": true, "schema": { "type": "string", "examples": { "$ref": "#/components/parameters/billId/schema/examples" } }, "description": "Unique identifier for a sales order." }, "taxRateId": { "name": "taxRateId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for a tax rate." }, "trackingCategoryId": { "name": "trackingCategoryId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for a tracking category." }, "reportDate": { "name": "reportDate", "in": "query", "schema": { "type": "string", "format": "date", "example": "2022-12-31" }, "description": "Date the report is generated up to." }, "numberOfPeriods": { "name": "numberOfPeriods", "in": "query", "schema": { "type": "integer", "format": "int32", "example": 12 }, "description": "Number of periods to include in the report." }, "periodLengthDays": { "name": "periodLengthDays", "in": "query", "schema": { "type": "integer", "format": "int32", "example": 30 }, "description": "The length of period in days." } }, "responses": { "BadRequest": { "description": "The request made is not valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Malformed query": { "value": { "statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Malformed-Query": { "description": "Your `query` parameter was not correctly formed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Malformed query": { "value": { "statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } }, "Unresolved property": { "value": { "statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Unauthorized": { "description": "Your API request was not properly authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Unauthorized": { "value": { "statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Payment-Required": { "description": "An account limit has been exceeded. The type of limit is described in the error property:\n\n- You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request.\n- The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan.\n- Your Free account is older than 365 days and has expired. Contact support@codat.io.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Conflict": { "value": { "statusCode": 429, "service": "PublicApi", "error": "You have exceeded the 50-company limit that applies to a Free plan. We recommend that you delete any companies you no longer need and retry the request.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Forbidden": { "description": "You are using an outdated API key or a key not associated with that resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Conflict": { "value": { "statusCode": 403, "service": "PublicApi", "error": "You are using an outdated API key or a key not associated with that resource.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Not-Found": { "description": "One or more of the resources you referenced could not be found.\nThis might be because your company or data connection id is wrong, or was already deleted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Data connection not found": { "value": { "statusCode": 404, "service": "PublicApi", "error": "Data connection a22dd66b-564a-4832-9b37-7b3ce4aeb7de not found", "correlationId": "8fa2b5f4794970a4ee73758f612e8df0", "canBeRetried": "Unknown", "detailedErrorCode": 0 } }, "Company not found": { "value": { "statusCode": 404, "service": "ClientsApi", "error": "No company was found with ID 846ed55c-974b-4392-a1f1-87b6fdbf3c5e", "correlationId": "0a40c2f31fc8f992fb88b0853e4166f3", "canBeRetried": "Unknown", "detailedErrorCode": 0 } }, "No data available": { "value": { "statusCode": 404, "service": "PublicApi", "error": "No data available for accounts for ID e5889b459f544926ac5b8e6756df2s", "correlationId": "0a40c2f31fc8f992fb88b0853e4166f3", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Conflict": { "description": "The data type's dataset has not been requested or is still syncing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Conflict": { "value": { "statusCode": 409, "service": "PublicApi", "error": "The data set has not been requested.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Too-Many-Requests": { "description": "Too many requests were made in a given amount of time. Wait a short period and then try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Conflict": { "value": { "statusCode": 429, "service": "PublicApi", "error": "You have made too many requests in a given amount of time; please retry later.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Internal-Server-Error": { "description": "There is a problem with our server. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Conflict": { "value": { "statusCode": 500, "service": "PublicApi", "error": "There is a problem with our server. Please try again later.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } }, "Service-Unavailable": { "description": "The Codat API is temporarily offline for maintenance. Please try again later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorMessage" }, "examples": { "Conflict": { "value": { "statusCode": 500, "service": "PublicApi", "error": "The Codat API is temporarily offline for maintenance. Please try again later.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0 } } } } } } }, "securitySchemes": { "auth_header": { "name": "Authorization", "description": "The word \"Basic\" followed by a space and your API key. [API keys](https://docs.codat.io/accounting-api#/schemas/apiKeys) are tokens used to control access to the API. You can get an API key via [the Codat Portal](https://app.codat.io/developers/api-keys), via [the API](https://docs.codat.io/codat-api#/api-keys/api-keys-list), or [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat.", "type": "apiKey", "in": "header", "x-speakeasy-example": "Basic BASE_64_ENCODED(API_KEY)" } } } }