openapi: 3.1.0 servers: - description: Production url: 'https://api.codat.io' info: title: Sync for Payables description: |- The API for Sync for Payables. Sync for Payables is an API and a set of supporting tools built to help integrate with your customers' accounting software, and keep their supplier information, invoices, and payments in sync. [Explore product](https://docs.codat.io/payables/overview) | [See OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users' companies. | | Connections | Create new and manage existing data connections for a company. | | Accounts | Get, create, and update Accounts. | | Bank accounts | Get, create, and update Bank accounts. | | Bills | Get, create, and update Bills. | | Bill credit notes | Get, create, and update Bill credit notes. | | Bill payments | Get, create, and update Bill payments. | | Journals | Get, create, and update Journals. | | Journal entries | Get, create, and update Journal entries. | | Payment methods | Get, create, and update Payment methods. | | Suppliers | Get, create, and update Suppliers. | | Tax rates | Get, create, and update Tax rates. | | Tracking categories | Get, create, and update Tracking categories. | | Company info | View company profile from the source platform. | | Push operations | View historic push operations. | | Manage data | Control how data is retrieved from an integration. | version: 3.0.0 contact: name: Codat email: support@codat.io 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: sync-for-payables-api x-codat-keep-docs-paths-local: true x-codat-speakeasy-pagination: type: offsetLimit inputs: - name: page in: parameters type: page outputs: results: $.results tags: - name: Companies description: Create and manage your SMB users' companies. - name: Connections description: Create new and manage existing data connections for a company. - name: Accounts description: 'Get, create, and update Accounts.' - name: Bank accounts description: 'Get, create, and update Bank accounts.' - name: Bills description: 'Get, create, and update Bills.' - name: Bill credit notes description: 'Get, create, and update Bill credit notes.' - name: Bill payments description: 'Get, create, and update Bill payments.' - name: Journals description: 'Get, create, and update Journals.' - name: Journal entries description: 'Get, create, and update Journal entries.' - name: Payment methods description: 'Get, create, and update Payment methods.' - name: Suppliers description: 'Get, create, and update Suppliers.' - name: Tax rates description: 'Get, create, and update Tax rates.' - name: Tracking categories description: 'Get, create, and update Tracking categories.' - name: Company info description: View company profile from the source platform. - name: Push operations description: View historic push operations. - name: Manage data description: Control how data is retrieved from an integration. paths: /companies: get: summary: List companies tags: - Companies responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Companies' examples: One company: value: results: - id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 name: My Test Company description: My Test Company make testing software platform: '' redirect: 'https://link.codat.io/company/3fa85f64-5717-4562-b3fc-2c963f66afa6' lastSync: '2022-01-01T12:30:00.000Z' dataConnections: - id: 51baa045-4836-4317-a42e-3542e991e581 integrationId: 1c312d69-e638-46d4-ad31-72e6c3ba8390 integrationKey: vjms sourceId: 396c3158-5dd7-481b-a7c4-a795ca31792b platformName: Pandle linkUrl: 'https://link-api.codat.io/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/connections/51baa045-4836-4317-a42e-3542e991e581/start' status: Linked lastSync: '2022-01-01T12:30:00.000Z' created: '2022-01-01T11:30:00Z' sourceType: Accounting created: '2022-01-01T11:30:00Z' createdByUserName: Mike Smith pageNumber: 1 pageSize: 100 totalResults: 1 _links: current: href: /companies?page=1&pageSize=100 self: href: /companies List of Companies: value: results: - id: d1568dde-adf6-11ed-afa1-0242ac120002 name: Technicalium description: 'Technology services, including web and app design and development' platform: '' redirect: 'https://link.codat.io/company/d1568dde-adf6-11ed-afa1-0242ac120002' lastSync: '2022-01-01T12:30:00.000Z' dataConnections: - id: 51baa045-4836-4317-a42e-3542e991e581 integrationId: 1c312d69-e638-46d4-ad31-72e6c3ba8390 integrationKey: vjms sourceId: 396c3158-5dd7-481b-a7c4-a795ca31792b platformName: Pandle linkUrl: 'https://link-api.codat.io/companies/d1568dde-adf6-11ed-afa1-0242ac120002/connections/51baa045-4836-4317-a42e-3542e991e581/start' status: Linked lastSync: '2022-01-01T12:30:00.000Z' created: '2022-01-01T11:30:00Z' sourceType: Accounting created: '2022-01-01T11:30:00Z' createdByUserName: Joe Bloggs - id: 096db70b-78de-4ff0-aa98-299cb5fe17a0 name: Godata description: A new digital agency with a passion for creating amazing digital experiences platform: '' redirect: 'https://link.codat.io/company/096db70b-78de-4ff0-aa98-299cb5fe17a0' lastSync: '2022-01-01T12:30:00.000Z' dataConnections: - id: a70bc148-dc21-46b2-a257-d9c58ac15cbb integrationId: 1c312d69-e638-46d4-ad31-72e6c3ba8390 integrationKey: vjms sourceId: 396c3158-5dd7-481b-a7c4-a795ca31792b platformName: Pandle linkUrl: 'https://link-api.codat.io/companies/096db70b-78de-4ff0-aa98-299cb5fe17a0/connections/a70bc148-dc21-46b2-a257-d9c58ac15cbb/start' status: Linked lastSync: '2022-01-01T12:30:00.000Z' created: '2022-01-01T11:30:00Z' sourceType: Accounting created: '2022-01-01T11:30:00Z' createdByUserName: Mike Smith pageNumber: 1 pageSize: 100 totalResults: 2 _links: current: href: /companies?page=1&pageSize=100 self: href: /companies '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' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' operationId: list-companies description: "\uFEFFThe *List companies* endpoint returns a list of [companies] associated to your instances.\n\nA [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payables-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data." parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/query' - $ref: '#/components/parameters/orderBy' post: summary: Create company tags: - Companies operationId: create-company responses: '200': description: OK content: application/json: x-speakeasy-usage-example: true schema: $ref: '#/components/schemas/Company' examples: With no description: value: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 name: Technicalium description: '' platform: '' redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' dataConnections: [] created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar With a description: value: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 name: Technicalium description: 'Technology services, including web and app design and development' platform: '' redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' dataConnections: [] created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar With a tag: value: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 name: Technicalium description: '' platform: '' redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' dataConnections: [] created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar tags: region: us '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/Payment-Required' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' description: "\uFEFFUse the *Create company* endpoint to create a new [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company) that represents your customer in Codat. \n\nA [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payables-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n\nIf forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`." requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanyRequestBody' examples: With no description: value: name: Technicalium With a description: value: name: Technicalium description: 'Technology services, including web and app design and development' '/companies/{companyId}': put: summary: Update company description: "\uFEFFUse the *Update company* endpoint to update both the name and description of the company. \n\nA [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payables-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data." operationId: update-company parameters: - $ref: '#/components/parameters/companyId' tags: - Companies responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Company' '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' requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanyRequestBody' examples: Update name: value: name: New Name Update description: value: name: Same name description: Additional documents required delete: summary: Delete a company operationId: delete-company parameters: - $ref: '#/components/parameters/companyId' description: "\uFEFFThe *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company), its [connections](https://docs.codat.io/sync-for-payables-api#/schemas/Connection) and any cached data. This operation is irreversible.\n\nA [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payables-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n" tags: - Companies responses: '204': description: No Content '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' get: summary: Get company operationId: get-company description: "\uFEFFThe *Get company* endpoint returns a single company for a given `companyId`.\n\nA [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payables-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n" parameters: - $ref: '#/components/parameters/companyId' tags: - Companies responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Company' examples: Simple company: value: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 name: My First Company description: '' platform: '' redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' dataConnections: [] created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar '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': get: summary: List connections description: "\uFEFFList the connections for a company." operationId: list-connections tags: - Connections parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/query' - $ref: '#/components/parameters/orderBy' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Connections' examples: Connections: value: results: - id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c integrationKey: dfxm sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee platformName: Basiq linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' status: Linked lastSync: '2022-10-27T10:22:43.6464237Z' created: '2022-10-27T09:53:29Z' sourceType: Banking pageNumber: 0 pageSize: 0 totalResults: 0 _links: self: href: string current: href: string next: href: string previous: href: string '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' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' post: summary: Create connection description: "\uFEFFCreates a connection for the company by providing a valid `platformKey`. \n\nUse the [List Integrations](https://docs.codat.io/sync-for-payables-api#/operations/list-integrations) endpoint to access valid platform keys. " parameters: - $ref: '#/components/parameters/companyId' tags: - Connections operationId: create-connection requestBody: content: application/json: schema: type: object properties: platformKey: type: string minLength: 4 maxLength: 4 pattern: '[a-z]{4}' example: gbol description: 'A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys.' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Connection' examples: Connection: value: id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c integrationKey: dfxm sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee platformName: Basiq linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' status: Linked lastSync: '2022-10-27T10:22:43.6464237Z' created: '2022-10-27T09:53:29Z' sourceType: Banking '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}': get: summary: Get connection operationId: get-connection description: "\uFEFFReturns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned." tags: - Connections parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Connection' examples: Connection: value: id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c integrationKey: dfxm sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee platformName: Basiq linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' status: Linked lastSync: '2022-10-27T10:22:43.6464237Z' created: '2022-10-27T09:53:29Z' sourceType: Banking '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' delete: summary: Delete connection operationId: delete-connection description: "\uFEFFRevoke and remove a connection from a company.\nThis operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company." parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' tags: - Connections responses: '200': description: OK '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' patch: summary: Unlink connection description: "\uFEFFThis allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data." operationId: unlink-connection x-speakeasy-name-override: unlink tags: - Connections parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Connection' '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' requestBody: content: application/json: schema: title: Update connection x-internal: true type: object properties: status: $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' description: The current authorization status of the data connection. nullable: true additionalProperties: false examples: Example: value: status: Unlinked description: '' '/companies/{companyId}/data/all': parameters: - $ref: '#/components/parameters/companyId' post: summary: Refresh all data operationId: refresh-all-data-types responses: '204': description: No Content '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: |- Refreshes all data types with `fetch on first link` set to `true` for a given company. This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. [Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`. tags: - Manage data '/companies/{companyId}/dataStatus': parameters: - $ref: '#/components/parameters/companyId' get: summary: Get data status operationId: get-data-status description: Get the state of each data type for a company tags: - Manage data responses: '200': description: OK content: application/json: schema: title: Data statuses x-internal: true type: object properties: accountTransactions: $ref: '#/components/schemas/DataStatus' nullable: true balanceSheet: $ref: '#/components/schemas/DataStatus' nullable: true bankAccounts: $ref: '#/components/schemas/DataStatus' nullable: true bankTransactions: $ref: '#/components/schemas/DataStatus' nullable: true billCreditNotes: $ref: '#/components/schemas/DataStatus' nullable: true billPayments: $ref: '#/components/schemas/DataStatus' nullable: true bills: $ref: '#/components/schemas/DataStatus' nullable: true cashFlowStatement: $ref: '#/components/schemas/DataStatus' nullable: true chartOfAccounts: $ref: '#/components/schemas/DataStatus' nullable: true company: $ref: '#/components/schemas/DataStatus' nullable: true creditNotes: $ref: '#/components/schemas/DataStatus' nullable: true customers: $ref: '#/components/schemas/DataStatus' nullable: true directCosts: $ref: '#/components/schemas/DataStatus' nullable: true directIncomes: $ref: '#/components/schemas/DataStatus' nullable: true invoices: $ref: '#/components/schemas/DataStatus' nullable: true itemReceipts: $ref: '#/components/schemas/DataStatus' nullable: true items: $ref: '#/components/schemas/DataStatus' nullable: true journalEntries: $ref: '#/components/schemas/DataStatus' nullable: true journals: $ref: '#/components/schemas/DataStatus' nullable: true paymentMethods: $ref: '#/components/schemas/DataStatus' nullable: true payments: $ref: '#/components/schemas/DataStatus' nullable: true profitAndLoss: $ref: '#/components/schemas/DataStatus' nullable: true purchaseOrders: $ref: '#/components/schemas/DataStatus' nullable: true salesOrders: $ref: '#/components/schemas/DataStatus' nullable: true suppliers: $ref: '#/components/schemas/DataStatus' nullable: true taxRates: $ref: '#/components/schemas/DataStatus' nullable: true trackingCategories: $ref: '#/components/schemas/DataStatus' nullable: true transfers: $ref: '#/components/schemas/DataStatus' nullable: true banking-accountBalances: $ref: '#/components/schemas/DataStatus' nullable: true banking-accounts: $ref: '#/components/schemas/DataStatus' nullable: true banking-transactionCategories: $ref: '#/components/schemas/DataStatus' nullable: true banking-transactions: $ref: '#/components/schemas/DataStatus' nullable: true commerce-companyInfo: $ref: '#/components/schemas/DataStatus' nullable: true commerce-customers: $ref: '#/components/schemas/DataStatus' nullable: true commerce-disputes: $ref: '#/components/schemas/DataStatus' nullable: true commerce-locations: $ref: '#/components/schemas/DataStatus' nullable: true commerce-orders: $ref: '#/components/schemas/DataStatus' nullable: true commerce-paymentMethods: $ref: '#/components/schemas/DataStatus' nullable: true commerce-payments: $ref: '#/components/schemas/DataStatus' nullable: true commerce-productCategories: $ref: '#/components/schemas/DataStatus' nullable: true commerce-products: $ref: '#/components/schemas/DataStatus' nullable: true commerce-taxComponents: $ref: '#/components/schemas/DataStatus' nullable: true commerce-transactions: $ref: '#/components/schemas/DataStatus' nullable: true examples: Example: value: accountTransactions: dataType: accountTransactions lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f balanceSheet: dataType: balanceSheet lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f bankAccounts: dataType: bankAccounts lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f bankTransactions: dataType: bankTransactions lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f billCreditNotes: dataType: billCreditNotes lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f billPayments: dataType: billPayments lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f bills: dataType: bills lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f cashFlowStatement: dataType: cashFlowStatement lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f chartOfAccounts: dataType: chartOfAccounts lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f company: dataType: company lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f creditNotes: dataType: creditNotes lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f customers: dataType: customers lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f directCosts: dataType: directCosts lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f directIncomes: dataType: directIncomes lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f invoices: dataType: invoices lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f itemReceipts: dataType: itemReceipts lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f items: dataType: items lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f journalEntries: dataType: journalEntries lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f journals: dataType: journals lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f paymentMethods: dataType: paymentMethods lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f payments: dataType: payments lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f profitAndLoss: dataType: profitAndLoss lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f purchaseOrders: dataType: purchaseOrders lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f salesOrders: dataType: salesOrders lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f suppliers: dataType: suppliers lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f taxRates: dataType: taxRates lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f trackingCategories: dataType: trackingCategories lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f transfers: dataType: transfers lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f banking-accountBalances: dataType: banking-accountBalances lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f banking-accounts: dataType: banking-accounts lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f banking-transactionCategories: dataType: banking-transactionCategories lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f banking-transactions: dataType: banking-transactions lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f commerce-companyInfo: dataType: commerce-companyInfo lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f commerce-customers: dataType: commerce-customers lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f commerce-disputes: dataType: commerce-disputes lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f commerce-locations: dataType: commerce-locations lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f commerce-orders: dataType: commerce-orders lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f commerce-paymentMethods: dataType: commerce-paymentMethods lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f commerce-payments: dataType: commerce-payments lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f commerce-productCategories: dataType: commerce-productCategories lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f commerce-products: dataType: commerce-products lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f commerce-taxComponents: dataType: commerce-taxComponents lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f commerce-transactions: dataType: commerce-transactions lastSuccessfulSync: '2022-01-01T00:00:00.000Z' currentStatus: Complete latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f '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}/data/queue/{dataType}': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/dataType' post: summary: Refresh data type operationId: refresh-data-type description: |- Refreshes a given data type for a given company. This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. tags: - Manage data parameters: - schema: type: string format: uuid in: query name: connectionId description: 'Optionally, provide a data connection id to only queue pull operations on that connection.' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PullOperation' '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}/data/history': parameters: - $ref: '#/components/parameters/companyId' get: summary: List pull operations tags: - Manage data operationId: list-pull-operations x-speakeasy-name-override: list-pull-operations responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PullOperations' examples: Example: value: results: - id: 97d60846-f07a-4d42-b5a0-0bdcc6ebf56b companyId: 4645bd78-8988-45bc-ac9e-67ba5df6e4e5 connectionId: 51baa045-4836-4317-a42e-3542e991e581 dataType: invoices status: Initial requested: '2022-11-14T11:18:37.2798351Z' progress: 10 isCompleted: false isErrored: false _links: current: href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2 self: href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history next: href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2 pageNumber: 0 pageSize: 0 totalResults: 0 '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' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' description: Gets the pull operation history (datasets) for a given company. parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/query' - $ref: '#/components/parameters/orderBy' '/companies/{companyId}/push': parameters: - $ref: '#/components/parameters/companyId' get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/query' - $ref: '#/components/parameters/orderBy' summary: List push operations tags: - Push operations operationId: list-push-operations description: List push operation records. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PushOperations' examples: {} '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' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' '/companies/{companyId}/data/history/{datasetId}': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/datasetId' get: summary: Get pull operation operationId: get-pull-operation x-speakeasy-name-override: get-pull-operation tags: - Manage data responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PullOperation' 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: Retrieve information about a single dataset or pull operation. '/companies/{companyId}/push/{pushOperationKey}': parameters: - $ref: '#/components/parameters/companyId' - schema: type: string format: uuid name: pushOperationKey in: path required: true description: Push operation key. get: summary: Get push operation tags: - Push operations operationId: get-push-operation description: Retrieve push operation. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PushOperation' 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}/data/accounts': get: tags: - Accounts summary: List accounts description: "\uFEFFThe *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/sync-for-payables-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/sync-for-payables-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/sync-for-payables-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`. [Accounts](https://docs.codat.io/sync-for-payables-api#/schemas/Account) are the categories a business uses to record accounting transactions. Check 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. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). 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-account-model description: "\uFEFFThe *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/sync-for-payables-api#/schemas/Account) for a given company and integration.\n\n[Accounts](https://docs.codat.io/sync-for-payables-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/sync-for-payables-api#/schemas/Account) for a given company's connection. [Accounts](https://docs.codat.io/sync-for-payables-api#/schemas/Account) are the categories a business uses to record accounting transactions. **Integration-specific behaviour** Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/sync-for-payables-api#/operations/get-create-chartOfAccounts-model). Check 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. operationId: create-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-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/sync-for-payables-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/sync-for-payables-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/timeoutInMinutes' requestBody: content: application/json: schema: $ref: '#/components/schemas/BankAccount/definitions/bankAccountPrototype' examples: {} responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BankAccount/definitions/bankAccountCreateResponse' 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/sync-for-payables-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/sync-for-payables-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/sync-for-payables-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}/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/sync-for-payables-api#/schemas/BillCreditNote) for a given company's connection. [Bill credit notes](https://docs.codat.io/sync-for-payables-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). 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`. [Bill credit notes](https://docs.codat.io/sync-for-payables-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. Check 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. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). 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-billCreditNote-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/sync-for-payables-api#/schemas/BillCreditNote) for a given company and integration. [Bill credit notes](https://docs.codat.io/sync-for-payables-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. **Integration-specific behaviour** See the *response examples* for integration-specific indicative models. Check 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. '/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/sync-for-payables-api#/schemas/BillCreditNote) for a given company's connection. [Bill credit notes](https://docs.codat.io/sync-for-payables-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. **Integration-specific behaviour** Required data may vary by integration. To see what data to post, first call [Get create/update bill credit note model](https://docs.codat.io/sync-for-payables-api#/operations/get-create-update-billCreditNotes-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support creating a bill credit note. 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/sync-for-payables-api#/schemas/BillCreditNote) for a given company's connection. [Bill credit notes](https://docs.codat.io/sync-for-payables-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. **Integration-specific behaviour** Required data may vary by integration. To see what data to post, first call [Get create/update bill credit note model](https://docs.codat.io/sync-for-payables-api#/operations/get-create-update-billCreditNotes-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support creating a bill credit note. operationId: update-bill-credit-note '/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/sync-for-payables-api#/schemas/BillPayment) for a given company's connection. [Bill payments](https://docs.codat.io/sync-for-payables-api#/schemas/BillPayment) are an allocation of money within any Accounts Payable account. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). 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`. [Bill payments](https://docs.codat.io/sync-for-payables-api#/schemas/BillPayment) are an allocation of money within any Accounts Payable account. Check 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. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). operationId: get-bill-payments '/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/PushOperation' '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: "\uFEFFThe *Delete bill payment* endpoint allows you to delete a specified bill payment from an accounting software.\n\n[Bill payments](https://docs.codat.io/sync-for-payables-api#/schemas/BillPayment) are an allocation of money within any 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/sync-for-payables-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}/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-billPayment-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/sync-for-payables-api#/schemas/BillPayment) for a given company and integration. [Bill payments](https://docs.codat.io/sync-for-payables-api#/schemas/BillPayment) are an allocation of money within any Accounts Payable account. **Integration-specific behaviour** See the *response examples* for integration-specific indicative models. Check 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. '/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/sync-for-payables-api#/schemas/BillPayment) for a given company's connection. [Bill payments](https://docs.codat.io/sync-for-payables-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. **Integration-specific behaviour** Required data may vary by integration. To see what data to post, first call [Get create bill payment model](https://docs.codat.io/sync-for-payables-api#/operations/get-create-billPayments-model). Check 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. operationId: create-bill-payment '/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 #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/sync-for-payables-api#/schemas/Bill) for a given company's connection.\r\n\r\n[Bills](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services." 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 #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`. [Bills](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Check 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. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). 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-bill-model description: "\uFEFFThe *Get create/update bill model* endpoint returns the expected data for the request payload when creating and updating a [bill](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) for a given company and integration.\n\n[Bills](https://docs.codat.io/sync-for-payables-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/sync-for-payables-api#/schemas/Bill) for a given company's connection. [Bills](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. **Integration-specific behaviour** Required data may vary by integration. To see what data to post, first call [Get create/update bill model](https://docs.codat.io/sync-for-payables-api#/operations/get-create-update-bills-model). Check 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. 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/sync-for-payables-api#/schemas/Bill) for a given company's connection. [Bills](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. **Integration-specific behaviour** Required data may vary by integration. To see what data to post, first call [Get create/update bill model](https://docs.codat.io/sync-for-payables-api#/operations/get-create-update-bills-model). Check 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. operationId: update-bill delete: summary: Delete bill operationId: delete-bill responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PushOperation' 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. [Bills](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) are itemized records of goods received or services provided to the SMB. ### Process 1. Pass the `{billId}` to the *Delete bill* endpoint and store the `pushOperationKey` returned. 2. Check the status of the delete operation by checking the status of the push operation either via 1. [Push operation webhook](https://docs.codat.io/introduction/webhooks/core-rules-types#push-operation-status-has-changed) (advised), 2. [Push operation status endpoint](https://docs.codat.io/sync-for-payables-api#/operations/get-push-operation). A `Success` status indicates that the bill object was deleted from the accounting software. 3. (Optional) Check that the bill was deleted from the accounting software. ### Effect on related objects Be 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. ## Integration specifics Integrations that support soft delete do not permanently delete the object in the accounting software. | Integration | Soft Delete | Details | |-------------|-------------|--------------------------------------------------------------------------------------------------------------| | QuickBooks Online | No | - | | QuickBooks Desktop | No | - | | Oracle NetSuite | No | When deleting a bill that's already linked to a bill payment, you must delete the linked bill payment first. | | | Sage Intacct | No | When deleting a bill that's already linked to a bill payment, you must delete the linked bill payment first. | | 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. | > **Supported Integrations** > > 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/Attachments' '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`.\r\n\r\n[Bills](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services." '/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`. [Bills](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Check 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. operationId: get-bill-attachment '/companies/{companyId}/connections/{connectionId}/push/bills/{billId}/attachments/{attachmentId}': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' - $ref: '#/components/parameters/billId' - $ref: '#/components/parameters/attachmentId' delete: summary: Delete bill attachment tags: - Bills responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PushOperation' '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: delete-bill-attachment description: |- The *Delete bill attachment* endpoint allows you to delete a specified bill attachment from an accounting software. [Bills](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. ### Process 1. Pass the `{billId}` and `{attachmentId}` to the *Delete bill attachment* endpoint and store the `pushOperationKey` returned. 2. Check the status of the delete operation by checking the status of push operation either via 1. [Push operation webhook](https://docs.codat.io/introduction/webhookscore-rules-types#push-operation-status-has-changed) (advised), 2. [Push operation status endpoint](https://docs.codat.io/sync-for-payables-api#/operations/get-push-operation). A `Success` status indicates that the bill attachment object was deleted from the accounting software. 3. (Optional) Check that the bill attachment was deleted from the accounting software. >**Supported Integrations** > >This functionality is currently only supported for our QuickBooks Online integration. '/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`. [Bills](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. Check 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. 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`. [Bills](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. **Integration-specific behaviour** For more details on supported file types by integration see [Attachments](https://docs.codat.io/sync-for-payables-api#/schemas/Attachment). Check 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. operationId: upload-bill-attachment '/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-journalEntry-model description: "\uFEFFThe *Get create journal entry model* endpoint returns the expected data for the request payload when creating a [journal entry](https://docs.codat.io/sync-for-payables-api#/schemas/JournalEntry) for a given company and integration.\n\n[Journal entries](https://docs.codat.io/sync-for-payables-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/sync-for-payables-api#/schemas/JournalEntry) for a given company's connection. [Journal entries](https://docs.codat.io/sync-for-payables-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. **Integration-specific behaviour** Required data may vary by integration. To see what data to post, first call [Get create journal entry model](https://docs.codat.io/sync-for-payables-api#/operations/get-create-journalEntries-model). Check 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. operationId: create-journal-entry '/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/sync-for-payables-api#/schemas/Journal) for a given company's connection. [Journals](https://docs.codat.io/sync-for-payables-api#/schemas/Journal) are used to record all the financial transactions of a company. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). 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`. [Journals](https://docs.codat.io/sync-for-payables-api#/schemas/Journal) are used to record all the financial transactions of a company. Check 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. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). 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-journal-model description: | The *Get create journal model* endpoint returns the expected data for the request payload when creating a [journal](https://docs.codat.io/sync-for-payables-api#/schemas/Journal) for a given company and integration. [Journals](https://docs.codat.io/sync-for-payables-api#/schemas/Journal) are used to record all the financial transactions of a company. **Integration-specific behaviour** See the *response examples* for integration-specific indicative models. Check 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. '/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/sync-for-payables-api#/schemas/Journal) for a given company's connection. [Journals](https://docs.codat.io/sync-for-payables-api#/schemas/Journal) are used to record all the financial transactions of a company. **Integration-specific behaviour** Required data may vary by integration. To see what data to post, first call [Get create journal model](https://docs.codat.io/sync-for-payables-api#/operations/get-create-journals-model). Check 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. 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/sync-for-payables-api#/schemas/PaymentMethod) for a given company's connection. [Payment methods](https://docs.codat.io/sync-for-payables-api#/schemas/PaymentMethod) are used to pay a Bill. Payment Methods are referenced on [Bill Payments](https://docs.codat.io/sync-for-payables-api#/schemas/BillPayment) and [Payments](https://docs.codat.io/sync-for-payables-api#/schemas/Payment). Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). 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`. [Payment methods](https://docs.codat.io/sync-for-payables-api#/schemas/PaymentMethod) are used to pay a Bill. Payment Methods are referenced on [Bill Payments](https://docs.codat.io/sync-for-payables-api#/schemas/BillPayment) and [Payments](https://docs.codat.io/sync-for-payables-api#/schemas/Payment). Check 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. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). operationId: get-payment-method '/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/sync-for-payables-api#/schemas/Supplier) for a given company's connection. [Suppliers](https://docs.codat.io/sync-for-payables-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. 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`. [Suppliers](https://docs.codat.io/sync-for-payables-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. Check 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. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). 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-supplier-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/sync-for-payables-api#/schemas/Supplier) for a given company and integration. [Suppliers](https://docs.codat.io/sync-for-payables-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. **Integration-specific behaviour** See the *response examples* for integration-specific indicative models. Check 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. '/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/sync-for-payables-api#/schemas/Supplier) for a given company's connection. [Suppliers](https://docs.codat.io/sync-for-payables-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. **Integration-specific behaviour** Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-payables-api#/operations/get-create-update-suppliers-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating a supplier. 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/sync-for-payables-api#/schemas/Supplier) for a given company's connection. [Suppliers](https://docs.codat.io/sync-for-payables-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. **Integration-specific behaviour** Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-payables-api#/operations/get-create-update-suppliers-model). Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support creating a supplier. operationId: update-supplier '/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/sync-for-payables-api#/schemas/TaxRate) for a given company's connection. [Tax rates](https://docs.codat.io/sync-for-payables-api#/schemas/TaxRate) are a set of taxes and associated rates within the SMB's accounting software. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). 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`. [Tax rates](https://docs.codat.io/sync-for-payables-api#/schemas/TaxRate) are a set of taxes and associated rates within the SMB's accounting software. Check 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. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). 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/sync-for-payables-api#/schemas/TrackingCategory) for a given company's connection. [Tracking categories](https://docs.codat.io/sync-for-payables-api#/schemas/TrackingCategory) are used to monitor cost centres and control budgets that sit outside the standard set of accounts. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). 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`. [Tracking categories](https://docs.codat.io/sync-for-payables-api#/schemas/TrackingCategory) are used to monitor cost centres and control budgets that sit outside the standard set of accounts. Check 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. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payables-api#/operations/refresh-company-data). operationId: get-tracking-category '/companies/{companyId}/data/info': parameters: - $ref: '#/components/parameters/companyId' get: summary: Get company accounting profile description: Gets the latest basic info for a company. operationId: get-accounting-profile x-speakeasy-name-override: get-accounting-profile tags: - Company info responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CompanyInfo' 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' webhooks: client.rateLimit.reached: post: description: Called when your client’s request count to Codat's API surpasses the allocated quota. requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientRateLimitWebhook' examples: Reached: value: id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b eventType: client.rateLimit.reached generatedDate: '2024-09-01T00:00:00Z' payload: dailyQuota: 12000 quotaRemaining: 0 expiryDate: '2024-09-01T12:14:14Z' responses: '200': description: Return a 200 status to indicate that the webhook was received successfully. client.rateLimit.reset: post: description: 'Called when your client''s rate limit quota is reset, allowing additional requests to Codat''s API.' requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientRateLimitWebhook' examples: Reset: value: id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b eventType: client.rateLimit.reset generatedDate: '2024-09-01T00:00:00Z' payload: dailyQuota: 12000 quotaRemaining: 11993 expiryDate: '2024-09-01T23:59:99Z' responses: '200': description: Return a 200 status to indicate that the webhook was received successfully. Client rate limit reached: post: deprecated: true description: |- Called when your client’s requests to Codat's API exceed the allocated quota. **Note: This event type is deprecated. Developers should now use the `client.rateLimit.reached` event for handling rate limit notifications.** requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientRateLimitReachedWebhook' responses: '200': description: Return a 200 status to indicate that the webhook was received successfully. Client rate limit reset: post: deprecated: true description: |- Called when the rate limit quota has reset for the client, and more requests to Codat's API are available. Note: This event type is deprecated. Developers should now use the `client.rateLimit.reset` event for handling rate limit notifications. requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientRateLimitResetWebhook' responses: '200': description: Return a 200 status to indicate that the webhook was received successfully. components: schemas: Account: title: 'Accounting: Account' description: "\uFEFF> **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/sync-for-payables-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/Bill/allOf/1' 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: - `Cash On Hand` - `Rents Held In Trust` - `Fixed Asset` examples: - Cash On Hand - Fixed Asset 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_. ## Unknown currencies In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. There 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 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](/sync-for-payables-api#/schemas/ValidDataTypeLinks).' items: 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. For example, `validDatatypeLinks` might indicate the following references: - Which tax rates are valid to use on the line item of a bill. - Which items can be used when creating an invoice. You can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example. ## `validDatatypeLinks` example The 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. ```json validDatatypeLinks for an account { "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", "nominalCode": "090", "name": "Business Bank Account", #... "validDatatypeLinks": [ { "property": "Id", "links": [ "Payment.AccountRef.Id", "BillPayment.AccountRef.Id", "DirectIncome.LineItems.AccountRef.Id", "DirectCost.LineItems.AccountRef.Id" ] } ] } ``` ## Support for `validDatatypeLinks` Codat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations. If 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 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' Address: title: 'Accounting: Address' x-internal: true type: object properties: type: $ref: '#/components/schemas/Address/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 Attachment: title: 'Accounting: Attachment' description: | The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes. > **Retrieving attachments** > > If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data. Unlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments. Note that different integrations have different requirements to file size and extension of attachments. | Integration | File size | File extension | |-------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| | 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 | | QuickBooks Online | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | | NetSuite | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP | | 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". | View the coverage for each integration in the Data coverage explorer. 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**. Supported file types vary per platform. dateCreated: $ref: '#/components/schemas/Connection/properties/created' 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/Bill/allOf/1' 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 Attachments: 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 BankAccount: title: 'Accounting: Bank account' description: |- > **Accessing Bank Accounts through Banking API** > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. > > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/sync-for-payables-api#/schemas/Account) > View the coverage for bank accounts in the Data coverage explorer. ## Overview A list of bank accounts associated with a company and a specific data connection. Bank accounts data includes: * The name and ID of the account in the accounting software. * The currency and balance of the account. * 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/Bill/allOf/1' 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. For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. For 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. Xero integrations The 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. Xero integrations Only 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. FreeAgent integrations For 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/Account/definitions/accountPrototype/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. The 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/PushOperation' 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 Bill: title: 'Accounting: Bill' description: |- > **Invoices or bills?** > > 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. > > See [Invoices](https://docs.codat.io/sync-for-payables-api#/schemas/Invoice) for the accounts receivable equivalent of bills. View the coverage for bills in the Data coverage explorer. ## Overview In Codat, a bill contains details of: * When the bill was recorded in the accounting system. * How much the bill is for and the currency of the amount. * Who the bill was received from — the *supplier*. * What the bill is for — the *line items*. Some 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/sync-for-payables-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: 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.' issueDate: allOf: - description: Date of the bill as recorded in the accounting software. - $ref: '#/components/schemas/Connection/properties/created' dueDate: allOf: - description: Date the supplier is due to be paid. - $ref: '#/components/schemas/Connection/properties/created' currency: $ref: '#/components/schemas/Account/definitions/accountPrototype/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: title: 'Accounting: Payment allocation' type: object properties: payment: $ref: '#/components/schemas/Bill/allOf/0/properties/paymentAllocations/items/definitions/paymentAllocationPayment' allocation: type: object properties: currency: $ref: '#/components/schemas/Account/definitions/accountPrototype/properties/currency' description: The currency of the transaction. currencyRate: $ref: '#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate' allocatedOnDate: $ref: '#/components/schemas/Connection/properties/created' 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/Account/definitions/accountPrototype/properties/currency' description: Currency the payment has been made in. currencyRate: $ref: '#/components/schemas/BillPayment/definitions/billPaymentLineLink/properties/currencyRate' paidOnDate: $ref: '#/components/schemas/Connection/properties/created' description: The date the payment was paid. totalAmount: type: number format: decimal description: Total amount that was paid. metadata: $ref: '#/components/schemas/Metadata' supplementalData: $ref: '#/components/schemas/SupplementalData' - title: Modified dates x-internal: true allOf: - title: ModifiedDate x-internal: true type: object properties: modifiedDate: allOf: - $ref: '#/components/schemas/Connection/properties/created' - description: |- The date when the record was last fetched from the data source and updated in Codat’s data cache. Use 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. This 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)). In 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/Connection/properties/created' - 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. It is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when: - Pulling attachments - The integration platform does not provide modification dates for a data type - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records In Codat's data model, dates and times are represented using the ISO 8601 standard. 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. Do 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/BillCreditNote/definitions/billCreditNoteLineItem/properties/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. For 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 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?** > > In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/sync-for-payables-api#/schemas/CreditNote). View the coverage for bill credit notes in the Data coverage explorer. ## Overview A 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. In the Codat API, a bill credit note is an accounts payable record issued by a [supplier](https://docs.codat.io/sync-for-payables-api#/schemas/Supplier). A bill credit note includes details of: * The original and remaining credit. * Any allocations of the credit against other records, such as [bills](https://docs.codat.io/sync-for-payables-api#/schemas/Bill). * 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/Connection/properties/created' description: Date the bill credit note was issued by the supplier. example: '2022-03-15T00:00:00' allocatedOnDate: $ref: '#/components/schemas/Connection/properties/created' nullable: true description: Date the bill credit note was fully refunded or allocated. example: '2022-09-15T16:35:00' currency: $ref: '#/components/schemas/Account/definitions/accountPrototype/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/Bill/allOf/0/properties/paymentAllocations/items' createdFromRefs: nullable: true type: array description: An array of records the credit note was created from. items: type: object x-internal: true title: Record reference description: |- Links the current record to the underlying record or data type that created it. For 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 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/Bill/allOf/1' 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: description: Reference to the item the line is linked to. 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 createdFromLineRef: $ref: '#/components/schemas/Bill/definitions/billLineItem/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: 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 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. 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?** > > 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. > > See [payments](https://docs.codat.io/sync-for-payables-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/sync-for-payables-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/sync-for-payables-api#/schemas/CreditNote). > View the coverage for bill payments in the Data coverage explorer. ## Overview Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/sync-for-payables-api#/schemas/BillCreditNote)). A bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to: - A payment made against a bill — for example, a credit card payment, cheque payment, or cash payment. - An allocation of a supplier's credit note to a bill or perhaps a refund. - 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. Depending 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. In Codat, a bill payment contains details of: - When the bill payment was recorded in the accounting system. - How much it is for and in the currency. - Who the payment has been paid to, the _supplier_. - The types of bill payments, the _line items_. Some 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/sync-for-payables-api#/schemas/DirectCost) data model. Bill payments is a child data type of [account transactions](https://docs.codat.io/sync-for-payables-api#/schemas/AccountTransaction). --- ## Bill payment types ### Payment of a bill A payment paying a single bill should have the following properties: - A `totalAmount` indicating the amount of the bill that was paid. This is always positive. - A `lines` array containing one element with the following properties: - An `amount` equal to the `totalAmount` above. - A `links` array containing one element with the following properties: - A `type` indicating the type of link, in this case a `Bill`. - An `id` containing the ID of the bill that was paid. - An amount of `-totalAmount` (negative `totalAmount`), indicating that the entirety of the paid amount is allocated to the bill. ### Payment of multiple bills It 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: 1. 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. 2. 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. Each 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. > Pushing batch payments to Xero > > 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. ### Payments and refunds on account A payment on account, that is a payment that doesn’t pay a specific bill, has one entry in its lines array. The line has the following properties: - 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. - A **links** array containing one element with the following properties: - A **type** indicating the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`. - The **id** containing the ID of the supplier. - An amount for the link is `0` **totalAmount** or the amount of the payment or refund. It is possible to have a payment that is part on account and part allocated to a bill. Each line should follow the examples above. ### Using a credit note to pay a bill The payment of a bill using a credit note has one entry in its `lines` array. This **line** has the following properties: - 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. - A **links** array containing two elements: - The first link has: - A **type** indicating the type of link, in this case a `Bill`. - An **id** containing the ID of the bill that was paid. - The second link has: - A **type** indicating the type of link, in this case a `CreditNote`. - An **id** containing the ID of the credit note used by this payment. The **amount** field on the **line** equals the **totalAmount** on the payment. ### Refunding a credit note A bill payment refunding a credit note has one entry in its **lines** array. This line has the following properties: - An **amount** indicating the amount of the credit note that was refunded. This is always negative, indicating that it is a refund. - A **links** array containing one element with the following properties: - A **type** indicating the type of `link`, in this case a `CreditNote`. - An **id** containing the ID of the credit note that was refunded. The **totalAmount** field on the payment equals the line's **amount** field. These are both negative, as this is money leaving accounts payable. ### Refunding a payment If a payment is refunded, for example, when a company overpaid a bill and the overpayment is returned, there are two payment records: - One for the incoming overpayment. - Another for the outgoing refund. The 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: - An **amount** indicating the amount that was refunded. This is always negative. - A **links** array containing one element with the following properties: - A **type** indicating the type of a the link, in this case a `BillPayment`. - An **id** containing the ID of the payment that was refunded. The **amount** field on the line equals the **totalAmount** on the payment and is negative as this is money leaving accounts payable. The 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: - One for £1,000 linked to the bill that was paid - 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. The line linked to the bill payment has the following properties: - 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. - A **links** array containing one element with the following properties: - A **type** indicating the type of the link, in this case a `Refund`. - An **id** containing the ID of the payment that refunded this line. > Linked payments > > 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. ## Foreign currencies There are two types of currency rate that are detailed in the bill payments data type: Payment currency rate: - Base currency of the accounts payable account. - Foreign currency of the bill payment. Payment line link currency rate: - Base currency of the item that the link represents. - Foreign currency of the payment. These 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: - The base currency for the accounts payable account. - The currency of the item. 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/Account/definitions/accountPrototype/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/Connection/properties/created' - 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/Bill/allOf/1' 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/Connection/properties/created' 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. - A negative link amount reduces the outstanding amount on the accounts payable account. - 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. Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. It 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. Where 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). For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places. ## Examples with base currency of GBP | Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (GBP) | | :--------------- | :------------- | :------------ | :------------------------- | | **USD** | $20 | 0.781 | £15.62 | | **EUR** | €20 | 0.885 | £17.70 | | **RUB** | ₽20 | 0.011 | £0.22 | ## Examples with base currency of USD | Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (USD) | | :--------------- | :------------- | :------------ | :------------------------- | | **GBP** | £20 | 1.277 | $25.54 | | **EUR** | €20 | 1.134 | $22.68 | | **RUB** | ₽20 | 0.015 | $0.30 | ### Integration-specific details | Integration | Scenario | System behavior | |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 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' ClientRateLimitReachedWebhook: title: Client rate limit reached webhook x-internal: true description: Webhook request body for a client that has reached their rate limit. type: object properties: ClientId: $ref: '#/components/schemas/ClientRateLimitResetWebhook/properties/ClientId' ClientName: $ref: '#/components/schemas/ClientRateLimitResetWebhook/properties/ClientName' RuleId: $ref: '#/components/schemas/ClientRateLimitResetWebhook/properties/RuleId' RuleType: $ref: '#/components/schemas/ClientRateLimitResetWebhook/properties/RuleType' AlertId: $ref: '#/components/schemas/ClientRateLimitResetWebhook/properties/AlertId' Message: $ref: '#/components/schemas/ClientRateLimitResetWebhook/properties/Message' Data: $ref: '#/components/schemas/ClientRateLimitReachedWebhook/definitions/ClientRateLimitReachedWebhookData' definitions: ClientRateLimitReachedWebhookData: type: object title: Client rate limit reached webhook data properties: DailyQuota: type: integer description: The number of available requests per day. ExpiresUtc: $ref: '#/components/schemas/Connection/properties/created' description: The date time in UTC when your daily quota is reset. examples: - ClientId: bae71d36-ff47-420a-b4a6-f8c9ddf41140 ClientName: Bank of Dave RuleId: 70af3071-65d9-4ec3-b3cb-5283e8d55dac RuleType: Rate Limit Reached AlertId: a9367074-b5c3-42c4-9be4-be129f43577e Message: The current daily rate limit quota of 1000 requests for bae71d36-ff47-420a-b4a6-f8c9ddf41140 has been reached. Data: DailyQuota: 1000 ExpiresUtc: '2023-05-03T00:00:00Z' ClientRateLimitResetWebhook: title: Client rate limit reset webhook x-internal: true description: Webhook request body for a client that has had their rate limit reset. type: object properties: ClientId: title: Client ID type: string format: uuid description: Unique identifier for your client in Codat. ClientName: type: string description: Name of your client in Codat. RuleId: type: string format: uuid description: Unique identifier for the rule. deprecated: true RuleType: type: string x-stoplight: id: 34d52a089f08a description: The type of rule. AlertId: type: string format: uuid description: Unique identifier of the webhook event. Message: type: string description: A human-readable message about the webhook. Data: $ref: '#/components/schemas/ClientRateLimitResetWebhook/definitions/ClientRateLimitResetWebhookData' definitions: ClientRateLimitResetWebhookData: type: object title: Client rate limit reset webhook data properties: QuotaRemaining: type: integer description: Total number of requests remaining for your client. nullable: true ResetReason: type: string description: The reason for your rate limit quota being reset. DailyQuota: $ref: '#/components/schemas/ClientRateLimitReachedWebhook/definitions/ClientRateLimitReachedWebhookData/properties/DailyQuota' nullable: true ExpiresUtc: $ref: '#/components/schemas/ClientRateLimitReachedWebhook/definitions/ClientRateLimitReachedWebhookData/properties/ExpiresUtc' nullable: true examples: - ClientId: bae71d36-ff47-420a-b4a6-f8c9ddf41140 ClientName: Bank of Dave RuleId: 70af3071-65d9-4ec3-b3cb-5283e8d55dac RuleType: Rate Limit Reset AlertId: a9367074-b5c3-42c4-9be4-be129f43577e Message: The current daily rate limit quota for client 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e has been reset to 1000 requests. Data: QuotaRemaining: 1000 ResetReason: The quota was reset because it is a new day. DailyQuota: 1000 ExpiresUtc: '2023-05-03T00:00:00Z' ClientRateLimitWebhook: title: Client rate limit webhook type: object properties: id: type: string format: uuid example: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b description: Unique identifier of the event. eventType: type: string description: The type of event. examples: - client.rateLimit.reset - client.rateLimit.reached generatedDate: $ref: '#/components/schemas/Connection/properties/created' description: The date time in UTC the event was generated in Codat. payload: $ref: '#/components/schemas/ClientRateLimitWebhook/definitions/clientRateLimitWebhookPayload' definitions: clientRateLimitWebhookPayload: title: Client rate limit webhook payload type: object properties: dailyQuota: type: integer description: The number of available requests per day. quotaRemaining: type: integer description: Total number of requests remaining for your client. expiryDate: $ref: '#/components/schemas/Connection/properties/created' description: The date time in UTC when your daily quota is reset. Companies: title: Companies x-internal: true allOf: - type: object properties: results: type: array items: $ref: '#/components/schemas/Company' - $ref: '#/components/schemas/PagingInfo' Company: title: Company description: "\uFEFFIn Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/sync-for-payables-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data.\n\nTypically each company is one of your customers.\n\nWhen you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company." type: object allOf: - $ref: '#/components/schemas/Company/definitions/companyDetails' - type: object properties: dataConnections: type: array items: $ref: '#/components/schemas/Connection' definitions: companyDetails: title: Company details type: object properties: id: $ref: '#/components/parameters/companyId/schema' name: type: string description: The name of the company example: Codat Ltd. description: $ref: '#/components/schemas/CompanyRequestBody/properties/description' nullable: true redirect: type: string format: uri description: 'The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company.' example: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' lastSync: $ref: '#/components/schemas/Connection/properties/created' nullable: true created: $ref: '#/components/schemas/Connection/properties/created' createdByUserName: type: string description: Name of user that created the company in Codat. nullable: true products: type: array items: type: string description: An array of products that are currently enabled for the company. tags: type: object maxProperties: 10 propertyNames: pattern: '^.{1,27}$' additional properties: type: string maxLength: 100 description: A collection of user-defined key-value pairs that store custom metadata against the company. required: - id - name - redirect companyReference: title: Company reference type: object properties: id: $ref: '#/components/parameters/companyId/schema' name: $ref: '#/components/schemas/Company/definitions/companyDetails/properties/name' description: $ref: '#/components/schemas/Company/definitions/companyDetails/properties/description' links: type: object description: A collection of links for the company. properties: portal: type: string format: uri description: Link to the company page in the portal. tags: $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' examples: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 name: string redirect: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' lastSync: '2022-01-01T12:00:00.000Z' created: '2022-01-01T12:00:00.000Z' createdByUserName: string tags: region: us uid: f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c dataConnections: - id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c integrationKey: dfxm sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee platformName: Basiq linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' status: Linked lastSync: '2022-10-27T10:22:43.6464237Z' created: '2022-10-27T09:53:29Z' sourceType: Banking CompanyInfo: title: 'Accounting: Company profile' description: |- > View the coverage for company profile in the Data coverage explorer. Company info provides standard details about a linked company such as their address, phone number, and company registration. > **Company information or companies?** > > 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: $ref: '#/components/schemas/Address' phoneNumbers: type: array nullable: true description: An array of phone numbers. items: $ref: '#/components/schemas/PhoneNumber' webLinks: type: array nullable: true description: An array of weblinks. items: $ref: '#/components/schemas/WebLink' ledgerLockDate: $ref: '#/components/schemas/Connection/properties/created' 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/Connection/properties/created' 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. For 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/Connection/properties/created' 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' CompanyRequestBody: title: Create company request x-internal: true type: object properties: name: type: string description: Name of company being connected. pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' minLength: 1 example: Bank of Dave description: type: string example: Requested early access to the new financing scheme. description: 'Additional information about the company. This can be used to store foreign IDs, references, etc.' tags: $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' required: - name Connection: title: Connection description: "\uFEFFA connection represents a [company's](https://docs.codat.io/sync-for-payables-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.\n\nA company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:\n\n- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.\n- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.\n- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.\nAny combination of accounting, banking, and commerce data connections is allowed.\n\nBefore you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview)." type: object properties: id: $ref: '#/components/parameters/connectionId/schema' integrationId: type: string format: uuid example: fd321cb6-7963-4506-b873-e99593a45e30 description: A Codat ID representing the integration. integrationKey: type: string description: A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. sourceId: type: string format: uuid example: 35b92968-9851-4095-ad60-395c95cbcba4 description: 'A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`.' sourceType: title: Source Type description: The type of platform of the connection. type: string enum: - Accounting - Banking - BankFeed - Commerce - Expense - Other - Unknown example: Accounting platformName: type: string description: Name of integration connected to company. linkUrl: type: string format: uri description: The link URL your customers can use to authorize access to their business application. example: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start' status: $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' lastSync: $ref: '#/components/schemas/Connection/properties/created' nullable: true created: 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: ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` > Time zones > > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. dataConnectionErrors: type: array nullable: true items: $ref: '#/components/schemas/Connection/definitions/dataConnectionError' connectionInfo: type: object nullable: true additionalProperties: type: string additionalProperties: false required: - id - integrationId - integrationKey - sourceId - platformName - linkUrl - status - created - sourceType definitions: dataConnectionStatus: title: Data connection status description: The current authorization status of the data connection. type: string enum: - PendingAuth - Linked - Unlinked - Deauthorized dataConnectionError: title: Data connection error type: object properties: statusCode: type: string description: The HTTP status code returned by the source platform when the error occurred. statusText: type: string description: A non-numeric status code/text returned by the source platform when the error occurred. errorMessage: type: string description: A message about a error returned by Codat. erroredOnUtc: $ref: '#/components/schemas/Connection/properties/created' status: title: Error status description: The current status of a transient error. Null statuses indicate that the error is not transient. type: string nullable: true enum: - Active - Resolved resolvedOnUtc: description: The datetime in Utc that the error was resolved. nullable: true $ref: '#/components/schemas/Connection/properties/created' dataConnectionSourceType: title: Source Type description: The type of platform of the connection. type: string enum: - Accounting - Banking - BankFeed - Commerce - Expense - Other - Unknown example: Accounting example: id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c integrationKey: dfxm sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee platformName: Basiq linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' status: Linked lastSync: '2022-10-27T10:22:43.6464237Z' created: '2022-10-27T09:53:29Z' sourceType: Banking Connections: title: Connections x-internal: true allOf: - type: object properties: results: type: array items: $ref: '#/components/schemas/Connection' - $ref: '#/components/schemas/PagingInfo' CreateAccountResponse: title: 'Accounting: Create account response' x-internal: true allOf: - type: object properties: data: allOf: - $ref: '#/components/schemas/Account' - deprecated: true - $ref: '#/components/schemas/PushOperation' 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/PushOperation' 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/PushOperation' CreateBillResponse: title: 'Accounting: Create bill response' x-internal: true allOf: - type: object properties: data: allOf: - $ref: '#/components/schemas/Bill' - deprecated: true - $ref: '#/components/schemas/PushOperation' 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/PushOperation' CreateJournalResponse: title: 'Accounting: Create journal response' x-internal: true allOf: - type: object properties: data: allOf: - $ref: '#/components/schemas/Journal' - deprecated: true - $ref: '#/components/schemas/PushOperation' CreateSupplierResponse: title: 'Accounting: Create supplier response' x-internal: true allOf: - type: object properties: data: allOf: - $ref: '#/components/schemas/Supplier' - deprecated: true - $ref: '#/components/schemas/PushOperation' DataStatus: title: Data status description: Describes the state of data in the Codat cache for a company and data type type: object required: - dataType - lastSuccessfulSync - currentStatus properties: 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 lastSuccessfulSync: $ref: '#/components/schemas/Connection/properties/created' currentStatus: $ref: '#/components/schemas/PullOperation/properties/status' latestSyncId: type: string description: Unique identifier for most recent sync of data type. format: uuid example: ad474a37-2003-478e-baee-9af9f1ec2fe3 latestSuccessfulSyncId: type: string description: Unique identifier for the most recent successful sync of data type. format: uuid example: 8220fc90-55b6-47bc-9417-48ac6ea93101 examples: - dataType: string lastSuccessfulSync: '2022-01-01T13:00:00.000Z' currentStatus: string latestSyncId: ad474a37-2003-478e-baee-9af9f1ec2fe3 latestSuccessfulSyncId: 8220fc90-55b6-47bc-9417-48ac6ea93101 DataStatusResponse: x-internal: true title: Data status response type: object additionalProperties: $ref: '#/components/schemas/DataStatus' DataType: x-internal: true $ref: '#/components/schemas/DataStatus/properties/dataType' 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. 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/sync-for-payables-api#/schemas/JournalEntry) data type > View the coverage for journals in the Data coverage explorer. ## Overview In 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/sync-for-payables-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business. When 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. Such journals can be divided into two categories: - Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal. - General journals: journals used to record transactions that fall outside the scope of the special journals. Multiple journals or subjournals are used in the following Codat integrations: - [Sage Intacct](https://docs.codat.io/integrations/accounting/sage-intacct/accounting-sage-intacct) (mandatory) - [Exact Online](https://docs.codat.io/integrations/accounting/exact-online/accounting-exact-online) (mandatory) - [Oracle NetSuite](https://docs.codat.io/integrations/accounting/netsuite/accounting-netsuite) (optional) > 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. 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/Bill/allOf/1' definitions: journalPrototype: type: object properties: journalCode: type: string nullable: true description: Native journal number or code. name: type: string nullable: true description: |- Journal name. The 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. If 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/Connection/properties/created' 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 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/sync-for-payables-api#/schemas/Journal) data type > View the coverage for journal entries in the Data coverage explorer. ## Overview A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/sync-for-payables-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance. A journal entry line item is a single transaction line on the journal entry. For example: - When a journal entry is recording a receipt of cash, the credit to accounts receivable and the debit to cash are separate line items. - 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. In Codat a journal entry contains details of: - The date on which the entry was created and posted. - Itemised lines, including amounts and currency. - A reference to the associated accounts. - 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. > **Pushing journal entries** > 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/Connection/properties/created' 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. For 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. The **createdOn** date shows as Monday. The **postedOn** date shows as Thursday. Journal entries can also be backdated, so the **postedOn** date may be earlier than the **createdOn** date. createdOn: $ref: '#/components/schemas/Connection/properties/created' description: Date on which the journal was created in the accounting software. updatedOn: $ref: '#/components/schemas/Connection/properties/created' 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/Bill/allOf/1' 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: description: 'List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.)' title: Tracking type: object properties: recordRefs: type: array items: $ref: '#/components/schemas/JournalEntry/definitions/journalLine/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 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 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' PaymentMethod: title: 'Accounting: Payment method' description: |- > View the coverage for payment methods in the Data coverage explorer. ## Overview A Payment Method represents the payment method(s) used to pay a Bill. Payment Methods are referenced on [Bill Payments](https://docs.codat.io/sync-for-payables-api#/schemas/BillPayment) and [Payments](https://docs.codat.io/sync-for-payables-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/Bill/allOf/1' 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' PhoneNumber: 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/PhoneNumber/definitions/phoneNumberType' required: - type definitions: phoneNumberType: description: The type of phone number type: string enum: - Primary - Landline - Mobile - Fax - Unknown PullOperation: title: Pull operation description: |- Information about a queued, in progress or completed pull operation. *Formally called `dataset`* type: object properties: id: type: string format: uuid description: Unique identifier of the pull operation. example: 943accd0-4247-42d8-865b-363c8629e1da companyId: type: string format: uuid description: Unique identifier of the company associated to this pull operation. example: 22ece347-e5f6-4896-95e0-35a4c7f17023 connectionId: type: string format: uuid description: Unique identifier of the connection associated to this pull operation. example: 50830828-7d39-4367-b0eb-5ddb2de5faa5 dataType: title: Data types x-internal: true type: string description: The data type you are requesting in a pull operation. status: 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 statusDescription: type: string nullable: true description: Additional information about the dataset status. example: 'Paused until 2022-10-23T00:00:00.000Z' errorMessage: type: string nullable: true description: A message about a transient or persistent error returned by Codat or the source platform. requested: $ref: '#/components/schemas/Connection/properties/created' completed: $ref: '#/components/schemas/Connection/properties/created' progress: type: integer description: An integer signifying the progress of the pull operation. isCompleted: type: boolean description: '`True` if the pull operation is completed successfully. The `isCompleted` property is not queryable. To filter failed pull operations, query by `status!=Complete&&status!=NotSupported` instead.' isErrored: type: boolean description: '`True` if the pull operation entered an error state.' required: - id - companyId - connectionId - dataType - status - requested - progress - isCompleted - isErrored examples: - id: 97d60846-f07a-4d42-b5a0-0bdcc6ebf56b companyId: 4645bd78-8988-45bc-ac9e-67ba5df6e4e5 connectionId: 51baa045-4836-4317-a42e-3542e991e581 dataType: invoices status: Initial statusDescription: 'Paused until 2022-10-23T00:00:00.000Z' requested: '2022-11-14T11:18:37.2798351Z' progress: 10 isCompleted: false isErrored: false PullOperations: title: Pull operations x-internal: true allOf: - type: object properties: results: type: array items: $ref: '#/components/schemas/PullOperation' - $ref: '#/components/schemas/PagingInfo' PushOperation: 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/PushOperation/definitions/pushOperationChange' dataType: $ref: '#/components/schemas/DataStatus/properties/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/Connection/properties/created' description: The datetime when the push was requested. completedOnUtc: $ref: '#/components/schemas/Connection/properties/created' 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/PushOperation/definitions/pushOperationStatus' errorMessage: type: string nullable: true description: A message about the error. validation: $ref: '#/components/schemas/PushOperation/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/PushOperation/definitions/validationItem' warnings: type: array nullable: true items: $ref: '#/components/schemas/PushOperation/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/DataStatus/properties/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/PushOperation/definitions/pushChangeType' recordRef: $ref: '#/components/schemas/PushOperation/definitions/pushOperationRef' attachmentId: type: string description: Unique identifier for the attachment created otherwise null. nullable: true PushOperations: title: Push operations x-internal: true allOf: - type: object properties: results: type: array items: $ref: '#/components/schemas/PushOperation' - $ref: '#/components/schemas/PagingInfo' 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' SupplementalData: title: Supplemental data type: object x-internal: true description: |- Supplemental data is additional data you can include in our standard data types. It 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. ## Overview From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-payables-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-payables-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/Address' 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/Bill/allOf/1' 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: "\uFEFF> 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/Account/definitions/accountPrototype/properties/validDatatypeLinks/items' metadata: $ref: '#/components/schemas/Metadata' supplementalData: $ref: '#/components/schemas/SupplementalData' - $ref: '#/components/schemas/Bill/allOf/1' 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. Found on: - Bill line items - Bill Credit Note line items - Credit Note line items - Direct incomes line items - Invoice line items - 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. - `Active` - An active tax rate in use by a company. - `Archived` - A tax rate that has been archived or is inactive in the accounting software. - `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. > Language tip > > 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. View the coverage for tracking categories in the Data coverage explorer. ## Overview Tracking 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. From their accounting system, customers can: - Create and maintain tracking categories and tracking category types. - View all tracking categories that are available for use. - View the relationships between the categories. - Assign invoices, bills, credit notes, or bill credit notes to one or more categories. - View the categories that a transaction belongs to. - View all transactions in a tracking category. ### Tracking categories per platform Review the platform-specific tracking categories that Codat supports, and the level they are assigned to in the source platform.
Platform Tracking category Tracking level
Dynamics 365 Dimensions Line item
Freshbooks Expense categories Line item
MYOB Categories Transaction
Netsuite Classes Line item
Locations Line item
Departments Line item
Custom segments Line item
QuickBooks Desktop Classes Line item or transaction level
Locations Transaction
QuickBooks Online Classes Line item or transaction level
Locations Transaction
Sage 200 Cost centers Line item
Departments Line item
Analysis codes Transaction
Sage 50 Departments Line item
Costcodes Line item
Projects Line item
Sage Intacct Dimensions Line item
Xero Tracking categories Line item
> **Example use case** > > Monitor the budget for your annual conference using a tracking category called 'AnnualConference2020' with the **type** set to **Costing**. If 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/Bill/allOf/1' 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/Bill/allOf/1' 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/PushOperation' UpdateBillResponse: title: 'Accounting: Update bill response' x-internal: true allOf: - type: object properties: data: allOf: - $ref: '#/components/schemas/Bill' - deprecated: true - $ref: '#/components/schemas/PushOperation' UpdateSupplierResponse: title: 'Accounting: Update supplier response' x-internal: true allOf: - type: object properties: data: allOf: - $ref: '#/components/schemas/Supplier' - deprecated: true - $ref: '#/components/schemas/PushOperation' WebLink: 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' parameters: 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).' 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. dataType: name: dataType description: The key of a Codat data type in: path required: true schema: $ref: '#/components/schemas/DataType' datasetId: name: datasetId in: path required: true schema: type: string format: uuid description: Unique identifier for the dataset that completed its sync. description: Unique identifier for the dataset that completed its sync. accountId: name: accountId in: path required: true schema: type: string examples: $ref: '#/components/parameters/billId/schema/examples' description: Unique identifier for an account. 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.' 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. billPaymentId: name: billPaymentId in: path required: true schema: type: string examples: $ref: '#/components/parameters/billId/schema/examples' description: Unique identifier for a bill payment. 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. attachmentId: name: attachmentId in: path required: true schema: type: string format: uuid example: 8a210b68-6988-11ed-a1eb-0242ac120002 description: Unique identifier for an attachment. supplierId: name: supplierId in: path required: true schema: type: string examples: $ref: '#/components/parameters/billId/schema/examples' description: Unique identifier for a supplier. journalId: name: journalId in: path required: true schema: type: string description: Unique identifier for a journal. paymentMethodId: name: paymentMethodId in: path required: true schema: type: string examples: $ref: '#/components/parameters/billId/schema/examples' description: Unique identifier for a payment method. 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. 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: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io. 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. This 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/sync-for-payables-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)