diff --git a/.speakeasy/logs/changes/changes.html b/.speakeasy/logs/changes/changes.html index 17e85681b..1c0b66280 100644 --- a/.speakeasy/logs/changes/changes.html +++ b/.speakeasy/logs/changes/changes.html @@ -98,34 +98,7 @@

Typescript SDK Changes:

\ No newline at end of file diff --git a/.speakeasy/logs/changes/changes.md b/.speakeasy/logs/changes/changes.md index 89063f8e8..0a3b39549 100644 --- a/.speakeasy/logs/changes/changes.md +++ b/.speakeasy/logs/changes/changes.md @@ -1,20 +1,2 @@ ## Typescript SDK Changes: -* `codatsyncexpenses.connections.create()`: `response.connectionInfo.Map` **Changed** (Breaking ⚠️) -* `codatsyncexpenses.companies.list()`: - * `request.tags` **Added** - * `response.results[].dataConnections[].connectionInfo.Map` **Changed** (Breaking ⚠️) -* `codatsyncexpenses.companies.create()`: `response.dataConnections[].connectionInfo.Map` **Changed** (Breaking ⚠️) -* `codatsyncexpenses.companies.update()`: - * `request` **Changed** (Breaking ⚠️) - - `companyRequestBody` **Removed** (Breaking ⚠️) - - `companyUpdateRequest` **Added** - * `response.dataConnections[].connectionInfo.Map` **Changed** (Breaking ⚠️) -* `codatsyncexpenses.companies.get()`: `response.dataConnections[].connectionInfo.Map` **Changed** (Breaking ⚠️) -* `codatsyncexpenses.connections.list()`: `response.results[].connectionInfo.Map` **Changed** (Breaking ⚠️) -* `codatsyncexpenses.connections.get()`: `response.connectionInfo.Map` **Changed** (Breaking ⚠️) -* `codatsyncexpenses.connections.unlink()`: `response.connectionInfo.Map` **Changed** (Breaking ⚠️) -* `codatsyncexpenses.connections.createPartnerExpenseConnection()`: `response.connectionInfo.Map` **Changed** (Breaking ⚠️) -* `codatsyncexpenses.companies.replace()`: **Added** -* `codatsyncexpenses.manageData.refreshAllDataTypes()`: `error.status[400]` **Added** -* `codatsyncexpenses.manageData.get()`: `response.accountTransactions.lastSuccessfulSync` **Changed** -* `codatsyncexpenses.manageData.refreshDataType()`: `error.status[400]` **Added** +* `codatsyncpayables.suppliers.update()`: **Added** diff --git a/.speakeasy/logs/changes/new.openapi.yaml b/.speakeasy/logs/changes/new.openapi.yaml index 2b0ee26d6..9eb8b91e3 100644 --- a/.speakeasy/logs/changes/new.openapi.yaml +++ b/.speakeasy/logs/changes/new.openapi.yaml @@ -1,21 +1,27 @@ openapi: 3.1.0 +servers: + - description: Production + url: 'https://api.codat.io' info: - title: Expenses - version: prealpha - contact: - name: Codat - url: 'https://www.codat.io/' - email: expenses@codat.io + title: Bill pay (synchronous solution) description: |- - The API for Codat's Expenses solution. + The API reference for the synchronous Bill Pay solution. + + The synchronous Bill Pay solution is an API and a set of supporting tools designed to integrate a bill pay flow into your app as quickly as possible. It's ideal for facilitating essential bill payment processes within your SMB's accounting software. - Expenses is an API and a set of supporting tools. It has been built to - enable corporate card and expense management platforms to provide high-quality - integrations with multiple accounting software through a standardized API. + [Explore solution](https://docs.codat.io/payables/overview) | [See OpenAPI spec](https://github.com/codatio/oas) - [Explore solution](https://docs.codat.io/sync-for-expenses/overview) | [See our OpenAPI spec](https://github.com/codatio/oas) + --- + ## Supported Integrations - Not seeing the endpoints you're expecting? We've [reorganized our solutions](https://docs.codat.io/updates/230901-new-products), and you may be using a [different version of Expenses](https://docs.codat.io/sync-for-expenses-v1-api#/). + | Integration | Supported | + |-------------------------------|-----------| + | FreeAgent | Yes | + | QuickBooks Online | Yes | + | Oracle NetSuite | Yes | + | Sage Intacct | Yes | + | Xero | Yes | + | Zoho Books | Yes | --- @@ -25,19 +31,16 @@ info: | :- |:- | | Companies | Create and manage your SMB users' companies. | | Connections | Create new and manage existing data connections for a company. | - | Configuration | View and manage mapping configuration and defaults for expense transactions. | - | Sync | Monitor the status of data syncs. | - | Expenses | Create and update transactions that represent your customers' spend. | - | Transfers | Create and update transactions that represent the movement of your customers' money. | - | Reimbursements | Create and update transactions that represent your customers' repayable spend. | - | Attachments | Attach receipts to a transaction for a complete audit trail. | - | Transaction status | Monitor the status of individual transactions in data syncs. | - | Manage data | Control and monitor the retrieval of data from an integration. | - | Push operations | View historic push operations. | - | Accounts | Create accounts and view account schemas. | - | Customers | Get, create, and update customers. | - | Suppliers | Get, create, and update suppliers. | + | Company information | View company profile from the source platform. | + | Bills | Get, create, and update Bills. | + | Bill payments | Get, create, and update Bill payments. | + | Suppliers | Get, create, and update Suppliers. | + | Bank accounts | Create a bank account for a given company's connection. | + version: 3.0.0 + contact: + name: Codat + email: support@codat.io termsOfService: 'https://www.codat.io/legals/' security: - auth_header: [] @@ -78,7 +81,7 @@ x-speakeasy-name-override: methodNameOverride: download-attachment - operationId: ^upload-.*?-attachment methodNameOverride: upload-attachment -x-codat-docs-path: sync-for-expenses-api +x-codat-docs-path: sync-for-payables-api x-codat-keep-docs-paths-local: true x-codat-speakeasy-pagination: type: offsetLimit @@ -93,40 +96,16 @@ tags: description: Create and manage your SMB users' companies. - name: Connections description: Create new and manage existing data connections for a company. - - name: Company info - description: View the company information of your customers' linked accounting software. - - name: Manage data - description: Control and monitor the retrieval of data from an integration. - - name: Mapping options - description: 'Get accounts, trackingCategories and taxRates that can be used in your create and update requests.' - - name: Accounts - description: Create accounts and view create account options. - - name: Bank accounts - description: Create bank accounts and view create bank account options. - - name: Customers - description: 'Get, create, and update customers.' + - name: Company information + description: View company profile from the source platform. + - name: Bills + description: 'Get, create, and update Bills.' + - name: Bill payments + description: 'Get, create, and update Bill payments.' - name: Suppliers - description: 'Get, create, and update suppliers.' - - name: Push operations - description: View historic push operations. - - name: Configuration - description: View and manage mapping configuration and defaults for expense transactions. - - name: Expenses - description: Create and update transactions that represent your customers' spend. - - name: Reimbursements - description: Create and update transactions that represent your customers' repayable spend. - - name: Transfers - description: Create and update transactions that represent the movement of your customers' money. - - name: Adjustments - description: Create transactions that represent your adjustments to your customers' spend. - - name: Attachments - description: Attach receipts to a transaction for a complete audit trail. - - name: Sync - description: Monitor the status of data syncs. - - name: Transaction status - description: Monitor the status of individual transactions in data syncs. -servers: - - url: 'https://api.codat.io' + description: 'Get, create, and update Suppliers.' + - name: Bank accounts + description: Create a bank account for a given company's connection. paths: /companies: get: @@ -296,7 +275,7 @@ paths: '503': $ref: '#/components/responses/Service-Unavailable' operationId: list-companies - description: "\uFEFFThe *List companies* endpoint returns a list of [companies](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) associated to your instances.\n\nA [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-expenses-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\n## Filter by tags\n\nThe *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying):\n\n- equals (`=`)\n- not equals (`!=`)\n- contains (`~`)\n\nFor example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team: \n- Foreign key: `uid = {yourCustomerId}`\n- Region: `region != uk`\n- Owning team and region: `region = uk && owningTeam = invoice-finance`" + description: "\uFEFFThe *List companies* endpoint returns a list of [companies](https://docs.codat.io/sync-for-payables-api#/schemas/Company) 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.\n\n## Filter by tags\n\nThe *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying):\n\n- equals (`=`)\n- not equals (`!=`)\n- contains (`~`)\n\nFor example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team: \n- Foreign key: `uid = {yourCustomerId}`\n- Region: `region != uk`\n- Owning team and region: `region = uk && owningTeam = invoice-finance`" parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' @@ -377,7 +356,7 @@ paths: $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-expenses-api#/schemas/Company) that represents your customer in Codat. \n\nA [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-expenses-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`." + 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: @@ -394,7 +373,7 @@ paths: '/companies/{companyId}': put: summary: Replace company - description: "\uFEFFUse the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.\n\nA [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-expenses-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." + description: "\uFEFFUse the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.\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: replace-company x-speakeasy-name-override: replace parameters: @@ -437,7 +416,7 @@ paths: description: Additional documents required patch: summary: Update company - description: "\uFEFFUse the *Update company* endpoint to update the name, description, or tags of the company.\n\nThe *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update. \n\nA [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data." + description: "\uFEFFUse the *Update company* endpoint to update the name, description, or tags of the company.\n\nThe *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update. \n\nA [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company) represents a business sharing access to their data." operationId: update-company parameters: - $ref: '#/components/parameters/companyId' @@ -482,7 +461,7 @@ paths: operationId: delete-company parameters: - $ref: '#/components/parameters/companyId' - description: "\uFEFFThe *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company), its [connections](https://docs.codat.io/sync-for-expenses-api#/schemas/Connection) and any cached data. This operation is irreversible.\n\nA [company](https://docs.codat.io/sync-for-expenses-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-expenses-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" + 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: @@ -505,7 +484,7 @@ paths: 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-expenses-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-expenses-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" + 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: @@ -839,49 +818,18 @@ paths: value: status: Unlinked description: '' - '/companies/{companyId}/sync/expenses/connections/partnerExpense': - post: - tags: - - Connections - description: Creates a partner expense data connection - summary: Create partner expense connection - operationId: create-partner-expense-connection - x-speakeasy-name-override: create-partner-expense-connection - parameters: - - $ref: '#/components/parameters/companyId' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/Connection' - 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' - '/companies/{companyId}/data/info': + '/companies/{companyId}/connections/{connectionId}/payables/info': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' get: + summary: Get company information + description: |+ + Use the *Get company information* endpoint to return information about the company available from the underlying accounting software. + + operationId: get-company-information tags: - - Company info - summary: Get company info - description: Gets the latest basic info for a company. - operationId: get-company-info - parameters: - - $ref: '#/components/parameters/companyId' + - Company information responses: '200': description: Success @@ -890,43 +838,12 @@ paths: schema: $ref: '#/components/schemas/CompanyInformation' examples: - Example 1: + Company information: 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' + companyName: Bank of Dave baseCurrency: GBP - sourceUrls: - Api: 'https://api.codat.io' - createdDate: '2020-03-09T15:19:26' + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -935,28 +852,56 @@ paths: $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}/sync/expenses/config': + '/companies/{companyId}/connections/{connectionId}/payables/mappingOptions/bills': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' get: + summary: Get bill mapping options + description: "\uFEFFUse the *Get mapping options - Bills* endpoint to return a list of available mapping options for a given company's connection ID.\n\nBy default, this endpoint returns a list of active accounts and tax rates. You can use [querying](https://docs.codat.io/using-the-api/querying) to change that.\n\nMapping options are a set of accounts and tax rates used to configure the SMB's payables integration." + operationId: get-mapping-options-bills + x-speakeasy-name-override: get-bill-options tags: - - Configuration + - Bills parameters: - - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/continuationToken' + - $ref: '#/components/parameters/statusQuery' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/CompanyConfiguration' - examples: {} + $ref: '#/components/schemas/BillMappingOptions' + examples: + Mapping options: + value: + accounts: + - id: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + nominalCode: 879-i + name: Accounts payable + type: Liability + currency: GBP + status: Active + sourceModifiedDate: '2022-10-23T00:00:00.000Z' + taxRates: + - id: d2939064-dd3a-4c0f-9865-a238c2193515 + name: VAT @ 20% + code: VAT20 + effectiveTaxRate: 20 + totalTaxRate: 20 + status: Active + sourceModifiedDate: '2022-10-23T00:00:00.000Z' + pagination: + continuationToken: eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ== + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -971,27 +916,42 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - summary: Get company configuration - description: Gets a company's expense sync configuration - operationId: get-company-configuration - post: + '/companies/{companyId}/connections/{connectionId}/payables/mappingOptions/payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get payment mapping options + description: "Use the *Get mapping options - Payments* endpoint to return a list of available mapping options for a given company's connection ID.\r\n\r\nBy default, this endpoint returns a list of active bank accounts. You can use [querying](https://docs.codat.io/using-the-api/querying) to change that.\r\n\r\nMapping options are a set of bank accounts used to configure the SMB's payables integration." + operationId: get-mapping-options-payments + x-speakeasy-name-override: get-payment-options tags: - - Configuration + - Bill payments parameters: - - $ref: '#/components/parameters/companyId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyConfiguration' - examples: {} + - $ref: '#/components/parameters/continuationToken' + - $ref: '#/components/parameters/statusQuery' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/CompanyConfiguration' + $ref: '#/components/schemas/PaymentMappingOptions' + examples: + Mapping options: + value: + bankAccounts: + - id: 3d5a8e00-d108-4045-8823-7f342676cffa + name: Bank of Dave current account + accountNumber: '12345678' + currency: GBP + nominalCode: '1234567' + sortCode: '123456' + status: Active + accountType: Debit + sourceModifiedDate: '2022-10-23T00:00:00.000Z' + pagination: + continuationToken: eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ== '400': $ref: '#/components/responses/BadRequest' '401': @@ -1008,26 +968,101 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - summary: Set company configuration - description: Sets a company's expense sync configuration - operationId: set-company-configuration - x-speakeasy-name-override: set + '/companies/{companyId}/connections/{connectionId}/payables/bills': parameters: - $ref: '#/components/parameters/companyId' - '/companies/{companyId}/sync/expenses/mappingOptions': + - $ref: '#/components/parameters/connectionId' get: + summary: List bills + 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. + + [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. + + By default, the endpoint will return all bills with a status of 'Open' & 'PartiallyPaid' to show all oustanding bills. + operationId: list-bills tags: - - Mapping options + - Bills parameters: - - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/continuationToken' + - name: query + in: query + required: false + schema: + type: string + examples: + Status (open): + value: status=Open + Status (partially paid): + value: status=PartiallyPaid + Source modified date: + value: 'sourceModifiedDate>2023-12-15T00:00:00.000Z' + Status (open) & source modified date: + value: 'sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Open' + Status (partially paid) & source modified date: + value: 'sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=PartiallyPaid' + description: 'Codat query string allows you to filter by `status` and `sourceModifiedDate`. Learn more about Codat''s query string [here](https://docs.codat.io/using-the-api/querying). Platfrom specfic statuses: Xero supports Open | PartiallyPaid | Paid | Void | Draft. Qbo supports Open | PartiallyPaid | Paid. FreeAgent supports Open | PartiallyPaid | Paid.' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/MappingOptions' - examples: {} + $ref: '#/components/schemas/Bill/definitions/bills' + examples: + Bills: + value: + results: + - id: '18' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: '1,' + lineItems: + - description: Dance shoes + unitAmount: 5 + quantity: 1 + taxAmount: 0 + accountRef: + id: '16' + taxRateRef: + id: NON + totalAmount: 5 + status: Open + totalAmount: 5 + amountDue: 0 + sourceModifiedDate: '2022-05-26T10:34:10Z' + - id: '22' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Dance shoes + unitAmount: 5 + quantity: 1 + taxAmount: 0 + accountRef: + id: '16' + taxRateRef: + id: NON + totalAmount: 5 + status: Paid + totalAmount: 5 + amountDue: 0 + sourceModifiedDate: '2022-05-26T10:34:10Z' + pagination: + continuationToken: eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ== + '400': + $ref: '#/components/responses/Malformed-Query' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1036,32 +1071,131 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - description: 'Gets the mapping options (accounts, trackingCategories and taxRates) for a company''s accounting software' - summary: Mapping options - operationId: get-mapping-options - x-speakeasy-name-override: get-mapping-options - parameters: - - $ref: '#/components/parameters/companyId' - '/companies/{companyId}/sync/expenses/syncs/lastSuccessful/status': - get: + post: + summary: Create bill + 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. + operationId: create-bill tags: - - Sync + - Bills parameters: - - $ref: '#/components/parameters/companyId' + - in: header + name: Idempotency-Key + description: A unique identifier to ensure idempotent behaviour for subsequent requests. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Bill/definitions/billPrototype' + examples: + Create bill: + value: + reference: bill_b8qmmj4ksf1suax + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + 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 + taxAmount: 360 + totalAmount: 2160 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + taxRateRef: + id: INPUT2 + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + taxAmount: 800 + totalAmount: 4800 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + taxRateRef: + id: INPUT2 + - description: Stationery charges + unitAmount: 32 + quantity: 8 + taxAmount: 51.2 + totalAmount: 307.2 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + taxRateRef: + id: INPUT2 + trackingRefs: + - id: dba3d4da-f9ed-4eee-8e0b-452d11fdb1fa + dataType: trackingCategories + status: Open responses: - '200': - description: Success + '201': + description: Created content: application/json: schema: - $ref: '#/components/schemas/CompanySyncStatus' - examples: {} + $ref: '#/components/schemas/Bill' + examples: + Created bill: + value: + id: bill-1029932 + reference: bill_b8qmmj4ksf1suax + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + issueDate: '2023-04-23T00:00:00' + dueDate: '2023-04-23T00:00:00' + currency: GBP + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + taxAmount: 360 + totalAmount: 2160 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + taxRateRef: + id: INPUT2 + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + taxAmount: 800 + totalAmount: 4800 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + taxRateRef: + id: INPUT2 + - description: Stationery charges + unitAmount: 32 + quantity: 8 + taxAmount: 51.2 + totalAmount: 307.2 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + taxRateRef: + id: INPUT2 + trackingRefs: + - id: dba3d4da-f9ed-4eee-8e0b-452d11fdb1fa + dataType: trackingCategories + status: Open + totalAmount: 7267.2 + amountDue: 7267.2 + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1070,32 +1204,128 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Idempotency-Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - description: Gets the status of the last successful sync - summary: Last successful sync - operationId: get-last-successful-sync - x-speakeasy-name-override: get-last-successful-sync + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}': parameters: - $ref: '#/components/parameters/companyId' - '/companies/{companyId}/sync/expenses/syncs/latest/status': - get: + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/billId' + put: + summary: Update bill + 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. + + ### Supported Integrations + + | Integration | Supported | + |-------------------------------|-----------| + | FreeAgent | Yes | + | QuickBooks Online | Yes | + | Xero | Yes | + | Oracle NetSuite | No | + | Sage Intacct | No | + | Zoho Books | No | + operationId: update-bill tags: - - Sync + - Bills parameters: - - $ref: '#/components/parameters/companyId' + - in: header + name: Idempotency-Key + description: A unique identifier to ensure idempotent behaviour for subsequent requests. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Bill/definitions/billPrototype' + examples: + Update bill: + value: + reference: bill_updated_ref + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + issueDate: '2023-04-23T00:00:00' + dueDate: '2023-05-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Updated line item - Microsoft Office training + unitAmount: 2000 + quantity: 1 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + taxRateRef: + id: INPUT2 + - description: Desktop/network support via email & phone - updated rate + unitAmount: 4500 + quantity: 1 + taxAmount: 900 + totalAmount: 5400 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + taxRateRef: + id: INPUT2 + trackingRefs: + - id: dba3d4da-f9ed-4eee-8e0b-452d11fdb1fa + dataType: trackingCategories + status: Open responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/CompanySyncStatus' - examples: {} + $ref: '#/components/schemas/Bill' + examples: + Updated bill: + value: + id: bill-1029932 + reference: bill_updated_ref + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + issueDate: '2023-04-23T00:00:00' + dueDate: '2023-05-23T00:00:00' + currency: GBP + lineItems: + - description: Updated line item - Microsoft Office training + unitAmount: 2000 + quantity: 1 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + taxRateRef: + id: INPUT2 + - description: Desktop/network support via email & phone - updated rate + unitAmount: 4500 + quantity: 1 + taxAmount: 900 + totalAmount: 5400 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + taxRateRef: + id: INPUT2 + trackingRefs: + - id: dba3d4da-f9ed-4eee-8e0b-452d11fdb1fa + dataType: trackingCategories + status: Open + totalAmount: 7800 + amountDue: 7800 + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1104,34 +1334,49 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Idempotency-Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - description: Gets the latest sync status - summary: Latest sync status - operationId: get-latest-sync - x-speakeasy-name-override: get-latest-sync - parameters: - - $ref: '#/components/parameters/companyId' - '/companies/{companyId}/sync/expenses/syncs/list/status': + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/attachments': parameters: - $ref: '#/components/parameters/companyId' - get: + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/billId' + post: + summary: Upload bill attachment + description: "The *Upload bill attachment* endpoint uploads an attachment and assigns it against a specific `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." + operationId: upload-bill-attachment tags: - - Sync + - Bills + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/AttachmentUpload' responses: - '200': - description: Success + '201': + description: Created content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/CompanySyncStatus' - examples: {} + $ref: '#/components/schemas/Attachment' + examples: + Attachment metadata: + value: + id: 422f093f-e556-4bf3-91c0-93af70c3e850 + name: receipt.png + contentType: image/png + dateCreated: '2022-10-23T00:00:00.000Z' + fileSize: 100 + includeWhenSent: true + sourceModifiedDate: '2022-05-26T10:34:10Z' + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1146,24 +1391,36 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - summary: List sync statuses - description: Gets a list of sync statuses - operationId: list-syncs - '/companies/{companyId}/sync/expenses/syncs/{syncId}/status': get: + 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." + operationId: list-bill-attachments tags: - - Sync - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' + - Bills responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/CompanySyncStatus' - examples: {} + $ref: '#/components/schemas/Attachment/definitions/attachments' + examples: + Success: + value: + - id: 422f093f-e556-4bf3-91c0-93af70c3e850 + name: receipt.png + contentType: image/png + dateCreated: '2022-10-23T00:00:00.000Z' + fileSize: 100 + includeWhenSent: true + sourceModifiedDate: '2022-05-26T10:34:10Z' + - id: 20cfd269-2f0f-44ef-a28c-7b5f725cf1aa + name: another_receipt.png + contentType: image/png + dateCreated: '2022-10-24T00:00:00.000Z' + fileSize: 98 + includeWhenSent: true + sourceModifiedDate: '2022-05-27T12:38:10Z' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1172,35 +1429,40 @@ paths: $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 sync status - description: Get the sync status for a specified sync - operationId: get-sync-by-id + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/attachments/{attachmentId}/download': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' - '/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions': + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/billId' + - $ref: '#/components/parameters/attachmentId' get: - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' + 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 + tags: + - Bills responses: '200': description: Success content: - application/json: + application/octet-stream: schema: - $ref: '#/components/schemas/Transactions' - examples: {} - '400': - $ref: '#/components/responses/Malformed-Query' + title: Data + type: string + format: binary '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1215,28 +1477,58 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - tags: - - Transaction status - summary: List sync transactions - description: Gets the transactions and status for a sync - operationId: list-sync-transactions + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/payment': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' - '/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}': - get: - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' - - $ref: '#/components/parameters/transactionId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/billId' + - in: header + name: Idempotency-Key + description: A unique identifier to ensure idempotent behaviour for subsequent requests. + schema: + type: string + post: + summary: Create bill payment + 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 Accounts Payable account. + operationId: create-bill-payment + tags: + - Bill payments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BillPayment/definitions/billPaymentPrototype' + examples: + Bill payment example: + value: + amount: 22 + currencyRate: 1 + date: '2022-10-23T00:00:00.000Z' + accountRef: + id: 7bda9f44sr56 + reference: Bill Payment against bill c13e37b6 dfaa-4894-b3be-9fe97bda9f44 responses: - '200': - description: Success + '201': + description: Created content: application/json: schema: - $ref: '#/components/schemas/TransactionResponse' - examples: {} + $ref: '#/components/schemas/BillPayment' + examples: + Bill payment: + value: + id: billPayment-1029932 + amount: 22 + currencyRate: 1 + date: '2022-10-23T00:00:00.000Z' + accountRef: + id: 7bda9f44sr56 + reference: Bill Payment against bill c13e37b6 dfaa-4894-b3be-9fe97bda9f44 + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1245,60 +1537,104 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Idempotency-Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - tags: - - Transaction status - summary: Get sync transaction - description: Gets the status of a transaction for a sync - operationId: get-sync-transaction - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' - - $ref: '#/components/parameters/transactionId' - '/companies/{companyId}/sync/expenses/expense-transactions': + '/companies/{companyId}/connections/{connectionId}/payables/suppliers': parameters: - $ref: '#/components/parameters/companyId' - post: - summary: Create expense transaction - operationId: create-expense-transaction - description: | - The *Create expense* endpoint creates an [expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) in the accounting software for a given company's connection. + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Suppliers + summary: List suppliers + 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. - [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. + By default, this endpoint returns a list of active and archived suppliers. You can use [querying](https://docs.codat.io/using-the-api/querying) to change that. + + For example, to retrieve only active suppliers (i.e. `status=Active`) or suppliers created within the specified number of days (e.g. `sourceModifiedDate>2023-12-15T00:00:00.000Z`), query the endpoint as follows: `/payables/suppliers?query=sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Active`.For example, to retrieve active suppliers modified after a particular date use `query=sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Active`. ### Supported Integrations | Integration | Supported | |-------------------------------|-----------| - | Dynamics 365 Business Central | Yes | | FreeAgent | Yes | - | QuickBooks Desktop | Yes | | QuickBooks Online | Yes | + | Xero | Yes | | Oracle NetSuite | Yes | | Sage Intacct | Yes | - | Xero | Yes | | Zoho Books | Yes | - tags: - - Expenses + operationId: list-suppliers + parameters: + - $ref: '#/components/parameters/continuationToken' + - name: query + in: query + required: false + schema: + type: string + examples: + Source modified date: + value: 'sourceModifiedDate>2023-12-15T00:00:00.000Z' + Status (active): + value: status=Active + Status (archived): + value: status=Archived + Status (active) & source modified date: + value: 'sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Active' + Status (archived) & source modified date: + value: 'sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Archived' + description: 'Codat query string allows you to filter by `sourceModifiedDate` or if a supplier is `Active` or `Archived` in the accounting software. Learn more about Codat''s query string [here](https://docs.codat.io/using-the-api/querying).' responses: '200': - description: OK + description: Success content: application/json: - x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/CreateExpenseResponse' + $ref: '#/components/schemas/Supplier/definitions/suppliers' examples: - Example 1: + Suppliers: value: - syncId: cd937d46-8e41-43a9-9477-a79158ffd98a + results: + - id: c523e12f-8b74-4d3a-bbd8-32d7a2f598b4 + supplierName: City Limousines + contactName: Martin Dale + emailAddress: martyd@citylim.co + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + line2: Bakersfield Industrial Estate + city: Bakersfield + region: California + country: USA + postalCode: '93308' + status: Active + balance: 100 + defaultCurrency: GBP + sourceModifiedDate: '2022-10-23T00:00:00Z' + - id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + defaultCurrency: GBP + sourceModifiedDate: '2022-12-07T10:48:18Z' + pagination: + continuationToken: eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ== '400': - $ref: '#/components/responses/BadRequest' + $ref: '#/components/responses/Malformed-Query' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1307,82 +1643,75 @@ paths: $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' + post: + tags: + - Suppliers + 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.\r\n\r\n[Suppliers](https://docs.codat.io/sync-for-payables-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n\r\n### Supported Integrations\r\n\r\n| Integration | Supported |\r\n|-------------------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Online | Yes |\r\n| Xero | Yes |\r\n| Oracle NetSuite | Yes |\r\n| Sage Intacct | Yes |\r\n| Zoho Books | Yes |\r\n" + operationId: create-supplier + parameters: + - in: header + name: Idempotency-Key + description: A unique identifier to ensure idempotent behaviour for subsequent requests. + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateExpenseRequest' + $ref: '#/components/schemas/Supplier/definitions/supplierPrototype' examples: - Payment: - value: - - id: 4d7c6929-7770-412b-91bb-44d3bc71d111 - type: Payment - issueDate: '2024-05-21T00:00:00+00:00' - currency: GBP - currencyRate: 1 - contactRef: - id: '430' - type: Supplier - bankAccountRef: - id: '97' - merchantName: Amazon UK - notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 23_Bills - accountRef: - id: '35' - trackingRefs: - - id: DEPARTMENT_5 - dataType: trackingCategories - invoiceTo: - id: '504' - type: customer - Refund: + Suppliers: value: - - id: 7008d3f2-aeb4-11ed-afa1-0242ac120002 - type: Refund - issueDate: '2024-02-17T00:00:00+00:00' - currency: GBP - contactRef: - id: '430' - type: Supplier - bankAccountRef: - id: '97' - merchantName: Amazon UK - notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 23_Bills - accountRef: - id: '42' - trackingRefs: - - id: DEPARTMENT_6 - '/companies/{companyId}/sync/expenses/expense-transactions/{transactionId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/transactionId' - put: - summary: Update expense transactions - tags: - - Expenses + supplierName: Northridge Office Supplies + contactName: Sarah Johnson + emailAddress: sarah.johnson@northridgesupplies.co.uk + phone: +44 (0)1223 322410 + addresses: + - type: Billing + line1: Flat 1 + line2: 2 Dennis Avenue + city: London + region: Camden + country: GB + postalCode: EC1N 7TE + status: Active + defaultCurrency: GBP responses: - '202': - description: Accepted + '201': + description: Created content: application/json: schema: - $ref: '#/components/schemas/UpdateExpenseResponse' + $ref: '#/components/schemas/Supplier' + examples: + Suppliers: + value: + id: sup-10933920 + supplierName: Northridge Office Supplies + contactName: Sarah Johnson + emailAddress: sarah.johnson@northridgesupplies.co.uk + phone: +44 (0)1223 322410 + addresses: + - type: Billing + line1: Flat 1 + line2: 2 Dennis Avenue + city: London + region: Camden + country: GB + postalCode: EC1N 7TE + status: Active + balance: 0 + defaultCurrency: GBP + sourceModifiedDate: '2026-03-18T10:30:00Z' '400': $ref: '#/components/responses/BadRequest' '401': @@ -1393,91 +1722,103 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' - '422': - $ref: '#/components/responses/Unprocessable-Content' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - operationId: update-expense-transaction - description: |- - The *Update expense* endpoint updates an existing [expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) in the accounting software for a given company's connection. + '/companies/{companyId}/connections/{connectionId}/payables/suppliers/{supplierId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: supplierId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a supplier. + put: + tags: + - Suppliers + 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. + + This is a full-replace PUT endpoint. Any fields not included in the request body will be cleared on the supplier record. - [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) represent transactions made with a company debit or credit card. + ### Supported Integrations - ### Supported integrations - The following integrations are supported for the [Payment](https://docs.codat.io/expenses/sync-process/expense-transactions#transaction-types) transaction `type` only: - | Integration | Supported | - |-----------------------|-----------| - | FreeAgent | Yes | - | QuickBooks Desktop | Yes | - | QuickBooks Online | Yes | - | Oracle NetSuite | Yes | - | Sage Intacct | Yes | - | Xero | Yes | - | Zoho Books | Yes | + | Integration | Supported | + |-------------------------------|-----------| + | FreeAgent | Yes | + | QuickBooks Online | Yes | + | Xero | Yes | + | Oracle NetSuite | No | + | Sage Intacct | No | + | Zoho Books | No | - #### Integration-specific behavior + ### Platform-specific behavior - | Integration | Specifics | - |-----------------------|-----------| - | Sage Intacct | To sync **debit card expenses**, map the debit card to a Credit Card with the account type set to `Debit`.| + - **Xero**: Archived suppliers cannot be updated (returns `400`). Suppliers must be unarchived manually in the Xero UI before updating. + - **QuickBooks Online**: Currency can only be set when creating a supplier, and cannot be changed via update. + operationId: update-supplier requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateExpenseRequest' + $ref: '#/components/schemas/Supplier/definitions/supplierPrototype' examples: - Payment: + Update supplier: value: - type: Payment - issueDate: '2024-05-21T00:00:00+00:00' - currency: GBP - currencyRate: 1 - contactRef: - id: '430' - type: Supplier - bankAccountRef: - id: '97' - merchantName: Amazon UK - notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 23_Bills - accountRef: - id: '35' - trackingRefs: - - id: DEPARTMENT_5 - dataType: trackingCategories - invoiceTo: - id: '504' - type: customer - '/companies/{companyId}/sync/expenses/transfer-transactions/{transactionId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/transactionId' - put: - summary: Create transfer transaction - operationId: create-transfer-transaction - description: "Use the *Create transfer* endpoint to create or update a [transfer transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/TransferTransactionRequest) in the accounting software for a given company's connection. \r\n\r\nTransfers record the movement of money between two bank accounts, or between a bank account and a nominal account. Use them to represent actions such as topping up a debit card account or a balance transfer to another credit card.\r\n\r\nThe `from.amount` and `to.amount` fields are in the native currency of the account.\r\n\r\n### Supported Integrations\r\n| Integration | Create transfer | Update transfer |\r\n|-----------------------|------------------|------------------|\r\n| Dynamics\t\t\t\t| No\t\t\t | No\t\t\t\t |\r\n| FreeAgent | Yes | Yes |\r\n| NetSuite | No | No |\r\n| QuickBooks Desktop | Yes | No |\r\n| QuickBooks Online | Yes | Yes |\r\n| Sage Intacct | No | No |\r\n| Xero | Yes | No |\r\n| Zoho Books | No | No |" - tags: - - Transfers + supplierName: Northridge Office Supplies + contactName: Sarah Johnson + emailAddress: sarah.johnson@northridgesupplies.co.uk + phone: +44 (0)1223 322410 + addresses: + - type: Billing + line1: Flat 1 + line2: 2 Dennis Avenue + city: London + region: Camden + country: GB + postalCode: EC1N 7TE + status: Active + defaultCurrency: GBP responses: '200': - description: OK + description: Success content: application/json: - x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/TransferTransactionResponse' + $ref: '#/components/schemas/Supplier' examples: - Example 1: + Updated supplier: value: - syncId: cd937d46-8e41-43a9-9477-a79158ffd98a + id: sup-10933920 + supplierName: Northridge Office Supplies + contactName: Sarah Johnson + emailAddress: sarah.johnson@northridgesupplies.co.uk + phone: +44 (0)1223 322410 + addresses: + - type: Billing + line1: Flat 1 + line2: 2 Dennis Avenue + city: London + region: Camden + country: GB + postalCode: EC1N 7TE + status: Active + balance: 0 + defaultCurrency: GBP + sourceModifiedDate: '2026-03-18T10:30:00Z' '400': $ref: '#/components/responses/BadRequest' '401': @@ -1494,122 +1835,53 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TransferTransactionRequest' - examples: - Create transfer: - value: - description: Sample transfer description - date: '2021-05-21T00:00:00+00:00' - from: - accountRef: - id: 787dfb37-5707-4dc0-8a86-8d74e4cc78ea - amount: 100 - to: - accountRef: - id: 777dfb37-5506-3dc0-6g86-8d34z4cc78ea - amount: 100 - '/companies/{companyId}/sync/expenses/adjustment-transactions': + '/companies/{companyId}/connections/{connectionId}/payables/bankAccounts': parameters: - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' post: - summary: Create adjustment transaction - operationId: create-adjustment-transaction - description: |- - Use the *Create adjustment expense* endpoint to create an [adjustment](https://docs.codat.io/sync-for-expenses-api#/schemas/AdjustmentTransactionRequest) in the accounting software for a given company's connection. - - Adjustments represent write-offs and transaction alterations, such as foreign exchange adjustments, in the form of a journal entry. - - ### Supported Integrations - - | Integration | Supported | - |-----------------------|-----------| - | QuickBooks Desktop | Yes | tags: - - Adjustments - responses: - '200': - description: OK - content: - application/json: - x-speakeasy-usage-example: true - schema: - $ref: '#/components/schemas/AdjustmentTransactionResponse' - examples: - Example 1: - value: - syncId: cd937d46-8e41-43a9-9477-a79158ffd98a - '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' + - Bank accounts + summary: Create bank account + parameters: + - in: header + name: Idempotency-Key + description: A unique identifier to ensure idempotent behaviour for subsequent requests. + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateAdjustmentRequest' + $ref: '#/components/schemas/BankAccount/definitions/bankAccountPrototype' examples: - Create adjustment: + Bank account example: value: - - id: 3357b3df-5f2e-465d-b9ba-226519dbb8f1 - date: '2024-05-21T00:00:00+00:00' - currency: USD - currencyRate: 1 - reference: test reference - lines: - - amount: 50 - accountRef: - id: 80000018-1671793811 - description: debit line - trackingRefs: - - id: 80000003-1674553958 - dataType: trackingCategories - invoiceTo: - id: 80000002-1674552702 - type: customer - - amount: -50 - accountRef: - id: 80000028-1671794219 - description: credit line - trackingRefs: - - id: 80000003-1674553958 - dataType: trackingCategories - '/companies/{companyId}/sync/expenses/reimbursable-expense-transactions': - parameters: - - $ref: '#/components/parameters/companyId' - post: - summary: Create reimbursable expense transaction - operationId: create-reimbursable-expense-transaction - description: "Use the *Create reimbursable expense* endpoint to submit an employee expense claim in the accounting platform for a given company's connection.\r\n\r\n[Reimbursable expense requests](https://docs.codat.io/sync-for-expenses-api#/schemas/ReimbursableExpenseTransactionRequest) are reflected in the accounting software in the form of **Bills** against an employee (who exists as a supplier in the accounting platform).\r\n\r\n### Supported Integrations\r\n| Integration | Supported |\r\n|-----------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Desktop | Yes |\r\n| QuickBooks Online | Yes |\r\n| Oracle NetSuite | Yes |\r\n| Zoho Books | Yes |\r\n| Sage Intacct | Yes |" - tags: - - Reimbursements + nominalCode: '22' + name: Plutus - Payables - Bank Account 12 + accountNumber: 0120 0440 + sortCode: 50-50-50 + currency: GBP + accountType: Debit responses: - '200': - description: OK + '201': + description: Created content: application/json: - x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/CreateReimbursableExpenseResponse' + $ref: '#/components/schemas/BankAccount' examples: - Example 1: + Created bank account: value: - syncId: cd937d46-8e41-43a9-9477-a79158ffd98a + id: fb623ab2-f6ff-4b22-b7d3-b7cc2a4aa0ea + nominalCode: '22' + name: Plutus - Payables - Bank Account 12 + accountNumber: 0120 0440 + sortCode: 50-50-50 + currency: GBP + accountType: Debit + status: Active + sourceModifiedDate: '2024-02-22T14:46:43.99Z' '400': $ref: '#/components/responses/BadRequest' '401': @@ -1626,9029 +1898,684 @@ paths: $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." + operationId: create-bank-account +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/ReimbursableExpenseTransactionRequest' + $ref: '#/components/schemas/ClientRateLimitWebhook' examples: - Create reimbursable expense: + Reached: value: - - id: 4d7c6929-7770-412b-91bb-44d3bc71d111 - reference: expenses w/c 01/07 - contactRef: - id: '752' - issueDate: '2024-05-21' - dueDate: '2024-05-21' - currency: GBP - currencyRate: 1 - notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - - description: Hotel - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 23_Bills - accountRef: - id: '35' - trackingRefs: - - id: DEPARTMENT_5 - dataType: trackingCategories - invoiceTo: - id: '504' - type: customer - '/companies/{companyId}/sync/expenses/reimbursable-expense-transactions/{transactionId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/transactionId' - put: - summary: Update reimbursable expense transaction - operationId: update-reimbursable-expense-transaction - description: "The *Update reimbursable expense* endpoint updates an existing employee expense claim in the accounting platform for a given company's connection. \r\n\r\nUpdating an existing [reimbursable expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateReimbursableExpenseTransactionRequest) will update the existing **bill** against an employee (who exists as a supplier in the accounting software).\r\n\r\n### Supported Integrations\r\n| Integration | Supported |\r\n|-----------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Online | Yes |\r\n| Oracle NetSuite | Yes |\r\n| Zoho Books | Yes |\r\n\r\n" - tags: - - Reimbursements + 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: OK - content: - application/json: - schema: - $ref: '#/components/schemas/CreateReimbursableExpenseResponse' - examples: - Example 1: - value: - syncId: cd937d46-8e41-43a9-9477-a79158ffd98a - '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: 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/UpdateReimbursableExpenseTransactionRequest' + $ref: '#/components/schemas/ClientRateLimitWebhook' examples: - Update reimbursable expense: + Reset: value: - reference: expenses w/c 01/07 - contactRef: - id: '752' - issueDate: '2024-05-21' - dueDate: '2024-05-21' - currency: GBP - currencyRate: 1 - notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - - description: Hotel - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 23_Bills - accountRef: - id: '35' - trackingRefs: - - id: DEPARTMENT_5 - dataType: trackingCategories - invoiceTo: - id: '504' - type: customer - '/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}/attachments': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' - - $ref: '#/components/parameters/transactionId' - post: - summary: Upload attachment - operationId: upload-expense-attachment - x-speakeasy-name-override: upload + 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: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Attachment' - 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' - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/AttachmentUpload' - tags: - - Attachments - description: |- - The *Upload attachment* endpoint uploads an attachment in the accounting software against the given transactionId. + description: Return a 200 status to indicate that the webhook was received successfully. +components: + schemas: + Address: + title: Address + x-internal: true + type: object + properties: + type: + $ref: '#/components/schemas/Address/definitions/addressType' + 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 address. We recommend using the 2-digit ISO 3166 country code (e.g. `GB`, `US`, `FR`) as this is accepted by all supported platforms.' + postalCode: + type: string + nullable: true + description: Postal code or zip code. + definitions: + addressType: + description: The type of the address + type: string + enum: + - Unknown + - Billing + - Delivery + Attachment: + title: Attachment metadata + description: |2- + The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes. - [Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. Attachments for `Adjustment` and `Transfer` transaction types are not supported for any integrations. + > **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. - **Integration-specific behavior** + Unlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments. - Each accounting software supports different file formats and sizes. + Note that different integrations have different requirements for file size and extension of attachments. - | Integration | File size | File extension | Supported transactions | - |-----------------------------------|-----------|-------------------------------------------------------|------------------------| - | **Xero** | 3 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 | All supported types | - | **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `expense-transactions.Payment`, `expense-transactions.Refund`, `reimbursable-expense-transactions` | - | **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`expense-transactions.Payment`, `expense-transactions.Refund` | - | **Dynamics 365 Business Central** | 350 MB | [No explicit requirements outlined](https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice) for text, image, and video files. | All supported types - | **QuickBooks Desktop** | NA | Does not support attachment upload | N/A | - | **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF | `expense-transactions.Payment`, `reimbursable-expense-transactions` - | **Zoho Books** | 5MB | GIF, PNG, JPEG, JPG, BMP, PDF | `expense-transactions.Payment`, `reimbursable-expense-transactions` | - '/companies/{companyId}/data/all': - parameters: - - $ref: '#/components/parameters/companyId' - post: - summary: Refresh all data - operationId: refresh-all-data-types - responses: - '204': - description: No Content - '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: |- - Refreshes all data types with `fetch on first link` set to `true` for a given company. + | 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". | + type: object + allOf: + - 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**. - This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + 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.' + sourceModifiedDate: + allOf: + - $ref: '#/components/schemas/Connection/properties/created' + - description: |- + The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. - [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. + It is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when: + - Pulling attachments + - The accounting software 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 - 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' - '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': - 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}/data/history/{datasetId}': - parameters: - - $ref: '#/components/parameters/companyId' - - 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. - 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': - 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}/push/{pushOperationKey}': - parameters: - - $ref: '#/components/parameters/companyId' - - schema: + In Codat's data model, dates and times are represented using the ISO 8601 standard. + definitions: + attachments: + title: Attachments + type: array + items: + $ref: '#/components/schemas/Attachment' + AttachmentUpload: + title: Attachment upload + type: object + x-internal: true + required: + - file + properties: + file: + $ref: '#/components/schemas/AttachmentUpload/definitions/codatFile' + definitions: + codatFile: 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}/connections/{connectionId}/push/accounts': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - post: - tags: - - Accounts - summary: Create account - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - - $ref: '#/components/parameters/allowSyncOnPushComplete' - 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-expenses-api#/schemas/Account) for a given company's connection. - - [Accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) are the categories a business uses to record accounting transactions. - - **Integration-specific behavior** - - Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-chartOfAccounts-model). - operationId: create-account - '/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - get: - summary: Get create account model - tags: - - Accounts - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/PushOption' - examples: - Exact (Netherlands): - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - validation: - warnings: [] - information: - - field: NominalCode - details: Must be provided. - name: - type: String - displayName: Name - description: Name of the account - required: true - validation: - warnings: [] - information: - - field: Name - details: Must be provided. - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: Asset.Assets.Cash - type: String - displayName: Asset.Assets.Cash - required: false - - value: Asset.Assets.Bank - type: String - displayName: Asset.Assets.Bank - required: false - - value: Asset.Assets.PaymentServices - type: String - displayName: Asset.Assets.PaymentServices - required: false - - value: Asset.Assets.AccountsReceivable - type: String - displayName: Asset.Assets.AccountsReceivable - required: false - - value: Liability.EquityAndLiabilities.AccountsPayable - type: String - displayName: Liability.EquityAndLiabilities.AccountsPayable - required: false - - value: Asset.Assets.VAT - type: String - displayName: Asset.Assets.VAT - required: false - - value: Liability.EquityAndLiabilities.EmployeesPayable - type: String - displayName: Liability.EquityAndLiabilities.EmployeesPayable - required: false - - value: Asset.Assets.PrepaidExpenses - type: String - displayName: Asset.Assets.PrepaidExpenses - required: false - - value: Liability.EquityAndLiabilities.AccruedExpenses - type: String - displayName: Liability.EquityAndLiabilities.AccruedExpenses - required: false - - value: Liability.EquityAndLiabilities.IncomeTaxesPayable - type: String - displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable - required: false - - value: Asset.Assets.FixedAssets - type: String - displayName: Asset.Assets.FixedAssets - required: false - - value: Asset.Assets.OtherAssets - type: String - displayName: Asset.Assets.OtherAssets - required: false - - value: Asset.Assets.AccumulatedDeprecation - type: String - displayName: Asset.Assets.AccumulatedDeprecation - required: false - - value: Asset.Assets.Inventory - type: String - displayName: Asset.Assets.Inventory - required: false - - value: Equity.EquityAndLiabilities.CapitalStock - type: String - displayName: Equity.EquityAndLiabilities.CapitalStock - required: false - - value: Equity.EquityAndLiabilities.RetainedEarnings - type: String - displayName: Equity.EquityAndLiabilities.RetainedEarnings - required: false - - value: Liability.EquityAndLiabilities.LongTermDebt - type: String - displayName: Liability.EquityAndLiabilities.LongTermDebt - required: false - - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt - type: String - displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt - required: false - - value: Unknown.EquityAndLiabilities.Intercompany - type: String - displayName: Unknown.EquityAndLiabilities.Intercompany - required: false - - value: Unknown.General.General - type: String - displayName: Unknown.General.General - required: false - - value: Income.NetIncome.Revenue - type: String - displayName: Income.NetIncome.Revenue - required: false - - value: Expense.NetIncome.CostOfGoods - type: String - displayName: Expense.NetIncome.CostOfGoods - required: false - - value: Expense.NetIncome.OtherCosts - type: String - displayName: Expense.NetIncome.OtherCosts - required: false - - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses - type: String - displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses - required: false - - value: Expense.NetIncome.DeprecationCosts - type: String - displayName: Expense.NetIncome.DeprecationCosts - required: false - - value: Expense.NetIncome.ResearchAndDevelopment - type: String - displayName: Expense.NetIncome.ResearchAndDevelopment - required: false - - value: Expense.NetIncome.EmployeeCosts - type: String - displayName: Expense.NetIncome.EmployeeCosts - required: false - - value: Expense.NetIncome.EmploymentCosts - type: String - displayName: Expense.NetIncome.EmploymentCosts - required: false - - value: Expense.ExceptionalIncome.ExceptionalCosts - type: String - displayName: Expense.ExceptionalIncome.ExceptionalCosts - required: false - - value: Income.ExceptionalIncome.ExceptionalIncome - type: String - displayName: Income.ExceptionalIncome.ExceptionalIncome - required: false - - value: Expense.ExceptionalIncome.IncomeTaxes - type: String - displayName: Expense.ExceptionalIncome.IncomeTaxes - required: false - - value: Income.ExceptionalIncome.InterestIncome - type: String - displayName: Income.ExceptionalIncome.InterestIncome - required: false - required: true - validation: - warnings: [] - information: - - field: FullyQualifiedCategory - details: Must be provided. - status: - type: String - displayName: Account Status - description: The status of the account - options: - - value: Active - type: String - displayName: Active - required: false - - value: Pending - type: String - displayName: Pending - required: false - - value: Unknown - type: String - displayName: Unknown - required: false - required: true - validation: - warnings: [] - information: - - field: Status - details: Must be provided. - required: true - Exact (UK): - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - validation: - warnings: [] - information: - - field: NominalCode - details: Must be provided. - name: - type: String - displayName: Name - description: Name of the account - required: true - validation: - warnings: [] - information: - - field: Name - details: Must be provided. - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: Asset.Assets.Cash - type: String - displayName: Asset.Assets.Cash - required: false - - value: Asset.Assets.Bank - type: String - displayName: Asset.Assets.Bank - required: false - - value: Asset.Assets.PaymentServices - type: String - displayName: Asset.Assets.PaymentServices - required: false - - value: Asset.Assets.AccountsReceivable - type: String - displayName: Asset.Assets.AccountsReceivable - required: false - - value: Liability.EquityAndLiabilities.AccountsPayable - type: String - displayName: Liability.EquityAndLiabilities.AccountsPayable - required: false - - value: Asset.Assets.VAT - type: String - displayName: Asset.Assets.VAT - required: false - - value: Liability.EquityAndLiabilities.EmployeesPayable - type: String - displayName: Liability.EquityAndLiabilities.EmployeesPayable - required: false - - value: Asset.Assets.PrepaidExpenses - type: String - displayName: Asset.Assets.PrepaidExpenses - required: false - - value: Liability.EquityAndLiabilities.AccruedExpenses - type: String - displayName: Liability.EquityAndLiabilities.AccruedExpenses - required: false - - value: Liability.EquityAndLiabilities.IncomeTaxesPayable - type: String - displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable - required: false - - value: Asset.Assets.FixedAssets - type: String - displayName: Asset.Assets.FixedAssets - required: false - - value: Asset.Assets.OtherAssets - type: String - displayName: Asset.Assets.OtherAssets - required: false - - value: Asset.Assets.AccumulatedDeprecation - type: String - displayName: Asset.Assets.AccumulatedDeprecation - required: false - - value: Asset.Assets.Inventory - type: String - displayName: Asset.Assets.Inventory - required: false - - value: Equity.EquityAndLiabilities.CapitalStock - type: String - displayName: Equity.EquityAndLiabilities.CapitalStock - required: false - - value: Equity.EquityAndLiabilities.RetainedEarnings - type: String - displayName: Equity.EquityAndLiabilities.RetainedEarnings - required: false - - value: Liability.EquityAndLiabilities.LongTermDebt - type: String - displayName: Liability.EquityAndLiabilities.LongTermDebt - required: false - - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt - type: String - displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt - required: false - - value: Unknown.EquityAndLiabilities.Intercompany - type: String - displayName: Unknown.EquityAndLiabilities.Intercompany - required: false - - value: Unknown.General.General - type: String - displayName: Unknown.General.General - required: false - - value: Income.NetIncome.Revenue - type: String - displayName: Income.NetIncome.Revenue - required: false - - value: Expense.NetIncome.CostOfGoods - type: String - displayName: Expense.NetIncome.CostOfGoods - required: false - - value: Expense.NetIncome.OtherCosts - type: String - displayName: Expense.NetIncome.OtherCosts - required: false - - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses - type: String - displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses - required: false - - value: Expense.NetIncome.DeprecationCosts - type: String - displayName: Expense.NetIncome.DeprecationCosts - required: false - - value: Expense.NetIncome.ResearchAndDevelopment - type: String - displayName: Expense.NetIncome.ResearchAndDevelopment - required: false - - value: Expense.NetIncome.EmployeeCosts - type: String - displayName: Expense.NetIncome.EmployeeCosts - required: false - - value: Expense.NetIncome.EmploymentCosts - type: String - displayName: Expense.NetIncome.EmploymentCosts - required: false - - value: Expense.ExceptionalIncome.ExceptionalCosts - type: String - displayName: Expense.ExceptionalIncome.ExceptionalCosts - required: false - - value: Income.ExceptionalIncome.ExceptionalIncome - type: String - displayName: Income.ExceptionalIncome.ExceptionalIncome - required: false - - value: Expense.ExceptionalIncome.IncomeTaxes - type: String - displayName: Expense.ExceptionalIncome.IncomeTaxes - required: false - - value: Income.ExceptionalIncome.InterestIncome - type: String - displayName: Income.ExceptionalIncome.InterestIncome - required: false - required: true - validation: - warnings: [] - information: - - field: FullyQualifiedCategory - details: Must be provided. - status: - type: String - displayName: Account Status - description: The status of the account - options: - - value: Active - type: String - displayName: Active - required: false - - value: Pending - type: String - displayName: Pending - required: false - - value: Unknown - type: String - displayName: Unknown - required: false - required: true - validation: - warnings: [] - information: - - field: Status - details: Must be provided. - required: true - MYOB AccountRight and Essentials: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - validation: - warnings: - - field: NominalCode - details: 'If alphanumeric is supported, must be between 1 and 10 characters. Otherwise format is x-xxxx' - information: [] - name: - type: String - displayName: Name - description: Name of the account - required: false - validation: - warnings: - - field: Name - details: Must have a length between 1 and 60 characters - information: [] - description: - type: String - displayName: Description - description: Description of the account - required: false - validation: - warnings: - - field: Description - details: Must have a length between 1 and 255 characters - information: [] - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: Asset.Bank - type: String - displayName: Bank - required: false - - value: Asset.AccountReceivable - type: String - displayName: Accounts Receivable - required: false - - value: Asset.OtherCurrentAsset - type: String - displayName: Other Current Asset - required: false - - value: Asset.FixedAsset - type: String - displayName: Fixed Asset - required: false - - value: Asset.OtherAsset - type: String - displayName: Other Asset - required: false - - value: Asset.CashAndBank - type: String - displayName: Cash - required: false - - value: Asset.Property Plant and Equipment - type: String - displayName: Equipment Machinery - required: false - - value: Liability.CreditCard - type: String - displayName: Credit Card - required: false - - value: Liability.AccountsPayable - type: String - displayName: Accounts Payable - required: false - - value: Liability.OtherCurrentLiability - type: String - displayName: Other Current Liability - required: false - - value: Liability.LongTermLiability - type: String - displayName: Long Term Liability - required: false - - value: Liability.OtherLiability - type: String - displayName: Other Liability - required: false - - value: Equity - type: String - displayName: Equity - required: false - - value: Equity.Equity - type: String - displayName: Retained Earnings - required: false - - value: Equity.Equity.RetainedEarnings - type: String - displayName: Retained Earnings - required: false - - value: Equity.Owner's Equity - type: String - displayName: Retained Earnings - required: false - - value: Income - type: String - displayName: Income - required: false - - value: OtherIncome - type: String - displayName: Other Income - required: false - - value: Expense - type: String - displayName: Expense - required: false - - value: Expense.Expense - type: String - displayName: Sales Marketing - required: false - - value: Expense.Expense.Insurance - type: String - displayName: General Administrative - required: false - - value: Expense.Overhead - type: String - displayName: General Administrative - required: false - - value: Expense.Expense.RepairMaintenance - type: String - displayName: Repairs Maintenance - required: false - - value: OtherExpense - type: String - displayName: Other Expense - required: false - - value: CostOfSales - type: String - displayName: Cost of Sales - required: false - - value: Cost Of Goods Sold.Cost of Sales - type: String - displayName: Other - required: false - required: true - status: - type: String - displayName: Account Status - description: The status of the account - options: - - value: Active - type: String - displayName: Active - required: false - - value: Archived - type: String - displayName: Archived - required: false - required: true - required: true - QuickBooks Desktop: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - validation: - warnings: - - field: NominalCode - details: Max length of 7 characters. - information: [] - name: - type: String - displayName: Name - description: Name of the account - required: true - validation: - warnings: - - field: Name - details: Max length of 31 characters. - information: [] - description: - type: String - displayName: Description - description: Description of the account - required: false - validation: - warnings: - - field: Description - details: Max length of 200 characters. - information: [] - currency: - type: String - displayName: Currency - description: The currency of the account - required: false - validation: - warnings: - - field: Currency - details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' - - field: Currency - details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company - - field: Currency - details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. - information: - - field: Currency - details: 'If not set, will default to the base currency of the QuickBooks Desktop company' - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: Asset.AccountsReceivable - type: String - displayName: Account Receivable - required: false - - value: Asset.FixedAsset - type: String - displayName: Fixed Asset - required: false - - value: Asset.OtherCurrentAsset - type: String - displayName: Other Current Asset - required: false - - value: Asset.OtherAsset - type: String - displayName: Other Asset - required: false - - value: Income.Income - type: String - displayName: Income - required: false - - value: Income.OtherIncome - type: String - displayName: Other Income - required: false - - value: Liability.AccountsPayable - type: String - displayName: Accounts Payable - required: false - - value: Liability.CreditCard - type: String - displayName: Credit Card - required: false - - value: Liability.LongTermLiability - type: String - displayName: Long Term Liability - required: false - - value: Liability.OtherCurrentLiability - type: String - displayName: Other Current Liability - required: false - - value: Liability.CostOfGoodsSold - type: String - displayName: Cost Of Goods Sold - required: false - - value: Equity.Equity - type: String - displayName: Equity - required: false - - value: Expense.Expense - type: String - displayName: Expense - required: false - - value: Expense.OtherExpense - type: String - displayName: Other Expense - required: false - required: true - currentBalance: - type: Number - displayName: Current Balance - description: The current balance in the account - required: false - required: true - QuickBooks Online Sandbox: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: false - validation: - warnings: [] - information: - - field: NominalCode - details: If included must have a length between 1 and 7 characters - name: - type: String - displayName: Name - description: Name of the account - required: true - validation: - warnings: - - field: Name - details: Must have a length between 1 and 100 characters - information: [] - currency: - type: String - displayName: Currency - description: The currency of the account - required: false - validation: - warnings: [] - information: - - field: Currency - details: When not specified company base currency will be used - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: Asset.Bank.CashOnHand - type: String - displayName: Cash On Hand - required: false - - value: Asset.Bank.Checking - type: String - displayName: Checking - required: false - - value: Asset.Bank.MoneyMarket - type: String - displayName: Money Market - required: false - - value: Asset.Bank.RentsHeldInTrust - type: String - displayName: Rents Held In Trust - required: false - - value: Asset.Bank.Savings - type: String - displayName: Savings - required: false - - value: Asset.Bank.TrustAccounts - type: String - displayName: Trust Accounts - required: false - - value: Asset.Bank.CashAndCashEquivalents - type: String - displayName: Cash And Cash Equivalents - required: false - - value: Asset.Bank.OtherEarmarkedBankAccounts - type: String - displayName: Other Earmarked Bank Accounts - required: false - - value: Asset.Other Current Asset.AllowanceForBadDebts - type: String - displayName: Allowance For Bad Debts - required: false - - value: Asset.Other Current Asset.DevelopmentCosts - type: String - displayName: Development Costs - required: false - - value: Asset.Other Current Asset.EmployeeCashAdvances - type: String - displayName: Employee Cash Advances - required: false - - value: Asset.Other Current Asset.OtherCurrentAssets - type: String - displayName: Other Current Assets - required: false - - value: Asset.Other Current Asset.Inventory - type: String - displayName: Inventory - required: false - - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans - type: String - displayName: Investment Mortgage Real Estate Loans - required: false - - value: Asset.Other Current Asset.Investment_Other - type: String - displayName: Investment Other - required: false - - value: Asset.Other Current Asset.Investment_TaxExemptSecurities - type: String - displayName: Investment Tax Exempt Securities - required: false - - value: Asset.Other Current Asset.Investment_USGovernmentObligations - type: String - displayName: Investment US Government Obligations - required: false - - value: Asset.Other Current Asset.LoansToOfficers - type: String - displayName: Loans To Officers - required: false - - value: Asset.Other Current Asset.LoansToOthers - type: String - displayName: Loans To Others - required: false - - value: Asset.Other Current Asset.LoansToStockholders - type: String - displayName: Loans To Stockholders - required: false - - value: Asset.Other Current Asset.PrepaidExpenses - type: String - displayName: Prepaid Expenses - required: false - - value: Asset.Other Current Asset.Retainage - type: String - displayName: Retainage - required: false - - value: Asset.Other Current Asset.UndepositedFunds - type: String - displayName: Undeposited Funds - required: false - - value: Asset.Other Current Asset.AssetsAvailableForSale - type: String - displayName: Assets Available For Sale - required: false - - value: Asset.Other Current Asset.BalWithGovtAuthorities - type: String - displayName: Balance With Govt Authorities - required: false - - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid - type: String - displayName: Called Up Share Capital Not Paid - required: false - - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit - type: String - displayName: Expenditure Authorisations And Letters Of Credit - required: false - - value: Asset.Other Current Asset.GlobalTaxDeferred - type: String - displayName: Global Tax Deferred - required: false - - value: Asset.Other Current Asset.GlobalTaxRefund - type: String - displayName: Global Tax Refund - required: false - - value: Asset.Other Current Asset.InternalTransfers - type: String - displayName: Internal Transfers - required: false - - value: Asset.Other Current Asset.OtherConsumables - type: String - displayName: Other Consumables - required: false - - value: Asset.Other Current Asset.ProvisionsCurrentAssets - type: String - displayName: Provisions Current Assets - required: false - - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties - type: String - displayName: Short Term Investments In Related Parties - required: false - - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties - type: String - displayName: Short Term Loans And Advances To Related Parties - required: false - - value: Asset.Other Current Asset.TradeAndOtherReceivables - type: String - displayName: Trade And Other Receivables - required: false - - value: Asset.Fixed Asset.AccumulatedDepletion - type: String - displayName: Accumulated Depletion - required: false - - value: Asset.Fixed Asset.AccumulatedDepreciation - type: String - displayName: Accumulated Depreciation - required: false - - value: Asset.Fixed Asset.DepletableAssets - type: String - displayName: Depletable Assets - required: false - - value: Asset.Fixed Asset.FixedAssetComputers - type: String - displayName: Fixed Asset Computers - required: false - - value: Asset.Fixed Asset.FixedAssetCopiers - type: String - displayName: Fixed Asset Copiers - required: false - - value: Asset.Fixed Asset.FixedAssetFurniture - type: String - displayName: Fixed Asset Furniture - required: false - - value: Asset.Fixed Asset.FixedAssetPhone - type: String - displayName: Fixed Asset Phone - required: false - - value: Asset.Fixed Asset.FixedAssetPhotoVideo - type: String - displayName: Fixed Asset Photo Video - required: false - - value: Asset.Fixed Asset.FixedAssetSoftware - type: String - displayName: Fixed Asset Software - required: false - - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment - type: String - displayName: Fixed Asset Other Tools Equipment - required: false - - value: Asset.Fixed Asset.FurnitureAndFixtures - type: String - displayName: Furniture And Fixtures - required: false - - value: Asset.Fixed Asset.Land - type: String - displayName: Land - required: false - - value: Asset.Fixed Asset.LeaseholdImprovements - type: String - displayName: Leasehold Improvements - required: false - - value: Asset.Fixed Asset.OtherFixedAssets - type: String - displayName: Other Fixed Assets - required: false - - value: Asset.Fixed Asset.AccumulatedAmortization - type: String - displayName: Accumulated Amortization - required: false - - value: Asset.Fixed Asset.Buildings - type: String - displayName: Buildings - required: false - - value: Asset.Fixed Asset.IntangibleAssets - type: String - displayName: Intangible Assets - required: false - - value: Asset.Fixed Asset.MachineryAndEquipment - type: String - displayName: Machinery And Equipment - required: false - - value: Asset.Fixed Asset.Vehicles - type: String - displayName: Vehicles - required: false - - value: Asset.Fixed Asset.AssetsInCourseOfConstruction - type: String - displayName: Assets In Course Of Construction - required: false - - value: Asset.Fixed Asset.CapitalWip - type: String - displayName: Capital Wip - required: false - - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets - type: String - displayName: Cumulative Depreciation On Intangible Assets - required: false - - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment - type: String - displayName: Intangible Assets Under Development - required: false - - value: Asset.Fixed Asset.LandAsset - type: String - displayName: Land Asset - required: false - - value: Asset.Fixed Asset.NonCurrentAssets - type: String - displayName: Non Current Assets - required: false - - value: Asset.Fixed Asset.ParticipatingInterests - type: String - displayName: Participating Interests - required: false - - value: Asset.Fixed Asset.ProvisionsFixedAssets - type: String - displayName: Provisions Fixed Assets - required: false - - value: Asset.Other Asset.LeaseBuyout - type: String - displayName: Lease Buyout - required: false - - value: Asset.Other Asset.OtherLongTermAssets - type: String - displayName: Other Long Term Assets - required: false - - value: Asset.Other Asset.SecurityDeposits - type: String - displayName: Security Deposits - required: false - - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets - type: String - displayName: Accumulated Amortization Of Other Assets - required: false - - value: Asset.Other Asset.Goodwill - type: String - displayName: Goodwill - required: false - - value: Asset.Other Asset.Licenses - type: String - displayName: Licenses - required: false - - value: Asset.Other Asset.OrganizationalCosts - type: String - displayName: Organizational Costs - required: false - - value: Asset.Other Asset.AssetsHeldForSale - type: String - displayName: Assets Held For Sale - required: false - - value: Asset.Other Asset.AvailableForSaleFinancialAssets - type: String - displayName: Available For Sale Financial Assets - required: false - - value: Asset.Other Asset.DeferredTax - type: String - displayName: Deferred Tax - required: false - - value: Asset.Other Asset.Investments - type: String - displayName: Investments - required: false - - value: Asset.Other Asset.LongTermInvestments - type: String - displayName: Long Term Investments - required: false - - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties - type: String - displayName: Long Term Loans And Advances To Related Parties - required: false - - value: Asset.Other Asset.OtherIntangibleAssets - type: String - displayName: Other Intangible Assets - required: false - - value: Asset.Other Asset.OtherLongTermInvestments - type: String - displayName: Other Long Term Investments - required: false - - value: Asset.Other Asset.OtherLongTermLoansAndAdvances - type: String - displayName: Other Long Term Loans And Advances - required: false - - value: Asset.Other Asset.PrepaymentsAndAccruedIncome - type: String - displayName: Prepayments And Accrued Income - required: false - - value: Asset.Other Asset.ProvisionsNonCurrentAssets - type: String - displayName: Provisions Non-Current Assets - required: false - - value: Asset.Accounts Receivable.AccountsReceivable - type: String - displayName: Accounts Receivable - required: false - - value: Expense.Expense.AdvertisingPromotional - type: String - displayName: Advertising/Promotional - required: false - - value: Expense.Expense.BadDebts - type: String - displayName: Bad Debts - required: false - - value: Expense.Expense.BankCharges - type: String - displayName: Bank Charges - required: false - - value: Expense.Expense.CharitableContributions - type: String - displayName: Charitable Contributions - required: false - - value: Expense.Expense.CommissionsAndFees - type: String - displayName: Commissions And Fees - required: false - - value: Expense.Expense.Entertainment - type: String - displayName: Entertainment - required: false - - value: Expense.Expense.EntertainmentMeals - type: String - displayName: Entertainment Meals - required: false - - value: Expense.Expense.EquipmentRental - type: String - displayName: Equipment Rental - required: false - - value: Expense.Expense.FinanceCosts - type: String - displayName: Finance Costs - required: false - - value: Expense.Expense.GlobalTaxExpense - type: String - displayName: Global Tax Expense - required: false - - value: Expense.Expense.Insurance - type: String - displayName: Insurance - required: false - - value: Expense.Expense.InterestPaid - type: String - displayName: Interest Paid - required: false - - value: Expense.Expense.LegalProfessionalFees - type: String - displayName: Legal And Professional Fees - required: false - - value: Expense.Expense.OfficeExpenses - type: String - displayName: Office Expenses - required: false - - value: Expense.Expense.OfficeGeneralAdministrativeExpenses - type: String - displayName: Office/General Administrative Expenses - required: false - - value: Expense.Expense.OtherBusinessExpenses - type: String - displayName: Other Business Expenses - required: false - - value: Expense.Expense.OtherMiscellaneousServiceCost - type: String - displayName: Other Miscellaneous Service Cost - required: false - - value: Expense.Expense.PromotionalMeals - type: String - displayName: Promotional Meals - required: false - - value: Expense.Expense.RentOrLeaseOfBuildings - type: String - displayName: Rent Or Lease Of Buildings - required: false - - value: Expense.Expense.RepairMaintenance - type: String - displayName: Repair And Maintenance - required: false - - value: Expense.Expense.ShippingFreightDelivery - type: String - displayName: 'Shipping, Freight And Delivery' - required: false - - value: Expense.Expense.SuppliesMaterials - type: String - displayName: Supplies And Materials - required: false - - value: Expense.Expense.Travel - type: String - displayName: Travel - required: false - - value: Expense.Expense.TravelMeals - type: String - displayName: Travel Meals - required: false - - value: Expense.Expense.Utilities - type: String - displayName: Utilities - required: false - - value: Expense.Expense.Auto - type: String - displayName: Auto - required: false - - value: Expense.Expense.CostOfLabor - type: String - displayName: Cost Of Labor - required: false - - value: Expense.Expense.DuesSubscriptions - type: String - displayName: Dues And Subscriptions - required: false - - value: Expense.Expense.PayrollExpenses - type: String - displayName: Payroll Expenses - required: false - - value: Expense.Expense.TaxesPaid - type: String - displayName: Taxes Paid - required: false - - value: Expense.Expense.UnappliedCashBillPaymentExpense - type: String - displayName: Unapplied Cash Bill Payment Expense - required: false - - value: Expense.Expense.Utilities - type: String - displayName: Utilities - required: false - - value: Expense.Expense.AmortizationExpense - type: String - displayName: Amortization Expense - required: false - - value: Expense.Expense.AppropriationsToDepreciation - type: String - displayName: Appropriations To Depreciation - required: false - - value: Expense.Expense.BorrowingCost - type: String - displayName: Borrowing Cost - required: false - - value: Expense.Expense.CommissionsAndFees - type: String - displayName: Commissions And Fees - required: false - - value: Expense.Expense.DistributionCosts - type: String - displayName: Distribution Costs - required: false - - value: Expense.Expense.ExternalServices - type: String - displayName: External Services - required: false - - value: Expense.Expense.ExtraordinaryCharges - type: String - displayName: Extraordinary Charges - required: false - - value: Expense.Expense.IncomeTaxExpense - type: String - displayName: Income Tax Expense - required: false - - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax - type: String - displayName: Loss On Discontinued Operations Net Of Tax - required: false - - value: Expense.Expense.ManagementCompensation - type: String - displayName: Management Compensation - required: false - - value: Expense.Expense.OtherCurrentOperatingCharges - type: String - displayName: Other Current Operating Charges - required: false - - value: Expense.Expense.OtherExternalServices - type: String - displayName: Other External Services - required: false - - value: Expense.Expense.OtherRentalCosts - type: String - displayName: Other Rental Costs - required: false - - value: Expense.Expense.OtherSellingExpenses - type: String - displayName: Other Selling Expenses - required: false - - value: Expense.Expense.ProjectStudiesSurveysAssessments - type: String - displayName: Project Studies Surveys Assessments - required: false - - value: Expense.Expense.PurchasesRebates - type: String - displayName: Purchases Rebates - required: false - - value: Expense.Expense.ShippingAndDeliveryExpense - type: String - displayName: Shipping And Delivery Expense - required: false - - value: Expense.Expense.StaffCosts - type: String - displayName: Staff Costs - required: false - - value: Expense.Expense.Sundry - type: String - displayName: Sundry - required: false - - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses - type: String - displayName: Travel Expenses General And Admin Expenses - required: false - - value: Expense.Expense.TravelExpensesSellingExpense - type: String - displayName: Travel Expenses Selling Expense - required: false - - value: Expense.Other Expense.Depreciation - type: String - displayName: Depreciation - required: false - - value: Expense.Other Expense.ExchangeGainOrLoss - type: String - displayName: Exchange Gain Or Loss - required: false - - value: Expense.Other Expense.OtherMiscellaneousExpense - type: String - displayName: Other Miscellaneous Expense - required: false - - value: Expense.Other Expense.PenaltiesSettlements - type: String - displayName: Penalties And Settlements - required: false - - value: Expense.Other Expense.Amortization - type: String - displayName: Amortization - required: false - - value: Expense.Other Expense.GasAndFuel - type: String - displayName: Gas And Fuel - required: false - - value: Expense.Other Expense.HomeOffice - type: String - displayName: Home Office - required: false - - value: Expense.Other Expense.HomeOwnerRentalInsurance - type: String - displayName: Home Owner Rental Insurance - required: false - - value: Expense.Other Expense.OtherHomeOfficeExpenses - type: String - displayName: Other Home Office Expenses - required: false - - value: Expense.Other Expense.MortgageInterest - type: String - displayName: Mortgage Interest - required: false - - value: Expense.Other Expense.RentAndLease - type: String - displayName: Rent And Lease - required: false - - value: Expense.Other Expense.RepairsAndMaintenance - type: String - displayName: Repairs And Maintenance - required: false - - value: Expense.Other Expense.ParkingAndTolls - type: String - displayName: Parking And Tolls - required: false - - value: Expense.Other Expense.Vehicle - type: String - displayName: Vehicle - required: false - - value: Expense.Other Expense.VehicleInsurance - type: String - displayName: Vehicle Insurance - required: false - - value: Expense.Other Expense.VehicleLease - type: String - displayName: Vehicle Lease - required: false - - value: Expense.Other Expense.VehicleLoanInterest - type: String - displayName: Vehicle Loan Interest - required: false - - value: Expense.Other Expense.VehicleLoan - type: String - displayName: Vehicle Loan - required: false - - value: Expense.Other Expense.VehicleRegistration - type: String - displayName: Vehicle Registration - required: false - - value: Expense.Other Expense.VehicleRepairs - type: String - displayName: Vehicle Repairs - required: false - - value: Expense.Other Expense.OtherVehicleExpenses - type: String - displayName: Other Vehicle Expenses - required: false - - value: Expense.Other Expense.Utilities - type: String - displayName: Utilities - required: false - - value: Expense.Other Expense.WashAndRoadServices - type: String - displayName: Wash And Road Services - required: false - - value: Expense.Other Expense.DeferredTaxExpense - type: String - displayName: Deferred Tax Expense - required: false - - value: Expense.Other Expense.Depletion - type: String - displayName: Depletion - required: false - - value: Expense.Other Expense.ExceptionalItems - type: String - displayName: Exceptional Items - required: false - - value: Expense.Other Expense.ExtraordinaryItems - type: String - displayName: Extraordinary Items - required: false - - value: Expense.Other Expense.IncomeTaxOtherExpense - type: String - displayName: Income Tax Other Expense - required: false - - value: Expense.Other Expense.MatCredit - type: String - displayName: Mat Credit - required: false - - value: Expense.Other Expense.PriorPeriodItems - type: String - displayName: Prior Period Items - required: false - - value: Expense.Other Expense.TaxRoundoffGainOrLoss - type: String - displayName: Tax Roundoff Gain Or Loss - required: false - - value: Expense.Cost of Goods Sold.EquipmentRentalCos - type: String - displayName: Equipment Rental - COS - required: false - - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos - type: String - displayName: Other Costs Of Sales - COS - required: false - - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos - type: String - displayName: 'Shipping, Freight And Delivery - COS' - required: false - - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs - type: String - displayName: Supplies And Materials - COS - required: false - - value: Expense.Cost of Goods Sold.CostOfLaborCos - type: String - displayName: Cost Of Labor - COS - required: false - - value: Expense.Cost of Goods Sold.CostOfSales - type: String - displayName: Cost Of Sales - required: false - - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost - type: String - displayName: Freight And Delivery Cost - required: false - - value: Income.Income.NonProfitIncome - type: String - displayName: Non Profit Income - required: false - - value: Income.Income.OtherPrimaryIncome - type: String - displayName: Other Primary Income - required: false - - value: Income.Income.SalesOfProductIncome - type: String - displayName: Sales Of ProductIncome - required: false - - value: Income.Income.ServiceFeeIncome - type: String - displayName: Service Fee Income - required: false - - value: Income.Income.DiscountsRefundsGiven - type: String - displayName: Discounts Refunds Given - required: false - - value: Income.Income.UnappliedCashPaymentIncome - type: String - displayName: Unapplied Cash Payment Income - required: false - - value: Income.Income.CashReceiptIncome - type: String - displayName: Cash Receipt Income - required: false - - value: Income.Income.OperatingGrants - type: String - displayName: Operating Grants - required: false - - value: Income.Income.OtherCurrentOperatingIncome - type: String - displayName: Other Current Operating Income - required: false - - value: Income.Income.OwnWorkCapitalized - type: String - displayName: Own Work Capitalized - required: false - - value: Income.Income.RevenueGeneral - type: String - displayName: Revenue General - required: false - - value: Income.Income.SalesRetail - type: String - displayName: Sales Retail - required: false - - value: Income.Income.SalesWholesale - type: String - displayName: Sales Wholesale - required: false - - value: Income.Income.SavingsByTaxScheme - type: String - displayName: Savings By Tax Scheme - required: false - - value: Income.Other Income.DividendIncome - type: String - displayName: Dividend Income - required: false - - value: Income.Other Income.InterestEarned - type: String - displayName: Interest Earned - required: false - - value: Income.Other Income.OtherInvestmentIncome - type: String - displayName: Other Investment Income - required: false - - value: Income.Other Income.OtherMiscellaneousIncome - type: String - displayName: Other Miscellaneous Income - required: false - - value: Income.Other Income.TaxExemptInterest - type: String - displayName: Tax Exempt Interest - required: false - - value: Income.Other Income.GainLossOnSaleOfFixedAssets - type: String - displayName: Gain Loss On Sale Of Fixed Assets - required: false - - value: Income.Other Income.GainLossOnSaleOfInvestments - type: String - displayName: Gain Loss On Sale Of Investments - required: false - - value: Income.Other Income.LossOnDisposalOfAssets - type: String - displayName: Loss On Disposal Of Assets - required: false - - value: Income.Other Income.OtherOperatingIncome - type: String - displayName: Other Operating Income - required: false - - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax - type: String - displayName: Unrealised Loss On Securities Net Of Tax - required: false - - value: Liability.Accounts Payable.AccountsPayable - type: String - displayName: Accounts Payable - required: false - - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise - type: String - displayName: Outstanding Dues Micro Small Enterprise - required: false - - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise - type: String - displayName: Outstanding Dues Other Than Micro Small Enterprise - required: false - - value: Liability.Credit Card.CreditCard - type: String - displayName: Credit Card - required: false - - value: Liability.Long Term Liability.NotesPayable - type: String - displayName: Notes Payable - required: false - - value: Liability.Long Term Liability.OtherLongTermLiabilities - type: String - displayName: Other Long Term Liabilities - required: false - - value: Liability.Long Term Liability.ShareholderNotesPayable - type: String - displayName: Shareholder Notes Payable - required: false - - value: Liability.Long Term Liability.AccrualsAndDeferredIncome - type: String - displayName: Accruals And Deferred Income - required: false - - value: Liability.Long Term Liability.AccruedLongLermLiabilities - type: String - displayName: Accrued Long Lerm Liabilities - required: false - - value: Liability.Long Term Liability.AccruedVacationPayable - type: String - displayName: Accrued Vacation Payable - required: false - - value: Liability.Long Term Liability.BankLoans - type: String - displayName: Bank Loans - required: false - - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests - type: String - displayName: Debts Related To Participating Interests - required: false - - value: Liability.Long Term Liability.DeferredTaxLiabilities - type: String - displayName: Deferred Tax Liabilities - required: false - - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities - type: String - displayName: Government And Other Public Authorities - required: false - - value: Liability.Long Term Liability.GroupAndAssociates - type: String - displayName: Group And Associates - required: false - - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale - type: String - displayName: Liabilities Related To Assets Held For Sale - required: false - - value: Liability.Long Term Liability.LongTermBorrowings - type: String - displayName: Long Term Borrowings - required: false - - value: Liability.Long Term Liability.LongTermDebit - type: String - displayName: Long Term Debit - required: false - - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations - type: String - displayName: Long Term Employee Benefit Obligations - required: false - - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases - type: String - displayName: Obligations Under Finance Leases - required: false - - value: Liability.Long Term Liability.OtherLongTermProvisions - type: String - displayName: Other Long Term Provisions - required: false - - value: Liability.Long Term Liability.ProvisionForLiabilities - type: String - displayName: Provision For Liabilities - required: false - - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities - type: String - displayName: Provisions Non Current Liabilities - required: false - - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts - type: String - displayName: Staff And Related Long Term Liability Accounts - required: false - - value: Liability.Other Current Liability.DirectDepositPayable - type: String - displayName: Direct Deposit Payable - required: false - - value: Liability.Other Current Liability.LineOfCredit - type: String - displayName: Line Of Credit - required: false - - value: Liability.Other Current Liability.LoanPayable - type: String - displayName: Loan Payable - required: false - - value: Liability.Other Current Liability.GlobalTaxPayable - type: String - displayName: Global Tax Payable - required: false - - value: Liability.Other Current Liability.GlobalTaxSuspense - type: String - displayName: Global Tax Suspense - required: false - - value: Liability.Other Current Liability.OtherCurrentLiabilities - type: String - displayName: Other Current Liabilities - required: false - - value: Liability.Other Current Liability.PayrollClearing - type: String - displayName: Payroll Clearing - required: false - - value: Liability.Other Current Liability.PayrollTaxPayable - type: String - displayName: Payroll Tax Payable - required: false - - value: Liability.Other Current Liability.PrepaidExpensesPayable - type: String - displayName: Prepaid Expenses Payable - required: false - - value: Liability.Other Current Liability.RentsInTrustLiability - type: String - displayName: Rents In Trust Liability - required: false - - value: Liability.Other Current Liability.TrustAccountsLiabilities - type: String - displayName: Trust Accounts Liabilities - required: false - - value: Liability.Other Current Liability.FederalIncomeTaxPayable - type: String - displayName: Federal Income Tax Payable - required: false - - value: Liability.Other Current Liability.InsurancePayable - type: String - displayName: Insurance Payable - required: false - - value: Liability.Other Current Liability.SalesTaxPayable - type: String - displayName: Sales Tax Payable - required: false - - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable - type: String - displayName: State Local Income Tax Payable - required: false - - value: Liability.Other Current Liability.AccruedLiabilities - type: String - displayName: Accrued Liabilities - required: false - - value: Liability.Other Current Liability.CurrentLiabilities - type: String - displayName: Current Liabilities - required: false - - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations - type: String - displayName: Current Portion EmployeeBenefits Obligations - required: false - - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases - type: String - displayName: Current Portion Of Obligations Under Finance Leases - required: false - - value: Liability.Other Current Liability.CurrentTaxLiability - type: String - displayName: Current Tax Liability - required: false - - value: Liability.Other Current Liability.DividendsPayable - type: String - displayName: Dividends Payable - required: false - - value: Liability.Other Current Liability.DutiesAndTaxes - type: String - displayName: Duties And Taxes - required: false - - value: Liability.Other Current Liability.InterestPayables - type: String - displayName: Interest Payables - required: false - - value: Liability.Other Current Liability.ProvisionForWarrantyObligations - type: String - displayName: Provision For Warranty Obligations - required: false - - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities - type: String - displayName: Provisions Current Liabilities - required: false - - value: Liability.Other Current Liability.ShortTermBorrowings - type: String - displayName: Short Term Borrowings - required: false - - value: Liability.Other Current Liability.SocialSecurityAgencies - type: String - displayName: Social Security Agencies - required: false - - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts - type: String - displayName: Staff And Related Liability Accounts - required: false - - value: Liability.Other Current Liability.SundryDebtorsAndCreditors - type: String - displayName: Sundry Debtors And Creditors - required: false - - value: Liability.Other Current Liability.TradeAndOtherPayables - type: String - displayName: Trade And Other Payables - required: false - - value: Equity.Equity.OpeningBalanceEquity - type: String - displayName: Opening Balance Equity - required: false - - value: Equity.Equity.PartnersEquity - type: String - displayName: Partners Equity - required: false - - value: Equity.Equity.RetainedEarnings - type: String - displayName: Retained Earnings - required: false - - value: Equity.Equity.AccumulatedAdjustment - type: String - displayName: Accumulated Adjustment - required: false - - value: Equity.Equity.OwnersEquity - type: String - displayName: Owners Equity - required: false - - value: Equity.Equity.PaidInCapitalOrSurplus - type: String - displayName: Paid In Capital Or Surplus - required: false - - value: Equity.Equity.PartnerContributions - type: String - displayName: Partner Contributions - required: false - - value: Equity.Equity.PartnerDistributions - type: String - displayName: Partner Distributions - required: false - - value: Equity.Equity.PreferredStock - type: String - displayName: Preferred Stock - required: false - - value: Equity.Equity.CommonStock - type: String - displayName: Common Stock - required: false - - value: Equity.Equity.TreasuryStock - type: String - displayName: Treasury Stock - required: false - - value: Equity.Equity.EstimatedTaxes - type: String - displayName: Estimated Taxes - required: false - - value: Equity.Equity.Healthcare - type: String - displayName: Healthcare - required: false - - value: Equity.Equity.PersonalIncome - type: String - displayName: Personal Income - required: false - - value: Equity.Equity.PersonalExpense - type: String - displayName: Personal Expense - required: false - - value: Equity.Equity.AccumulatedOtherComprehensiveIncome - type: String - displayName: Accumulated Other Comprehensive Income - required: false - - value: Equity.Equity.CalledUpShareCapital - type: String - displayName: Called Up Share Capital - required: false - - value: Equity.Equity.CapitalReserves - type: String - displayName: Capital Reserves - required: false - - value: Equity.Equity.DividendDisbursed - type: String - displayName: Dividend Disbursed - required: false - - value: Equity.Equity.EquityInEarningsOfSubsiduaries - type: String - displayName: Equity In Earnings Of Subsiduaries - required: false - - value: Equity.Equity.InvestmentGrants - type: String - displayName: Investment Grants - required: false - - value: Equity.Equity.MoneyReceivedAgainstShareWarrants - type: String - displayName: Money Received Against Share Warrants - required: false - - value: Equity.Equity.OtherFreeReserves - type: String - displayName: Other Free Reserves - required: false - - value: Equity.Equity.ShareApplicationMoneyPendingAllotment - type: String - displayName: Share Application Money Pending Allotment - required: false - - value: Equity.Equity.ShareCapital - type: String - displayName: Share Capital - required: false - - value: Equity.Equity.Funds - type: String - displayName: Funds - required: false - required: true - required: true - QuickBooks Online: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: false - validation: - warnings: [] - information: - - field: NominalCode - details: If included must have a length between 1 and 7 characters - name: - type: String - displayName: Name - description: Name of the account - required: true - validation: - warnings: - - field: Name - details: Must have a length between 1 and 100 characters - information: [] - currency: - type: String - displayName: Currency - description: The currency of the account - required: false - validation: - warnings: [] - information: - - field: Currency - details: When not specified company base currency will be used - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: Asset.Bank.CashOnHand - type: String - displayName: Cash On Hand - required: false - - value: Asset.Bank.Checking - type: String - displayName: Checking - required: false - - value: Asset.Bank.MoneyMarket - type: String - displayName: Money Market - required: false - - value: Asset.Bank.RentsHeldInTrust - type: String - displayName: Rents Held In Trust - required: false - - value: Asset.Bank.Savings - type: String - displayName: Savings - required: false - - value: Asset.Bank.TrustAccounts - type: String - displayName: Trust Accounts - required: false - - value: Asset.Bank.CashAndCashEquivalents - type: String - displayName: Cash And Cash Equivalents - required: false - - value: Asset.Bank.OtherEarmarkedBankAccounts - type: String - displayName: Other Earmarked Bank Accounts - required: false - - value: Asset.Other Current Asset.AllowanceForBadDebts - type: String - displayName: Allowance For Bad Debts - required: false - - value: Asset.Other Current Asset.DevelopmentCosts - type: String - displayName: Development Costs - required: false - - value: Asset.Other Current Asset.EmployeeCashAdvances - type: String - displayName: Employee Cash Advances - required: false - - value: Asset.Other Current Asset.OtherCurrentAssets - type: String - displayName: Other Current Assets - required: false - - value: Asset.Other Current Asset.Inventory - type: String - displayName: Inventory - required: false - - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans - type: String - displayName: Investment Mortgage Real Estate Loans - required: false - - value: Asset.Other Current Asset.Investment_Other - type: String - displayName: Investment Other - required: false - - value: Asset.Other Current Asset.Investment_TaxExemptSecurities - type: String - displayName: Investment Tax Exempt Securities - required: false - - value: Asset.Other Current Asset.Investment_USGovernmentObligations - type: String - displayName: Investment US Government Obligations - required: false - - value: Asset.Other Current Asset.LoansToOfficers - type: String - displayName: Loans To Officers - required: false - - value: Asset.Other Current Asset.LoansToOthers - type: String - displayName: Loans To Others - required: false - - value: Asset.Other Current Asset.LoansToStockholders - type: String - displayName: Loans To Stockholders - required: false - - value: Asset.Other Current Asset.PrepaidExpenses - type: String - displayName: Prepaid Expenses - required: false - - value: Asset.Other Current Asset.Retainage - type: String - displayName: Retainage - required: false - - value: Asset.Other Current Asset.UndepositedFunds - type: String - displayName: Undeposited Funds - required: false - - value: Asset.Other Current Asset.AssetsAvailableForSale - type: String - displayName: Assets Available For Sale - required: false - - value: Asset.Other Current Asset.BalWithGovtAuthorities - type: String - displayName: Balance With Govt Authorities - required: false - - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid - type: String - displayName: Called Up Share Capital Not Paid - required: false - - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit - type: String - displayName: Expenditure Authorisations And Letters Of Credit - required: false - - value: Asset.Other Current Asset.GlobalTaxDeferred - type: String - displayName: Global Tax Deferred - required: false - - value: Asset.Other Current Asset.GlobalTaxRefund - type: String - displayName: Global Tax Refund - required: false - - value: Asset.Other Current Asset.InternalTransfers - type: String - displayName: Internal Transfers - required: false - - value: Asset.Other Current Asset.OtherConsumables - type: String - displayName: Other Consumables - required: false - - value: Asset.Other Current Asset.ProvisionsCurrentAssets - type: String - displayName: Provisions Current Assets - required: false - - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties - type: String - displayName: Short Term Investments In Related Parties - required: false - - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties - type: String - displayName: Short Term Loans And Advances To Related Parties - required: false - - value: Asset.Other Current Asset.TradeAndOtherReceivables - type: String - displayName: Trade And Other Receivables - required: false - - value: Asset.Fixed Asset.AccumulatedDepletion - type: String - displayName: Accumulated Depletion - required: false - - value: Asset.Fixed Asset.AccumulatedDepreciation - type: String - displayName: Accumulated Depreciation - required: false - - value: Asset.Fixed Asset.DepletableAssets - type: String - displayName: Depletable Assets - required: false - - value: Asset.Fixed Asset.FixedAssetComputers - type: String - displayName: Fixed Asset Computers - required: false - - value: Asset.Fixed Asset.FixedAssetCopiers - type: String - displayName: Fixed Asset Copiers - required: false - - value: Asset.Fixed Asset.FixedAssetFurniture - type: String - displayName: Fixed Asset Furniture - required: false - - value: Asset.Fixed Asset.FixedAssetPhone - type: String - displayName: Fixed Asset Phone - required: false - - value: Asset.Fixed Asset.FixedAssetPhotoVideo - type: String - displayName: Fixed Asset Photo Video - required: false - - value: Asset.Fixed Asset.FixedAssetSoftware - type: String - displayName: Fixed Asset Software - required: false - - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment - type: String - displayName: Fixed Asset Other Tools Equipment - required: false - - value: Asset.Fixed Asset.FurnitureAndFixtures - type: String - displayName: Furniture And Fixtures - required: false - - value: Asset.Fixed Asset.Land - type: String - displayName: Land - required: false - - value: Asset.Fixed Asset.LeaseholdImprovements - type: String - displayName: Leasehold Improvements - required: false - - value: Asset.Fixed Asset.OtherFixedAssets - type: String - displayName: Other Fixed Assets - required: false - - value: Asset.Fixed Asset.AccumulatedAmortization - type: String - displayName: Accumulated Amortization - required: false - - value: Asset.Fixed Asset.Buildings - type: String - displayName: Buildings - required: false - - value: Asset.Fixed Asset.IntangibleAssets - type: String - displayName: Intangible Assets - required: false - - value: Asset.Fixed Asset.MachineryAndEquipment - type: String - displayName: Machinery And Equipment - required: false - - value: Asset.Fixed Asset.Vehicles - type: String - displayName: Vehicles - required: false - - value: Asset.Fixed Asset.AssetsInCourseOfConstruction - type: String - displayName: Assets In Course Of Construction - required: false - - value: Asset.Fixed Asset.CapitalWip - type: String - displayName: Capital Wip - required: false - - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets - type: String - displayName: Cumulative Depreciation On Intangible Assets - required: false - - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment - type: String - displayName: Intangible Assets Under Development - required: false - - value: Asset.Fixed Asset.LandAsset - type: String - displayName: Land Asset - required: false - - value: Asset.Fixed Asset.NonCurrentAssets - type: String - displayName: Non Current Assets - required: false - - value: Asset.Fixed Asset.ParticipatingInterests - type: String - displayName: Participating Interests - required: false - - value: Asset.Fixed Asset.ProvisionsFixedAssets - type: String - displayName: Provisions Fixed Assets - required: false - - value: Asset.Other Asset.LeaseBuyout - type: String - displayName: Lease Buyout - required: false - - value: Asset.Other Asset.OtherLongTermAssets - type: String - displayName: Other Long Term Assets - required: false - - value: Asset.Other Asset.SecurityDeposits - type: String - displayName: Security Deposits - required: false - - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets - type: String - displayName: Accumulated Amortization Of Other Assets - required: false - - value: Asset.Other Asset.Goodwill - type: String - displayName: Goodwill - required: false - - value: Asset.Other Asset.Licenses - type: String - displayName: Licenses - required: false - - value: Asset.Other Asset.OrganizationalCosts - type: String - displayName: Organizational Costs - required: false - - value: Asset.Other Asset.AssetsHeldForSale - type: String - displayName: Assets Held For Sale - required: false - - value: Asset.Other Asset.AvailableForSaleFinancialAssets - type: String - displayName: Available For Sale Financial Assets - required: false - - value: Asset.Other Asset.DeferredTax - type: String - displayName: Deferred Tax - required: false - - value: Asset.Other Asset.Investments - type: String - displayName: Investments - required: false - - value: Asset.Other Asset.LongTermInvestments - type: String - displayName: Long Term Investments - required: false - - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties - type: String - displayName: Long Term Loans And Advances To Related Parties - required: false - - value: Asset.Other Asset.OtherIntangibleAssets - type: String - displayName: Other Intangible Assets - required: false - - value: Asset.Other Asset.OtherLongTermInvestments - type: String - displayName: Other Long Term Investments - required: false - - value: Asset.Other Asset.OtherLongTermLoansAndAdvances - type: String - displayName: Other Long Term Loans And Advances - required: false - - value: Asset.Other Asset.PrepaymentsAndAccruedIncome - type: String - displayName: Prepayments And Accrued Income - required: false - - value: Asset.Other Asset.ProvisionsNonCurrentAssets - type: String - displayName: Provisions Non-Current Assets - required: false - - value: Asset.Accounts Receivable.AccountsReceivable - type: String - displayName: Accounts Receivable - required: false - - value: Expense.Expense.AdvertisingPromotional - type: String - displayName: Advertising/Promotional - required: false - - value: Expense.Expense.BadDebts - type: String - displayName: Bad Debts - required: false - - value: Expense.Expense.BankCharges - type: String - displayName: Bank Charges - required: false - - value: Expense.Expense.CharitableContributions - type: String - displayName: Charitable Contributions - required: false - - value: Expense.Expense.CommissionsAndFees - type: String - displayName: Commissions And Fees - required: false - - value: Expense.Expense.Entertainment - type: String - displayName: Entertainment - required: false - - value: Expense.Expense.EntertainmentMeals - type: String - displayName: Entertainment Meals - required: false - - value: Expense.Expense.EquipmentRental - type: String - displayName: Equipment Rental - required: false - - value: Expense.Expense.FinanceCosts - type: String - displayName: Finance Costs - required: false - - value: Expense.Expense.GlobalTaxExpense - type: String - displayName: Global Tax Expense - required: false - - value: Expense.Expense.Insurance - type: String - displayName: Insurance - required: false - - value: Expense.Expense.InterestPaid - type: String - displayName: Interest Paid - required: false - - value: Expense.Expense.LegalProfessionalFees - type: String - displayName: Legal And Professional Fees - required: false - - value: Expense.Expense.OfficeExpenses - type: String - displayName: Office Expenses - required: false - - value: Expense.Expense.OfficeGeneralAdministrativeExpenses - type: String - displayName: Office/General Administrative Expenses - required: false - - value: Expense.Expense.OtherBusinessExpenses - type: String - displayName: Other Business Expenses - required: false - - value: Expense.Expense.OtherMiscellaneousServiceCost - type: String - displayName: Other Miscellaneous Service Cost - required: false - - value: Expense.Expense.PromotionalMeals - type: String - displayName: Promotional Meals - required: false - - value: Expense.Expense.RentOrLeaseOfBuildings - type: String - displayName: Rent Or Lease Of Buildings - required: false - - value: Expense.Expense.RepairMaintenance - type: String - displayName: Repair And Maintenance - required: false - - value: Expense.Expense.ShippingFreightDelivery - type: String - displayName: 'Shipping, Freight And Delivery' - required: false - - value: Expense.Expense.SuppliesMaterials - type: String - displayName: Supplies And Materials - required: false - - value: Expense.Expense.Travel - type: String - displayName: Travel - required: false - - value: Expense.Expense.TravelMeals - type: String - displayName: Travel Meals - required: false - - value: Expense.Expense.Utilities - type: String - displayName: Utilities - required: false - - value: Expense.Expense.Auto - type: String - displayName: Auto - required: false - - value: Expense.Expense.CostOfLabor - type: String - displayName: Cost Of Labor - required: false - - value: Expense.Expense.DuesSubscriptions - type: String - displayName: Dues And Subscriptions - required: false - - value: Expense.Expense.PayrollExpenses - type: String - displayName: Payroll Expenses - required: false - - value: Expense.Expense.TaxesPaid - type: String - displayName: Taxes Paid - required: false - - value: Expense.Expense.UnappliedCashBillPaymentExpense - type: String - displayName: Unapplied Cash Bill Payment Expense - required: false - - value: Expense.Expense.Utilities - type: String - displayName: Utilities - required: false - - value: Expense.Expense.AmortizationExpense - type: String - displayName: Amortization Expense - required: false - - value: Expense.Expense.AppropriationsToDepreciation - type: String - displayName: Appropriations To Depreciation - required: false - - value: Expense.Expense.BorrowingCost - type: String - displayName: Borrowing Cost - required: false - - value: Expense.Expense.CommissionsAndFees - type: String - displayName: Commissions And Fees - required: false - - value: Expense.Expense.DistributionCosts - type: String - displayName: Distribution Costs - required: false - - value: Expense.Expense.ExternalServices - type: String - displayName: External Services - required: false - - value: Expense.Expense.ExtraordinaryCharges - type: String - displayName: Extraordinary Charges - required: false - - value: Expense.Expense.IncomeTaxExpense - type: String - displayName: Income Tax Expense - required: false - - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax - type: String - displayName: Loss On Discontinued Operations Net Of Tax - required: false - - value: Expense.Expense.ManagementCompensation - type: String - displayName: Management Compensation - required: false - - value: Expense.Expense.OtherCurrentOperatingCharges - type: String - displayName: Other Current Operating Charges - required: false - - value: Expense.Expense.OtherExternalServices - type: String - displayName: Other External Services - required: false - - value: Expense.Expense.OtherRentalCosts - type: String - displayName: Other Rental Costs - required: false - - value: Expense.Expense.OtherSellingExpenses - type: String - displayName: Other Selling Expenses - required: false - - value: Expense.Expense.ProjectStudiesSurveysAssessments - type: String - displayName: Project Studies Surveys Assessments - required: false - - value: Expense.Expense.PurchasesRebates - type: String - displayName: Purchases Rebates - required: false - - value: Expense.Expense.ShippingAndDeliveryExpense - type: String - displayName: Shipping And Delivery Expense - required: false - - value: Expense.Expense.StaffCosts - type: String - displayName: Staff Costs - required: false - - value: Expense.Expense.Sundry - type: String - displayName: Sundry - required: false - - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses - type: String - displayName: Travel Expenses General And Admin Expenses - required: false - - value: Expense.Expense.TravelExpensesSellingExpense - type: String - displayName: Travel Expenses Selling Expense - required: false - - value: Expense.Other Expense.Depreciation - type: String - displayName: Depreciation - required: false - - value: Expense.Other Expense.ExchangeGainOrLoss - type: String - displayName: Exchange Gain Or Loss - required: false - - value: Expense.Other Expense.OtherMiscellaneousExpense - type: String - displayName: Other Miscellaneous Expense - required: false - - value: Expense.Other Expense.PenaltiesSettlements - type: String - displayName: Penalties And Settlements - required: false - - value: Expense.Other Expense.Amortization - type: String - displayName: Amortization - required: false - - value: Expense.Other Expense.GasAndFuel - type: String - displayName: Gas And Fuel - required: false - - value: Expense.Other Expense.HomeOffice - type: String - displayName: Home Office - required: false - - value: Expense.Other Expense.HomeOwnerRentalInsurance - type: String - displayName: Home Owner Rental Insurance - required: false - - value: Expense.Other Expense.OtherHomeOfficeExpenses - type: String - displayName: Other Home Office Expenses - required: false - - value: Expense.Other Expense.MortgageInterest - type: String - displayName: Mortgage Interest - required: false - - value: Expense.Other Expense.RentAndLease - type: String - displayName: Rent And Lease - required: false - - value: Expense.Other Expense.RepairsAndMaintenance - type: String - displayName: Repairs And Maintenance - required: false - - value: Expense.Other Expense.ParkingAndTolls - type: String - displayName: Parking And Tolls - required: false - - value: Expense.Other Expense.Vehicle - type: String - displayName: Vehicle - required: false - - value: Expense.Other Expense.VehicleInsurance - type: String - displayName: Vehicle Insurance - required: false - - value: Expense.Other Expense.VehicleLease - type: String - displayName: Vehicle Lease - required: false - - value: Expense.Other Expense.VehicleLoanInterest - type: String - displayName: Vehicle Loan Interest - required: false - - value: Expense.Other Expense.VehicleLoan - type: String - displayName: Vehicle Loan - required: false - - value: Expense.Other Expense.VehicleRegistration - type: String - displayName: Vehicle Registration - required: false - - value: Expense.Other Expense.VehicleRepairs - type: String - displayName: Vehicle Repairs - required: false - - value: Expense.Other Expense.OtherVehicleExpenses - type: String - displayName: Other Vehicle Expenses - required: false - - value: Expense.Other Expense.Utilities - type: String - displayName: Utilities - required: false - - value: Expense.Other Expense.WashAndRoadServices - type: String - displayName: Wash And Road Services - required: false - - value: Expense.Other Expense.DeferredTaxExpense - type: String - displayName: Deferred Tax Expense - required: false - - value: Expense.Other Expense.Depletion - type: String - displayName: Depletion - required: false - - value: Expense.Other Expense.ExceptionalItems - type: String - displayName: Exceptional Items - required: false - - value: Expense.Other Expense.ExtraordinaryItems - type: String - displayName: Extraordinary Items - required: false - - value: Expense.Other Expense.IncomeTaxOtherExpense - type: String - displayName: Income Tax Other Expense - required: false - - value: Expense.Other Expense.MatCredit - type: String - displayName: Mat Credit - required: false - - value: Expense.Other Expense.PriorPeriodItems - type: String - displayName: Prior Period Items - required: false - - value: Expense.Other Expense.TaxRoundoffGainOrLoss - type: String - displayName: Tax Roundoff Gain Or Loss - required: false - - value: Expense.Cost of Goods Sold.EquipmentRentalCos - type: String - displayName: Equipment Rental - COS - required: false - - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos - type: String - displayName: Other Costs Of Sales - COS - required: false - - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos - type: String - displayName: 'Shipping, Freight And Delivery - COS' - required: false - - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs - type: String - displayName: Supplies And Materials - COS - required: false - - value: Expense.Cost of Goods Sold.CostOfLaborCos - type: String - displayName: Cost Of Labor - COS - required: false - - value: Expense.Cost of Goods Sold.CostOfSales - type: String - displayName: Cost Of Sales - required: false - - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost - type: String - displayName: Freight And Delivery Cost - required: false - - value: Income.Income.NonProfitIncome - type: String - displayName: Non Profit Income - required: false - - value: Income.Income.OtherPrimaryIncome - type: String - displayName: Other Primary Income - required: false - - value: Income.Income.SalesOfProductIncome - type: String - displayName: Sales Of ProductIncome - required: false - - value: Income.Income.ServiceFeeIncome - type: String - displayName: Service Fee Income - required: false - - value: Income.Income.DiscountsRefundsGiven - type: String - displayName: Discounts Refunds Given - required: false - - value: Income.Income.UnappliedCashPaymentIncome - type: String - displayName: Unapplied Cash Payment Income - required: false - - value: Income.Income.CashReceiptIncome - type: String - displayName: Cash Receipt Income - required: false - - value: Income.Income.OperatingGrants - type: String - displayName: Operating Grants - required: false - - value: Income.Income.OtherCurrentOperatingIncome - type: String - displayName: Other Current Operating Income - required: false - - value: Income.Income.OwnWorkCapitalized - type: String - displayName: Own Work Capitalized - required: false - - value: Income.Income.RevenueGeneral - type: String - displayName: Revenue General - required: false - - value: Income.Income.SalesRetail - type: String - displayName: Sales Retail - required: false - - value: Income.Income.SalesWholesale - type: String - displayName: Sales Wholesale - required: false - - value: Income.Income.SavingsByTaxScheme - type: String - displayName: Savings By Tax Scheme - required: false - - value: Income.Other Income.DividendIncome - type: String - displayName: Dividend Income - required: false - - value: Income.Other Income.InterestEarned - type: String - displayName: Interest Earned - required: false - - value: Income.Other Income.OtherInvestmentIncome - type: String - displayName: Other Investment Income - required: false - - value: Income.Other Income.OtherMiscellaneousIncome - type: String - displayName: Other Miscellaneous Income - required: false - - value: Income.Other Income.TaxExemptInterest - type: String - displayName: Tax Exempt Interest - required: false - - value: Income.Other Income.GainLossOnSaleOfFixedAssets - type: String - displayName: Gain Loss On Sale Of Fixed Assets - required: false - - value: Income.Other Income.GainLossOnSaleOfInvestments - type: String - displayName: Gain Loss On Sale Of Investments - required: false - - value: Income.Other Income.LossOnDisposalOfAssets - type: String - displayName: Loss On Disposal Of Assets - required: false - - value: Income.Other Income.OtherOperatingIncome - type: String - displayName: Other Operating Income - required: false - - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax - type: String - displayName: Unrealised Loss On Securities Net Of Tax - required: false - - value: Liability.Accounts Payable.AccountsPayable - type: String - displayName: Accounts Payable - required: false - - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise - type: String - displayName: Outstanding Dues Micro Small Enterprise - required: false - - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise - type: String - displayName: Outstanding Dues Other Than Micro Small Enterprise - required: false - - value: Liability.Credit Card.CreditCard - type: String - displayName: Credit Card - required: false - - value: Liability.Long Term Liability.NotesPayable - type: String - displayName: Notes Payable - required: false - - value: Liability.Long Term Liability.OtherLongTermLiabilities - type: String - displayName: Other Long Term Liabilities - required: false - - value: Liability.Long Term Liability.ShareholderNotesPayable - type: String - displayName: Shareholder Notes Payable - required: false - - value: Liability.Long Term Liability.AccrualsAndDeferredIncome - type: String - displayName: Accruals And Deferred Income - required: false - - value: Liability.Long Term Liability.AccruedLongLermLiabilities - type: String - displayName: Accrued Long Lerm Liabilities - required: false - - value: Liability.Long Term Liability.AccruedVacationPayable - type: String - displayName: Accrued Vacation Payable - required: false - - value: Liability.Long Term Liability.BankLoans - type: String - displayName: Bank Loans - required: false - - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests - type: String - displayName: Debts Related To Participating Interests - required: false - - value: Liability.Long Term Liability.DeferredTaxLiabilities - type: String - displayName: Deferred Tax Liabilities - required: false - - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities - type: String - displayName: Government And Other Public Authorities - required: false - - value: Liability.Long Term Liability.GroupAndAssociates - type: String - displayName: Group And Associates - required: false - - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale - type: String - displayName: Liabilities Related To Assets Held For Sale - required: false - - value: Liability.Long Term Liability.LongTermBorrowings - type: String - displayName: Long Term Borrowings - required: false - - value: Liability.Long Term Liability.LongTermDebit - type: String - displayName: Long Term Debit - required: false - - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations - type: String - displayName: Long Term Employee Benefit Obligations - required: false - - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases - type: String - displayName: Obligations Under Finance Leases - required: false - - value: Liability.Long Term Liability.OtherLongTermProvisions - type: String - displayName: Other Long Term Provisions - required: false - - value: Liability.Long Term Liability.ProvisionForLiabilities - type: String - displayName: Provision For Liabilities - required: false - - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities - type: String - displayName: Provisions Non Current Liabilities - required: false - - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts - type: String - displayName: Staff And Related Long Term Liability Accounts - required: false - - value: Liability.Other Current Liability.DirectDepositPayable - type: String - displayName: Direct Deposit Payable - required: false - - value: Liability.Other Current Liability.LineOfCredit - type: String - displayName: Line Of Credit - required: false - - value: Liability.Other Current Liability.LoanPayable - type: String - displayName: Loan Payable - required: false - - value: Liability.Other Current Liability.GlobalTaxPayable - type: String - displayName: Global Tax Payable - required: false - - value: Liability.Other Current Liability.GlobalTaxSuspense - type: String - displayName: Global Tax Suspense - required: false - - value: Liability.Other Current Liability.OtherCurrentLiabilities - type: String - displayName: Other Current Liabilities - required: false - - value: Liability.Other Current Liability.PayrollClearing - type: String - displayName: Payroll Clearing - required: false - - value: Liability.Other Current Liability.PayrollTaxPayable - type: String - displayName: Payroll Tax Payable - required: false - - value: Liability.Other Current Liability.PrepaidExpensesPayable - type: String - displayName: Prepaid Expenses Payable - required: false - - value: Liability.Other Current Liability.RentsInTrustLiability - type: String - displayName: Rents In Trust Liability - required: false - - value: Liability.Other Current Liability.TrustAccountsLiabilities - type: String - displayName: Trust Accounts Liabilities - required: false - - value: Liability.Other Current Liability.FederalIncomeTaxPayable - type: String - displayName: Federal Income Tax Payable - required: false - - value: Liability.Other Current Liability.InsurancePayable - type: String - displayName: Insurance Payable - required: false - - value: Liability.Other Current Liability.SalesTaxPayable - type: String - displayName: Sales Tax Payable - required: false - - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable - type: String - displayName: State Local Income Tax Payable - required: false - - value: Liability.Other Current Liability.AccruedLiabilities - type: String - displayName: Accrued Liabilities - required: false - - value: Liability.Other Current Liability.CurrentLiabilities - type: String - displayName: Current Liabilities - required: false - - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations - type: String - displayName: Current Portion EmployeeBenefits Obligations - required: false - - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases - type: String - displayName: Current Portion Of Obligations Under Finance Leases - required: false - - value: Liability.Other Current Liability.CurrentTaxLiability - type: String - displayName: Current Tax Liability - required: false - - value: Liability.Other Current Liability.DividendsPayable - type: String - displayName: Dividends Payable - required: false - - value: Liability.Other Current Liability.DutiesAndTaxes - type: String - displayName: Duties And Taxes - required: false - - value: Liability.Other Current Liability.InterestPayables - type: String - displayName: Interest Payables - required: false - - value: Liability.Other Current Liability.ProvisionForWarrantyObligations - type: String - displayName: Provision For Warranty Obligations - required: false - - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities - type: String - displayName: Provisions Current Liabilities - required: false - - value: Liability.Other Current Liability.ShortTermBorrowings - type: String - displayName: Short Term Borrowings - required: false - - value: Liability.Other Current Liability.SocialSecurityAgencies - type: String - displayName: Social Security Agencies - required: false - - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts - type: String - displayName: Staff And Related Liability Accounts - required: false - - value: Liability.Other Current Liability.SundryDebtorsAndCreditors - type: String - displayName: Sundry Debtors And Creditors - required: false - - value: Liability.Other Current Liability.TradeAndOtherPayables - type: String - displayName: Trade And Other Payables - required: false - - value: Equity.Equity.OpeningBalanceEquity - type: String - displayName: Opening Balance Equity - required: false - - value: Equity.Equity.PartnersEquity - type: String - displayName: Partners Equity - required: false - - value: Equity.Equity.RetainedEarnings - type: String - displayName: Retained Earnings - required: false - - value: Equity.Equity.AccumulatedAdjustment - type: String - displayName: Accumulated Adjustment - required: false - - value: Equity.Equity.OwnersEquity - type: String - displayName: Owners Equity - required: false - - value: Equity.Equity.PaidInCapitalOrSurplus - type: String - displayName: Paid In Capital Or Surplus - required: false - - value: Equity.Equity.PartnerContributions - type: String - displayName: Partner Contributions - required: false - - value: Equity.Equity.PartnerDistributions - type: String - displayName: Partner Distributions - required: false - - value: Equity.Equity.PreferredStock - type: String - displayName: Preferred Stock - required: false - - value: Equity.Equity.CommonStock - type: String - displayName: Common Stock - required: false - - value: Equity.Equity.TreasuryStock - type: String - displayName: Treasury Stock - required: false - - value: Equity.Equity.EstimatedTaxes - type: String - displayName: Estimated Taxes - required: false - - value: Equity.Equity.Healthcare - type: String - displayName: Healthcare - required: false - - value: Equity.Equity.PersonalIncome - type: String - displayName: Personal Income - required: false - - value: Equity.Equity.PersonalExpense - type: String - displayName: Personal Expense - required: false - - value: Equity.Equity.AccumulatedOtherComprehensiveIncome - type: String - displayName: Accumulated Other Comprehensive Income - required: false - - value: Equity.Equity.CalledUpShareCapital - type: String - displayName: Called Up Share Capital - required: false - - value: Equity.Equity.CapitalReserves - type: String - displayName: Capital Reserves - required: false - - value: Equity.Equity.DividendDisbursed - type: String - displayName: Dividend Disbursed - required: false - - value: Equity.Equity.EquityInEarningsOfSubsiduaries - type: String - displayName: Equity In Earnings Of Subsiduaries - required: false - - value: Equity.Equity.InvestmentGrants - type: String - displayName: Investment Grants - required: false - - value: Equity.Equity.MoneyReceivedAgainstShareWarrants - type: String - displayName: Money Received Against Share Warrants - required: false - - value: Equity.Equity.OtherFreeReserves - type: String - displayName: Other Free Reserves - required: false - - value: Equity.Equity.ShareApplicationMoneyPendingAllotment - type: String - displayName: Share Application Money Pending Allotment - required: false - - value: Equity.Equity.ShareCapital - type: String - displayName: Share Capital - required: false - - value: Equity.Equity.Funds - type: String - displayName: Funds - required: false - required: true - required: true - Sage Business Cloud Accounting: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - name: - type: String - displayName: Name - description: Name of the account - required: true - validation: - warnings: [] - information: - - field: Name - details: Should not be longer than 200 characters. - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - validation: - warnings: [] - information: - - field: NominalCode - details: Should be a number between 1 and 99999999. - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: SALES - type: String - displayName: Sales - required: false - - value: OTHER_INCOME - type: String - displayName: Other Income - required: false - - value: DIRECT_EXPENSES - type: String - displayName: Direct Expenses - required: false - - value: OVERHEADS - type: String - displayName: Overheads - required: false - - value: DEPRECIATION - type: String - displayName: Depreciation - required: false - - value: CURRENT_ASSETS - type: String - displayName: Current Assets - required: false - - value: FIXED_ASSETS - type: String - displayName: Fixed Assets - required: false - - value: FUTURE_ASSETS - type: String - displayName: Future Assets - required: false - - value: BANK - type: String - displayName: Bank - required: false - - value: CURRENT_LIABILITY - type: String - displayName: Current Liability - required: false - - value: FUTURE_LIABILITY - type: String - displayName: Future Liability - required: false - - value: EQUITY - type: String - displayName: Equity - required: false - - value: LINE_OF_CREDIT - type: String - displayName: Credit Card / Loan - required: false - required: true - required: true - Sage Intacct: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - validation: - warnings: - - field: NominalCode - details: Must be unique within the entity. - - field: NominalCode - details: 'Must be at most 24 characters in length, although restrictions may vary between entities.' - information: [] - name: - type: String - displayName: Name - description: Name of the account - required: true - status: - type: String - displayName: Account Status - description: The status of the account - options: - - value: Active - type: String - displayName: Active - required: false - - value: Archived - type: String - displayName: Archived - required: false - required: true - type: - type: String - displayName: Account Type - description: 'The type, or base category, of the account' - options: - - value: Asset - type: String - displayName: Asset - required: false - - value: Equity - type: String - displayName: Equity - required: false - - value: Expense - type: String - displayName: Expense - required: false - - value: Income - type: String - displayName: Income - required: false - - value: Liability - type: String - displayName: Liability - required: false - required: true - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - required: true - validation: - warnings: [] - information: - - field: FullyQualifiedCategory - details: 'Any category that is part of the hierarchy of one of: ''Assets'', ''Equity'', ''Liabilities'', ''Total Expenses'' and ''Total Income'' is permitted.' - required: true - Sandbox: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - name: - type: String - displayName: Name - description: Name of the account - required: true - description: - type: String - displayName: Description - description: Description of the account - required: true - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - required: true - fullyQualifiedName: - type: String - displayName: Fully Qualified Name - description: The full name of the account e.g. Liability.Current.VAT or Income.Revenue.Sales - required: true - currency: - type: String - displayName: Currency - description: The currency of the account - required: true - currentBalance: - type: Number - displayName: Current Balance - description: The current balance in the account - required: true - type: - type: String - displayName: Account Type - description: 'The type, or base category, of the account' - required: true - status: - type: String - displayName: Account Status - description: The status of the account - required: true - isBankAccount: - type: Boolean - displayName: Is Bank Account? - description: Confirms whether the nominal account represents a bank account or not - required: true - validDatatypeLinks: - type: Array - displayName: Valid Datatype Links - description: Describes which fields on other data types are valid links to this account in the originating system - properties: - property: - type: String - displayName: Property - description: The field on the source data type that other data types can link to - required: true - links: - type: Array - displayName: Links - description: 'A collection of absolute names of fields from other data types, e.g. Invoice.LineItems.AccountRef.Id' - required: true - required: true - metadata: - type: Object - displayName: Metadata - description: Miscellaneous data about the item - properties: - isDeleted: - type: Boolean - displayName: IsDeleted - description: A boolean to indicate whether the object has been deleted - required: true - required: true - required: true - Xero: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: Identifier for the nominal account. - required: true - validation: - warnings: - - field: NominalCode - details: Max length of 10 characters. - information: [] - name: - type: String - displayName: Name - description: Name of account as it appears in the chart of accounts or general ledger. - required: true - validation: - warnings: [] - information: - - field: Name - details: Payments are enabled to this account if the name ends in .PaymentsEnabled. - description: - type: String - displayName: Description - description: Description for the nominal account. - required: false - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: Account type and category for nominal account. - options: - - value: Asset.Current - type: String - displayName: Current Asset - required: false - - value: Asset.Fixed - type: String - displayName: Fixed Asset - required: false - - value: Asset.Inventory - type: String - displayName: Inventory - required: false - - value: Asset.NonCurrent - type: String - displayName: Non-current Asset - required: false - - value: Asset.Prepayment - type: String - displayName: Prepayment - required: false - - value: Expense.DirectCosts - type: String - displayName: Direct Costs - required: false - - value: Expense.Expense - type: String - displayName: Expense - required: false - - value: Expense.Overhead - type: String - displayName: Overhead - required: false - - value: Expense.Superannuation - type: String - displayName: Superannuation - required: false - - value: Expense.Wages - type: String - displayName: Wages - required: false - - value: Income.Sales - type: String - displayName: Sales - required: false - - value: Income.Revenue - type: String - displayName: Revenue - required: false - - value: Income.Other - type: String - displayName: Other Income - required: false - - value: Liability.Current - type: String - displayName: Current Liability - required: false - - value: Liability.Depreciation - type: String - displayName: Depreciation - required: false - - value: Liability.Liability - type: String - displayName: Liability - required: false - - value: Liability.NonCurrent - type: String - displayName: Non Current Liability - required: false - - value: Liability.PayAsYouGo - type: String - displayName: Pay As You Go Liability - required: false - - value: Liability.Superannuation - type: String - displayName: Superannuation Liability - required: false - - value: Liability.WagesPayable - type: String - displayName: Wages Payable Liability - required: false - - value: Equity.Equity - type: String - displayName: Equity - required: false - required: true - required: true - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - operationId: get-create-chartOfAccounts-model - description: |- - The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) for a given company and integration. - - [Accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) are the categories a business uses to record accounting transactions. - - **Integration-specific behavior** - - See the *response examples* for integration-specific indicative models. - '/companies/{companyId}/connections/{connectionId}/push/bankAccounts': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - post: - tags: - - Bank accounts - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - - $ref: '#/components/parameters/allowSyncOnPushComplete' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BankAccount' - examples: - QuickBooks Online: - value: - accountName: GBP Bank Account - accountType: Debit - accountNumber: '12345678' - currency: GBP - status: Active - Xero: - value: - accountName: Xero GBP Bank Account - accountType: Debit - sortCode: '445566' - accountNumber: '12345678' - currency: GBP - status: Active - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateBankAccountResponse' - examples: {} - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - summary: Create bank account - description: "The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behavior**\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-expenses-api#/operations/get-create-update-bankAccounts-model)." - operationId: create-bank-account - '/companies/{companyId}/connections/{connectionId}/options/bankAccounts': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - get: - summary: Get create 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-expenses-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\r\n\r\n**Integration-specific behavior**\r\n\r\nSee the *response examples* for integration-specific indicative models.\r\n" - '/companies/{companyId}/data/customers': - parameters: - - $ref: '#/components/parameters/companyId' - get: - tags: - - Customers - summary: List customers - parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' - - $ref: '#/components/parameters/query' - - $ref: '#/components/parameters/orderBy' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/Customers' - examples: - Clear Books: - value: - results: - - id: c8180244-74ac-40cf-a5df-6d83661c44d7 - customerName: Arjun Kuvalis - contactName: Werner Langworth - emailAddress: Arjun34@hotmail.com - defaultCurrency: GBP - phone: 014605 64820 - addresses: - - type: Delivery - line1: Suite 214 - line2: 8439 Lueilwitz Passage - city: Fernandohaven - region: Northern Ireland - country: United Kingdom - postalCode: JG04 7PV - - type: Delivery - line1: Suite 096 - line2: 864 Halie Course - city: Juliochester - region: England - country: United Kingdom - postalCode: DZ8 4BF - - type: Delivery - line1: Suite 001 - line2: 416 Stokes Fords - city: Naderborough - region: Wales - country: United Kingdom - postalCode: XG25 0XX - contacts: - - name: Werner Langworth - email: Werner_Langworth@hotmail.com - phone: [] - address: - type: Delivery - line1: Apt. 145 - line2: 317 Williamson Freeway - city: Hortenseville - region: Scotland - country: United Kingdom - postalCode: CV4 2HR - status: Active - - name: Belle Glover - email: Belle51@yahoo.com - phone: [] - address: - type: Delivery - line1: Suite 075 - line2: 9921 Dickens Walk - city: South Ali - region: Scotland - country: United Kingdom - postalCode: TI04 4OO - status: Active - registrationNumber: NI7JEJVM - taxNumber: '7505220209.583549' - status: Active - modifiedDate: '2023-04-26T12:38:16Z' - sourceModifiedDate: '2022-07-03T01:27:00' - metadata: - isDeleted: false - - id: 6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0 - customerName: 'Breitenberg, Emard and Schiller' - contactName: Miguel Hahn - emailAddress: contact@BreitenbergEmardandSchiller.biz - defaultCurrency: GBP - phone: 0800 445 6957 - addresses: - - type: Billing - line1: Apt. 184 - line2: 60578 Louie Springs - city: East Khalid - region: Wales - country: United Kingdom - postalCode: XW89 7NT - contacts: - - name: Miguel Hahn - email: Miguel.Hahn@gmail.com - phone: - - number: 018555 09614 - type: Landline - address: - type: Delivery - line1: Suite 400 - line2: 21930 Milan Lane - city: Reingerton - region: Wales - country: United Kingdom - postalCode: QG10 2DL - status: Active - registrationNumber: KME0AMIL - taxNumber: '8560920952.553111' - status: Archived - modifiedDate: '2023-04-26T12:38:16Z' - sourceModifiedDate: '2022-12-03T11:05:01' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 20 - _links: - current: - href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=1&pageSize=2 - self: - href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers - next: - href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=2&pageSize=2 - Dynamics 365 Business Central: - value: - results: - - id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 - customerName: '' - contactName: '' - emailAddress: '' - defaultCurrency: GBP - phone: '' - addresses: - - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: '' - postalCode: '' - contacts: - - name: '' - email: '' - phone: [] - address: - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: '' - postalCode: '' - status: Active - taxNumber: '' - status: Active - modifiedDate: '2023-03-27T14:21:25Z' - sourceModifiedDate: '2023-01-17T14:50:54Z' - metadata: - isDeleted: false - - id: 0ef95175-48c4-eb11-9f0a-0022481b4343 - customerName: '' - contactName: '' - emailAddress: '' - defaultCurrency: GBP - phone: '' - addresses: - - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: GB - postalCode: '' - contacts: - - name: '' - email: '' - phone: [] - address: - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: GB - postalCode: '' - status: Active - taxNumber: '' - status: Active - modifiedDate: '2023-03-27T14:21:25Z' - sourceModifiedDate: '2021-06-03T08:48:36Z' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 42 - _links: - current: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=1&pageSize=2 - self: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers - next: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=2&pageSize=2 - Exact (Netherlands): - value: - results: - - id: 555f8251-c65a-433a-a813-5dbe04321d1e - customerName: Ab Netherlands - defaultCurrency: EUR - addresses: - - type: Billing - country: NL - contacts: [] - status: Active - modifiedDate: '2022-10-26T13:32:05Z' - sourceModifiedDate: '2021-06-14T15:26:37Z' - - id: 9fd1f78e-67aa-4af7-8a10-df1fc5fb5841 - customerName: anna test 2 - defaultCurrency: EUR - addresses: - - type: Billing - country: NL - contacts: [] - status: Active - modifiedDate: '2022-10-26T13:32:05Z' - sourceModifiedDate: '2022-05-24T11:53:21Z' - pageNumber: 1 - pageSize: 2 - totalResults: 71 - _links: - current: - href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=1&pageSize=2 - self: - href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers - next: - href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=2&pageSize=2 - Exact (UK): - value: - results: - - id: 5f20075a-a28e-434d-81a6-2db0dc170e87 - customerName: Abdi 99 - emailAddress: email@codat.io - defaultCurrency: GBP - addresses: - - type: Billing - line1: Ink Rooms - city: London - country: GB - postalCode: WC1X 0BE - contacts: [] - registrationNumber: '123456789' - taxNumber: GB339 0727 47 - status: Active - modifiedDate: '2022-10-26T13:33:08Z' - sourceModifiedDate: '2020-02-26T11:23:50Z' - - id: 1d9dc1a7-92d6-441b-93fd-42c9fb321b1c - customerName: Abdulbasit Al-haj - contactName: abeee - emailAddress: a.alhaj@codat.io - defaultCurrency: GBP - addresses: - - type: Billing - country: GB - contacts: - - name: abeee - phone: [] - address: - type: Unknown - line1: '' - country: 'GB ' - status: Active - modifiedDate: '2020-02-24T12:00:51.027Z' - status: Active - modifiedDate: '2022-10-26T13:33:08Z' - sourceModifiedDate: '2020-02-24T12:00:50Z' - pageNumber: 1 - pageSize: 2 - totalResults: 53 - _links: - current: - href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=1&pageSize=2 - self: - href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers - next: - href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=2&pageSize=2 - FreeAgent: - value: - results: - - id: '11526230' - customerName: '-' - contactName: Test 1 - addresses: - - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - contacts: - - name: Test 1 - phone: [] - address: - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - status: Unknown - status: Active - modifiedDate: '2023-04-25T14:19:12Z' - sourceModifiedDate: '2023-04-17T06:02:46Z' - metadata: - isDeleted: false - - id: '9677150' - customerName: '-' - contactName: Test 1 - addresses: - - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - contacts: - - name: Test 1 - phone: [] - address: - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - status: Unknown - status: Active - modifiedDate: '2023-04-25T14:19:12Z' - sourceModifiedDate: '2023-04-24T06:19:23Z' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 159 - _links: - current: - href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=1&pageSize=2 - self: - href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers - next: - href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=2&pageSize=2 - FreshBooks: - value: - results: - - id: '634509' - customerName: A test customer 14 (updated) - contactName: test person name - emailAddress: test14@example.com - defaultCurrency: GBP - phone: 01876 541245 - addresses: - - type: Billing - line1: Line 1 - line2: Line 2 - city: Some city - region: A region - country: Country 1 - postalCode: SW1 2JQ - contacts: - - name: test person1 - email: test14A@example.com - phone: - - number: '24681012' - type: Primary - - number: '121086420' - type: Unknown - status: Active - - name: test person2 - email: test14B@example.com - phone: - - number: 1234 56789 - type: Primary - - number: 9876 54321 - type: Unknown - status: Active - - name: test person name - email: test14@example.com - phone: - - number: 01876 541245 - type: Unknown - status: Active - status: Active - modifiedDate: '2023-03-24T16:07:23Z' - sourceModifiedDate: '2022-05-18T09:23:56' - metadata: - isDeleted: false - - id: '634486' - customerName: A test customer name 2 - contactName: test person name - emailAddress: test8@example.com - defaultCurrency: GBP - phone: 01876 541245 - addresses: - - type: Billing - line1: Line 1 - line2: Line 2 - city: Some city - region: A region - country: Country 1 - postalCode: SW1 2JQ - contacts: - - name: test person1 - email: test9@example.com - phone: - - number: '24681012' - type: Primary - - number: '121086420' - type: Unknown - status: Active - - name: test person2 - email: test10@example.com - phone: - - number: '123456789' - type: Primary - - number: '987654321' - type: Unknown - status: Active - - name: test person name - email: test8@example.com - phone: - - number: 01876 541245 - type: Unknown - status: Active - status: Active - modifiedDate: '2023-03-24T16:07:23Z' - sourceModifiedDate: '2022-05-11T11:39:58' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 39 - _links: - current: - href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=1&pageSize=2 - self: - href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers - next: - href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=2&pageSize=2 - KashFlow: - value: - results: - - id: '92227673' - customerName: Chekko Customer Test 01 - contactName: '' - emailAddress: '' - phone: '' - addresses: [] - contacts: - - name: '' - email: '' - phone: [] - status: Active - taxNumber: '' - status: Active - modifiedDate: '2022-09-30T10:29:15Z' - sourceModifiedDate: '0001-01-01T00:00:00' - - id: '88459410' - customerName: Diogo Sousa - contactName: Mr Diogo Sousa - emailAddress: diogomail@mail.com - phone: '123123123' - addresses: - - type: Billing - line1: Billing Address - line2: Billing line 2 Billing line 3 - city: Billing line 4 - country: United Kingdom - postalCode: '123321' - - type: Delivery - line1: Delivery Address - line2: Delivery line2 Delivery line3 - city: Delivery line4 - country: United Kingdom - postalCode: '123321' - contacts: - - name: Mr Diogo Sousa - email: diogomail@mail.com - phone: - - number: '123123123' - type: Landline - - number: '321321321' - type: Mobile - address: - type: Billing - line1: Billing Address - line2: Billing line 2 Billing line 3 - city: Billing line 4 - country: United Kingdom - postalCode: '123321' - status: Active - - name: Mr Diogo Sousa - phone: [] - address: - type: Delivery - line1: Delivery Address - line2: Delivery line2 Delivery line3 - city: Delivery line4 - country: United Kingdom - postalCode: '123321' - status: Active - taxNumber: '' - status: Active - modifiedDate: '2022-09-30T10:29:15Z' - sourceModifiedDate: '2021-05-04T13:22:19' - pageNumber: 1 - pageSize: 2 - totalResults: 10 - _links: - current: - href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=1&pageSize=2 - self: - href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers - next: - href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=2&pageSize=2 - Oracle NetSuite: - value: - results: - - id: '773' - customerName: 119 Test Customer - contactName: Mr Test Customer - defaultCurrency: GBP - addresses: [] - contacts: [] - status: Active - modifiedDate: '2023-01-30T14:48:02Z' - sourceModifiedDate: '2022-01-11T12:28:49' - - id: '172722' - customerName: 1248 European Company - contactName: European Company - defaultCurrency: GBP - addresses: [] - contacts: [] - status: Active - modifiedDate: '2023-01-30T14:48:02Z' - sourceModifiedDate: '2022-07-27T14:29:16' - pageNumber: 1 - pageSize: 2 - totalResults: 4 - _links: - current: - href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=1&pageSize=2 - self: - href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers - next: - href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=2&pageSize=2 - QuickBooks Desktop: - value: - results: - - id: 150000-933272658 - customerName: 'Abercrombie, Kristy' - contactName: Kristy Abercrombie - emailAddress: kristy@samplename.com - defaultCurrency: GBP - phone: 415-555-6579 - addresses: - - type: Delivery - line1: Kristy Abercrombie - line2: 5647 Cypress Hill Rd - city: Bayshore - region: CA - postalCode: '94326' - - type: Billing - line1: Kristy Abercrombie - line2: 5647 Cypress Hill Rd - city: Bayshore - region: CA - postalCode: '94326' - contacts: - - name: 'Abercrombie, Kristy' - email: kristy@samplename.com - phone: - - number: 415-555-6579 - type: Primary - status: Active - - name: Kristy Abercrombie - phone: [] - status: Active - - name: Steve Darcangelo - phone: [] - status: Active - status: Active - modifiedDate: '2023-04-26T09:07:55Z' - sourceModifiedDate: '2023-12-16T05:06:42' - metadata: - isDeleted: false - - id: 800000D0-1182061376 - customerName: 'Allard, Robert' - contactName: Amanda Roberts - emailAddress: rallard@myemail.com - defaultCurrency: GBP - phone: 650-555-3422 - addresses: - - type: Delivery - line1: Robert Allard - line2: 92834 Chandler St. - city: Millbrae - region: CA - postalCode: '94030' - - type: Billing - line1: Robert Allard - line2: 92834 Chandler St. - city: Millbrae - region: CA - postalCode: '94030' - contacts: - - name: 'Allard, Robert' - email: rallard@myemail.com - phone: - - number: 650-555-3422 - type: Primary - - number: 650-555-9804 - type: Fax - - number: 650-555-8349 - type: Unknown - status: Active - - name: Robert Allard - phone: [] - status: Active - - name: Rachel Fisher - phone: [] - status: Active - status: Active - modifiedDate: '2023-04-26T09:07:55Z' - sourceModifiedDate: '2023-12-16T05:06:42' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 64 - _links: - current: - href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=1&pageSize=2 - self: - href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers - next: - href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=2&pageSize=2 - QuickBooks Online: - value: - results: - - id: '9' - customerName: Abe - contactName: Abraham's Company - emailAddress: ab@email.com - defaultCurrency: GBP - addresses: [] - contacts: - - name: Abe - email: ab@email.com - phone: - - number: '01111111111' - type: Mobile - status: Active - registrationNumber: XXXX9900001 - taxNumber: XXXX9900001 - status: Active - modifiedDate: '2023-01-18T11:02:35Z' - sourceModifiedDate: '2022-12-08T15:42:59Z' - - id: '49' - customerName: adeel qbo child test - contactName: Adeel test - emailAddress: adeel@adeel.com - defaultCurrency: GBP - phone: '123456789' - addresses: - - type: Billing - line1: 4 Privet Drive - city: London - country: United Kingdom - postalCode: WD25 7LR - - type: Delivery - line1: 4 Privet Drive - city: London - country: United Kingdom - postalCode: WD25 7LR - contacts: - - name: Adeel test - email: adeel@adeel.com - phone: - - number: '123456789' - type: Primary - - number: '07546543216' - type: Mobile - address: - type: Billing - line1: 4 Privet Drive - city: London - country: United Kingdom - postalCode: WD25 7LR - status: Active - status: Active - modifiedDate: '2023-01-18T11:02:35Z' - sourceModifiedDate: '2022-08-22T09:21:09Z' - pageNumber: 1 - pageSize: 2 - totalResults: 40 - _links: - current: - href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=1&pageSize=2 - self: - href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers - next: - href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=2&pageSize=2 - QuickBooks Online Sandbox: - value: - results: - - id: '66' - customerName: Abercrombie International Group - contactName: Kristy Abercrombie - defaultCurrency: GBP - addresses: - - type: Billing - line1: 123 Main St - city: 'New York, NY' - contacts: - - name: Abercrombie International Group (deleted) - phone: [] - address: - type: Billing - line1: 123 Main St - city: 'New York, NY' - status: Archived - status: Archived - modifiedDate: '2023-04-26T09:35:56Z' - sourceModifiedDate: '2016-09-12T18:53:19Z' - metadata: - isDeleted: false - - id: '67' - customerName: Abercrombie International Group - contactName: Natalie Watts - emailAddress: n.watts@google.com - defaultCurrency: USD - addresses: - - type: Billing - - type: Delivery - contacts: - - name: Abercrombie International Group - email: n.watts@google.com - phone: [] - address: - type: Billing - status: Active - registrationNumber: XXXXVat123456 - taxNumber: XXXXVat123456 - status: Active - modifiedDate: '2023-04-26T09:35:56Z' - sourceModifiedDate: '2023-03-29T01:12:55Z' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 243 - _links: - current: - href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=1&pageSize=2 - self: - href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers - next: - href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=2&pageSize=2 - Sage 200cloud: - value: - results: - - id: A1D001 - customerName: A1 Design Services - contactName: Lee Dalkin - emailAddress: newbusinessadvice@sage.com - defaultCurrency: GBP - phone: 01742 876 234 - addresses: - - type: Delivery - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: '' - postalCode: BP12 7HT - - type: Delivery - line1: 23a Union Street - line2: '' - city: Manchester - region: '' - country: '' - postalCode: M2 6JK - - type: Billing - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: Great Britain - postalCode: BP12 7HT - contacts: - - name: Lee Dalkin - email: newbusinessadvice@sage.com - phone: - - number: 01742 876 234 - type: Landline - - number: 01742 876 235 - type: Landline - - number: 01742 876 236 - type: Fax - status: Active - - name: Malcolm Leverret - email: '' - phone: [] - status: Active - - name: Jim Thomas - email: Jim@a1designservices.co.uk - phone: - - number: 01742 876 234 - type: Landline - - number: 01742 876 235 - type: Fax - status: Active - - name: Jullian Plawsworth - email: Jullian@a1designservices.co.uk - phone: - - number: 0151 349 3939 - type: Landline - - number: 0151 349 3940 - type: Fax - status: Active - registrationNumber: '' - taxNumber: GB238 3839 38 - status: Active - modifiedDate: '2022-10-14T09:35:53Z' - sourceModifiedDate: '2022-04-27T15:17:36Z' - - id: A1D002 - customerName: A2 Design Services - contactName: Lee Dalkin - emailAddress: newbusinessadvice@sage.com - defaultCurrency: GBP - phone: 01742 876 234 - addresses: - - type: Billing - line1: 77a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: Great Britain - postalCode: BP12 7HT - contacts: - - name: Lee Dalkin - email: newbusinessadvice@sage.com - phone: - - number: 01742 876 234 - type: Landline - - number: 01742 876 235 - type: Landline - - number: 01742 876 236 - type: Fax - status: Active - - name: Malcolm Leverret - email: '' - phone: [] - status: Active - - name: Jim Thomas - email: Jim@a1designservices.co.uk - phone: - - number: 01742 876 234 - type: Landline - - number: 01742 876 235 - type: Fax - status: Active - - name: Jullian Plawsworth - email: Jullian@a1designservices.co.uk - phone: - - number: 0151 349 3939 - type: Landline - - number: 0151 349 3940 - type: Fax - status: Active - registrationNumber: '' - taxNumber: GB238 3839 40 - status: Active - modifiedDate: '2022-10-14T09:35:53Z' - sourceModifiedDate: '2020-09-23T10:28:58Z' - pageNumber: 1 - pageSize: 2 - totalResults: 43 - _links: - current: - href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=1&pageSize=2 - self: - href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers - next: - href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=2&pageSize=2 - Sage 50 (UK): - value: - results: - - id: A1D001 - customerName: A1 Design Services - contactName: Ian Cairns - emailAddress: newbusinessadvice@sage.com - defaultCurrency: GBP - phone: 01742 876 234 - addresses: - - type: Delivery - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: GB - postalCode: BP12 7HT - - type: Delivery - line1: 23a Union Street - line2: '' - city: Manchester - region: '' - country: GB - postalCode: M2 6JK - - type: Unknown - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: GB - postalCode: BP12 7HT - contacts: [] - taxNumber: GB238 3839 38 - status: Active - modifiedDate: '2023-03-30T14:42:41Z' - sourceModifiedDate: '2022-11-25T09:43:54Z' - metadata: - isDeleted: false - - id: ABS001 - customerName: ABS Garages Ltd - contactName: Mike Hall - emailAddress: newbusinessadvice@sage.com - defaultCurrency: GBP - phone: 0191 254 5909 - addresses: - - type: Delivery - line1: Swanson Industries - line2: Dukes Industrial Estate - city: Whitley Bay - region: North Tyneside - country: GB - postalCode: NE56 4ER - - type: Delivery - line1: Unit 34 - line2: Holystone Ind Estate - city: Hebburn - region: Tyne & Wear - country: GB - postalCode: NE31 1VB - - type: Unknown - line1: Unit 34 - line2: Holystone Ind Estate - city: Hebburn - region: Tyne & Wear - country: GB - postalCode: NE31 1VB - contacts: [] - taxNumber: GB745 4584 68 - status: Active - modifiedDate: '2023-03-30T14:42:41Z' - sourceModifiedDate: '2022-11-25T09:43:54Z' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 30 - _links: - current: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=1&pageSize=2 - self: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers - next: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=2&pageSize=2 - Sage Business Cloud Accounting: - value: - results: - - id: 260f6a3f94a243738f2d5e08496a41a8 - customerName: 100 test name - contactName: Main Contact - emailAddress: email@codat.io - defaultCurrency: GBP - phone: contact phone number - addresses: - - type: Billing - line1: Aruba Address line 1 - line2: Aruba Address line 2 - city: Aruba City - region: Aruba Province - country: Aruba (AW) - postalCode: Aruba Post - contacts: - - phone: - - number: contact mobile number - type: Mobile - - number: contact fax number - type: Fax - status: Unknown - status: Active - modifiedDate: '2022-10-24T14:52:54Z' - sourceModifiedDate: '2021-05-10T16:31:51Z' - - id: 44a5d9461d9e4f6d90a5ace251c5cf35 - customerName: 100 test name DS - contactName: Main Contact - emailAddress: DCemail@codat.io - defaultCurrency: GBP - phone: contact phone number - addresses: - - type: Billing - line1: POST - Aruba Address line 1 - line2: POST - Aruba Address line 2 - city: POST - Aruba City - region: Aruba Province - country: Aruba (AW) - postalCode: Aruba Post - contacts: [] - status: Active - modifiedDate: '2022-10-24T14:52:54Z' - sourceModifiedDate: '2021-06-10T14:22:46Z' - pageNumber: 1 - pageSize: 2 - totalResults: 168 - _links: - current: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=1&pageSize=2 - self: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers - next: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=2&pageSize=2 - Sage Intacct: - value: - results: - - id: '188' - customerName: 33Across - contactName: Yuna Conn - defaultCurrency: USD - phone: 520-393-4468 - addresses: - - type: Unknown - line1: 155 Westend Point - line2: '' - city: Albuquerque - region: NM - country: United States - postalCode: '87140' - contacts: - - name: 'Conn, Yuna' - phone: - - number: 520-393-4468 - type: Primary - address: - type: Unknown - line1: 155 Westend Point - line2: '' - city: Albuquerque - region: NM - country: United States - postalCode: '87140' - status: Unknown - taxNumber: '' - status: Active - modifiedDate: '2023-04-04T16:32:21Z' - sourceModifiedDate: '2022-09-06T12:58:27' - metadata: - isDeleted: false - - id: '324' - customerName: 3Way International Logistics - contactName: Lauri O'Heagertie - defaultCurrency: CAD - phone: 410-309-3976 - addresses: - - type: Unknown - line1: 7 Lerdahl Junction - line2: '' - city: Sparwood - region: British Columbia - country: Canada - postalCode: L4R - contacts: - - name: 'O''Heagertie, Lauri' - phone: - - number: 410-309-3976 - type: Primary - address: - type: Unknown - line1: 7 Lerdahl Junction - line2: '' - city: Sparwood - region: British Columbia - country: Canada - postalCode: L4R - status: Unknown - taxNumber: '' - status: Active - modifiedDate: '2023-04-04T16:32:21Z' - sourceModifiedDate: '2020-10-20T05:01:49' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 530 - _links: - current: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=1&pageSize=2 - self: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers - next: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=2&pageSize=2 - Wave: - value: - results: - - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 - customerName: ABC Textiles - contactName: '' - emailAddress: c.taylor@codat.io - defaultCurrency: USD - addresses: [] - contacts: [] - status: Active - modifiedDate: '2022-11-16T18:15:30Z' - sourceModifiedDate: '2019-10-17T07:59:04Z' - - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM3MTUzNDI2 - customerName: Coffee Cart - contactName: Coffee Carl - emailAddress: coffee.cart@example.com - defaultCurrency: GBP - phone: '0201111' - addresses: - - type: Billing - line1: 11 Coffee Lane - line2: Coffee Town - city: Coffee City - region: Hampshire - country: United Kingdom - postalCode: CC1 1CC - contacts: - - name: Coffee Carl - phone: - - number: '07733' - type: Mobile - status: Active - status: Active - modifiedDate: '2022-11-16T18:15:30Z' - sourceModifiedDate: '2020-03-17T19:12:39Z' - pageNumber: 1 - pageSize: 2 - totalResults: 10 - _links: - current: - href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=1&pageSize=2 - self: - href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers - next: - href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=2&pageSize=2 - Xero: - value: - results: - - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 - customerName: 24 Locks - emailAddress: '' - addresses: [] - contacts: [] - status: Active - modifiedDate: '2023-03-15T20:35:10Z' - sourceModifiedDate: '2023-02-17T18:03:42' - metadata: - isDeleted: false - - id: bab779bc-c5fb-42cb-a888-953e8309711c - customerName: 7-Eleven - emailAddress: '' - addresses: [] - contacts: [] - status: Active - modifiedDate: '2023-03-15T20:35:10Z' - sourceModifiedDate: '2023-02-17T18:03:42' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 48 - _links: - current: - href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=1&pageSize=2 - self: - href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers - next: - href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=2&pageSize=2 - Zoho Books: - value: - results: - - id: '104957000000032105' - customerName: A B - contactName: Contact (First Name) Contact (Last Name) - emailAddress: contactperson@whateveryouwantidontcare12345.com - defaultCurrency: GBP - phone: Work Phone - addresses: [] - contacts: - - name: Contact (First Name) Contact (Last Name) - email: contactperson@whateveryouwantidontcare12345.com - phone: - - number: Work Phone - type: Landline - - number: Mobile - type: Mobile - status: Active - status: Active - modifiedDate: '2022-10-03T08:40:37Z' - sourceModifiedDate: '2022-06-09T14:36:47' - - id: '104957000000054050' - customerName: 'Doe, John' - contactName: John Doe - emailAddress: '' - defaultCurrency: GBP - addresses: [] - contacts: - - name: John Doe - email: '' - phone: [] - status: Active - status: Active - modifiedDate: '2022-10-03T08:40:37Z' - sourceModifiedDate: '2022-09-28T15:09:22' - pageNumber: 1 - pageSize: 2 - totalResults: 14 - _links: - current: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=1&pageSize=2 - self: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers - next: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=2&pageSize=2 - '400': - $ref: '#/components/responses/Malformed-Query' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '409': - $ref: '#/components/responses/Conflict' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - description: |- - The *List customers* endpoint returns a list of [customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) for a given company's connection. - - [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. - - Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). - - operationId: list-customers - '/companies/{companyId}/data/customers/{customerId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/customerId' - get: - tags: - - Customers - summary: Get customer - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/Customer' - examples: - Clear Books: - value: - id: c8180244-74ac-40cf-a5df-6d83661c44d7 - customerName: Arjun Kuvalis - contactName: Werner Langworth - emailAddress: Arjun34@hotmail.com - defaultCurrency: GBP - phone: 014605 64820 - addresses: - - type: Delivery - line1: Suite 214 - line2: 8439 Lueilwitz Passage - city: Fernandohaven - region: Northern Ireland - country: United Kingdom - postalCode: JG04 7PV - - type: Delivery - line1: Suite 096 - line2: 864 Halie Course - city: Juliochester - region: England - country: United Kingdom - postalCode: DZ8 4BF - - type: Delivery - line1: Suite 001 - line2: 416 Stokes Fords - city: Naderborough - region: Wales - country: United Kingdom - postalCode: XG25 0XX - contacts: - - name: Werner Langworth - email: Werner_Langworth@hotmail.com - phone: [] - address: - type: Delivery - line1: Apt. 145 - line2: 317 Williamson Freeway - city: Hortenseville - region: Scotland - country: United Kingdom - postalCode: CV4 2HR - status: Active - - name: Belle Glover - email: Belle51@yahoo.com - phone: [] - address: - type: Delivery - line1: Suite 075 - line2: 9921 Dickens Walk - city: South Ali - region: Scotland - country: United Kingdom - postalCode: TI04 4OO - status: Active - registrationNumber: NI7JEJVM - taxNumber: '7505220209.583549' - status: Active - modifiedDate: '2023-04-26T12:38:16Z' - sourceModifiedDate: '2022-07-03T01:27:00' - metadata: - isDeleted: false - Dynamics 365 Business Central: - value: - id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 - customerName: '' - contactName: '' - emailAddress: '' - defaultCurrency: GBP - phone: '' - addresses: - - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: '' - postalCode: '' - contacts: - - name: '' - email: '' - phone: [] - address: - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: '' - postalCode: '' - status: Active - taxNumber: '' - status: Active - modifiedDate: '2023-03-27T14:21:25Z' - sourceModifiedDate: '2023-01-17T14:50:54Z' - metadata: - isDeleted: false - Exact (Netherlands): - value: - id: 555f8251-c65a-433a-a813-5dbe04321d1e - customerName: Ab Netherlands - defaultCurrency: EUR - addresses: - - type: Billing - country: NL - contacts: [] - status: Active - modifiedDate: '2022-10-26T13:32:05Z' - sourceModifiedDate: '2021-06-14T15:26:37Z' - Exact (UK): - value: - id: 5f20075a-a28e-434d-81a6-2db0dc170e87 - customerName: Abdi 99 - emailAddress: email@codat.io - defaultCurrency: GBP - addresses: - - type: Billing - line1: Ink Rooms - city: London - country: GB - postalCode: WC1X 0BE - contacts: [] - registrationNumber: '123456789' - taxNumber: GB339 0727 47 - status: Active - modifiedDate: '2022-10-26T13:33:08Z' - sourceModifiedDate: '2020-02-26T11:23:50Z' - FreeAgent: - value: - id: '11526230' - customerName: '-' - contactName: Test 1 - addresses: - - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - contacts: - - name: Test 1 - phone: [] - address: - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - status: Unknown - status: Active - modifiedDate: '2023-04-25T14:19:12Z' - sourceModifiedDate: '2023-04-17T06:02:46Z' - metadata: - isDeleted: false - FreshBooks: - value: - id: '634509' - customerName: A test customer 14 (updated) - contactName: test person name - emailAddress: test14@example.com - defaultCurrency: GBP - phone: 01876 541245 - addresses: - - type: Billing - line1: Line 1 - line2: Line 2 - city: Some city - region: A region - country: Country 1 - postalCode: SW1 2JQ - contacts: - - name: test person1 - email: test14A@example.com - phone: - - number: '24681012' - type: Primary - - number: '121086420' - type: Unknown - status: Active - - name: test person2 - email: test14B@example.com - phone: - - number: '123456789' - type: Primary - - number: '987654321' - type: Unknown - status: Active - - name: test person name - email: test14@example.com - phone: - - number: 01876 541245 - type: Unknown - status: Active - status: Active - modifiedDate: '2023-03-24T16:07:23Z' - sourceModifiedDate: '2022-05-18T09:23:56' - metadata: - isDeleted: false - KashFlow: - value: - id: '92227673' - customerName: Chekko Customer Test 01 - contactName: '' - emailAddress: '' - phone: '' - addresses: [] - contacts: - - name: '' - email: '' - phone: [] - status: Active - taxNumber: '' - status: Active - modifiedDate: '2022-09-30T10:29:15Z' - sourceModifiedDate: '0001-01-01T00:00:00' - Oracle NetSuite: - value: - id: '773' - customerName: 119 Test Customer - contactName: Mr Test Customer - defaultCurrency: GBP - addresses: [] - contacts: [] - status: Active - modifiedDate: '2023-01-30T14:48:02Z' - sourceModifiedDate: '2022-01-11T12:28:49' - QuickBooks Desktop: - value: - id: 150000-933272658 - customerName: 'Abercrombie, Kristy' - contactName: Kristy Abercrombie - emailAddress: kristy@samplename.com - defaultCurrency: GBP - phone: 415-555-6579 - addresses: - - type: Delivery - line1: Kristy Abercrombie - line2: 5647 Cypress Hill Rd - city: Bayshore - region: CA - postalCode: '94326' - - type: Billing - line1: Kristy Abercrombie - line2: 5647 Cypress Hill Rd - city: Bayshore - region: CA - postalCode: '94326' - contacts: - - name: 'Abercrombie, Kristy' - email: kristy@samplename.com - phone: - - number: 415-555-6579 - type: Primary - status: Active - - name: Kristy Abercrombie - phone: [] - status: Active - - name: Steve Darcangelo - phone: [] - status: Active - status: Active - modifiedDate: '2023-04-26T09:07:55Z' - sourceModifiedDate: '2023-12-16T05:06:42' - metadata: - isDeleted: false - QuickBooks Online: - value: - id: '9' - customerName: Abe - contactName: Abraham's Company - emailAddress: ab@email.com - defaultCurrency: GBP - addresses: [] - contacts: - - name: Abe - email: ab@email.com - phone: - - number: '01111111111' - type: Mobile - status: Active - registrationNumber: XXXX9900001 - taxNumber: XXXX9900001 - status: Active - modifiedDate: '2023-01-18T11:02:35Z' - sourceModifiedDate: '2022-12-08T15:42:59Z' - QuickBooks Online Sandbox: - value: - id: '66' - customerName: Abercrombie International Group - contactName: Kristy Abercrombie - defaultCurrency: GBP - addresses: - - type: Billing - line1: 123 Main St - city: 'New York, NY' - contacts: - - name: Abercrombie International Group (deleted) - phone: [] - address: - type: Billing - line1: 123 Main St - city: 'New York, NY' - status: Archived - status: Archived - modifiedDate: '2023-04-26T09:35:56Z' - sourceModifiedDate: '2016-09-12T18:53:19Z' - metadata: - isDeleted: false - Sage 200cloud: - value: - id: A1D001 - customerName: A1 Design Services - contactName: Lee Dalkin - emailAddress: newbusinessadvice@sage.com - defaultCurrency: GBP - phone: 01742 876 234 - addresses: - - type: Delivery - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: '' - postalCode: BP12 7HT - - type: Delivery - line1: 23a Union Street - line2: '' - city: Manchester - region: '' - country: '' - postalCode: M2 6JK - - type: Billing - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: Great Britain - postalCode: BP12 7HT - contacts: - - name: Lee Dalkin - email: newbusinessadvice@sage.com - phone: - - number: 01742 876 234 - type: Landline - - number: 01742 876 235 - type: Landline - - number: 01742 876 236 - type: Fax - status: Active - - name: Malcolm Leverret - email: '' - phone: [] - status: Active - - name: Jim Thomas - email: Jim@a1designservices.co.uk - phone: - - number: 01742 876 234 - type: Landline - - number: 01742 876 235 - type: Fax - status: Active - - name: Jullian Plawsworth - email: Jullian@a1designservices.co.uk - phone: - - number: 0151 349 3939 - type: Landline - - number: 0151 349 3940 - type: Fax - status: Active - registrationNumber: '' - taxNumber: GB238 3839 38 - status: Active - modifiedDate: '2022-10-14T09:35:53Z' - sourceModifiedDate: '2022-04-27T15:17:36Z' - Sage 50 (UK): - value: - id: A1D001 - customerName: A1 Design Services - contactName: Ian Cairns - emailAddress: newbusinessadvice@sage.com - defaultCurrency: GBP - phone: 01742 876 234 - addresses: - - type: Delivery - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: GB - postalCode: BP12 7HT - - type: Delivery - line1: 23a Union Street - line2: '' - city: Manchester - region: '' - country: GB - postalCode: M2 6JK - - type: Unknown - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: GB - postalCode: BP12 7HT - contacts: [] - taxNumber: GB238 3839 38 - status: Active - modifiedDate: '2023-03-30T14:42:41Z' - sourceModifiedDate: '2022-11-25T09:43:54Z' - metadata: - isDeleted: false - Sage Business Cloud Accounting: - value: - id: 260f6a3f94a243738f2d5e08496a41a8 - customerName: 100 test name - contactName: Main Contact - emailAddress: email@codat.io - defaultCurrency: GBP - phone: contact phone number - addresses: - - type: Billing - line1: Aruba Address line 1 - line2: Aruba Address line 2 - city: Aruba City - region: Aruba Province - country: Aruba (AW) - postalCode: Aruba Post - contacts: - - phone: - - number: contact mobile number - type: Mobile - - number: contact fax number - type: Fax - status: Unknown - status: Active - modifiedDate: '2022-10-24T14:52:54Z' - sourceModifiedDate: '2021-05-10T16:31:51Z' - Sage Intacct: - value: - id: '188' - customerName: 33Across - contactName: Yuna Conn - defaultCurrency: USD - phone: 520-393-4468 - addresses: - - type: Unknown - line1: 155 Westend Point - line2: '' - city: Albuquerque - region: NM - country: United States - postalCode: '87140' - contacts: - - name: 'Conn, Yuna' - phone: - - number: 520-393-4468 - type: Primary - address: - type: Unknown - line1: 155 Westend Point - line2: '' - city: Albuquerque - region: NM - country: United States - postalCode: '87140' - status: Unknown - taxNumber: '' - status: Active - modifiedDate: '2023-04-04T16:32:21Z' - sourceModifiedDate: '2022-09-06T12:58:27' - metadata: - isDeleted: false - Wave: - value: - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 - customerName: ABC Textiles - contactName: '' - emailAddress: c.taylor@codat.io - defaultCurrency: USD - addresses: [] - contacts: [] - status: Active - modifiedDate: '2022-11-16T18:15:30Z' - sourceModifiedDate: '2019-10-17T07:59:04Z' - Xero: - value: - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 - customerName: 24 Locks - emailAddress: '' - addresses: [] - contacts: [] - status: Active - modifiedDate: '2023-03-15T20:35:10Z' - sourceModifiedDate: '2023-02-17T18:03:42' - metadata: - isDeleted: false - Zoho Books: - value: - id: '104957000000032105' - customerName: A B - contactName: Contact (First Name) Contact (Last Name) - emailAddress: contactperson@whateveryouwantidontcare12345.com - defaultCurrency: GBP - phone: Work Phone - addresses: [] - contacts: - - name: Contact (First Name) Contact (Last Name) - email: contactperson@whateveryouwantidontcare12345.com - phone: - - number: Work Phone - type: Landline - - number: Mobile - type: Mobile - status: Active - status: Active - modifiedDate: '2022-10-03T08:40:37Z' - sourceModifiedDate: '2022-06-09T14:36:47' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '409': - $ref: '#/components/responses/Conflict' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - description: | - The *Get customer* endpoint returns a single customer for a given customerId. - - [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. - - Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). - operationId: get-customer - '/companies/{companyId}/connections/{connectionId}/push/customers': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - post: - tags: - - Customers - summary: Create customer - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - - $ref: '#/components/parameters/allowSyncOnPushComplete' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Customer' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateCustomerResponse' - examples: {} - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - operationId: create-customer - description: |- - The *Create customer* endpoint creates a new [customer](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) for a given company's connection. - - [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. - - **Integration-specific behavior** - - Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). - '/companies/{companyId}/connections/{connectionId}/push/customers/{customerId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/customerId' - put: - tags: - - Customers - summary: Update customer - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - - $ref: '#/components/parameters/allowSyncOnPushComplete' - - $ref: '#/components/parameters/forceUpdate' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Customer' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateCustomerResponse' - examples: {} - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - description: |- - The *Update customer* endpoint updates an existing [customer](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) for a given company's connection. - - [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. - - **Integration-specific behavior** - - Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). - operationId: update-customer - '/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-expenses-api#/schemas/Supplier) for a given company's connection. + description: The file to be uploaded as an attachment. + format: binary + BankAccount: + title: Bank accounts + type: object + allOf: + - properties: + id: + type: string + description: 'Identifier for the bank account, unique for the company in the accounting software.' + nominalCode: + type: string + nullable: true + description: Code used to identify each nominal account for a business. + name: + type: string + nullable: true + description: Name of the bank account in the accounting software. + accountType: + $ref: '#/components/schemas/BankAccountType' + accountNumber: + type: string + nullable: true + description: |- + Account number for the bank account. - [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + 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. + sortCode: + type: string + nullable: true + description: |- + Sort code for the bank account. This is relevant to UK bank accounts. - Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-all-data-types). + 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. + currency: + $ref: '#/components/schemas/Bill/properties/currency' + description: Base currency of the bank account. + status: + $ref: '#/components/schemas/BankAccount/definitions/bankAccountStatus' + - 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 accounting software, usually by the business or a business process. For example, when payments are made against an invoice. - ### Supported Integrations + It is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when: + - Pulling attachments + - The accounting software 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 - | Integration | Supported | - |-------------------------------|-----------| - | Dynamics 365 Business Central | Yes | - | FreeAgent | Yes | - | Oracle NetSuite | Yes | - | QuickBooks Desktop | Yes | - | QuickBooks Online | Yes | - | Sage Intacct | Yes | - | Xero | Yes | - | Zoho Books | Yes | - 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. + In Codat's data model, dates and times are represented using the ISO 8601 standard. + definitions: + bankAccountStatus: + type: string + description: The current status of the bank account. + enum: + - Active + - Archived + bankAccountPrototype: + title: Bank account prototype + type: object + properties: + nominalCode: + $ref: '#/components/schemas/BankAccount/allOf/0/properties/nominalCode' + name: + $ref: '#/components/schemas/BankAccount/allOf/0/properties/name' + accountType: + $ref: '#/components/schemas/BankAccountType' + accountNumber: + $ref: '#/components/schemas/BankAccount/allOf/0/properties/accountNumber' + sortCode: + $ref: '#/components/schemas/BankAccount/allOf/0/properties/sortCode' + currency: + $ref: '#/components/schemas/BankAccount/allOf/0/properties/currency' + required: + - name + - accountType + - accountNumber + - currency + BankAccountType: + 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. + Bill: + title: Bill + description: "\uFEFFBills are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services." + 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' + 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: + 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_. - [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + ## Unknown currencies - Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-all-data-types). + In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - ### Supported Integrations + 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 + 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. - | Integration | Supported | - |-------------------------------|-----------| - | Dynamics 365 Business Central | Yes | - | FreeAgent | Yes | - | Oracle NetSuite | Yes | - | QuickBooks Desktop | Yes | - | QuickBooks Online | Yes | - | Sage Intacct | Yes | - | Xero | Yes | - | Zoho Books | Yes | - operationId: get-supplier - '/companies/{companyId}/connections/{connectionId}/push/suppliers': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - post: - tags: - - Suppliers - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - - $ref: '#/components/parameters/allowSyncOnPushComplete' - 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-expenses-api#/schemas/Supplier) for a given company's connection. + Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. - [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + 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. - **Integration-specific behavior** + 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). - 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-expenses-api#/operations/get-create-update-suppliers-model). + 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. - ### Supported Integrations + ## Examples with base currency of GBP - | Integration | Supported | - |-------------------------------|-----------| - | Dynamics 365 Business Central | Yes | - | FreeAgent | Yes | - | Oracle NetSuite | Yes | - | QuickBooks Desktop | Yes | - | QuickBooks Online | Yes | - | Sage Intacct | Yes | - | Xero | Yes | - | Zoho Books | Yes | - 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/allowSyncOnPushComplete' - - $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-expenses-api#/schemas/Supplier) for a given company's connection. + | 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 | - [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + ## Examples with base currency of USD - **Integration-specific behavior** + | 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 | - 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-expenses-api#/operations/get-create-update-suppliers-model). - ### Supported Integrations + ### Integration-specific details - | Integration | Supported | - |-------------------|-----------| - | FreeAgent | Yes | - | QuickBooks Online | Yes | - | Xero | Yes | - operationId: update-supplier -webhooks: - expenses.sync.successful: - post: - description: Called when an expense sync successfully completes without any errors or warnings. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExpensesSyncWebhook' - examples: - Successful: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: expenses.sync.successful - generatedDate: '2024-09-01T00:00:00Z' - payload: - referenceCompany: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: Toft stores - description: Syncing expenses - syncId: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd - transactions: - - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 - status: Completed - errorMessage: null - - id: e7f8a3d5-0c3c-4c9b-b5d3-56b4a43b62e4 - status: Completed - errorMessage: null - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - expenses.sync.unsuccessful: - post: - description: 'Called when an expense sync fails to complete successfully, resulting in at least one error or warning.' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExpensesSyncWebhook' - examples: - Unsuccessful: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: expenses.sync.unsuccessful - generatedDate: '2024-09-01T00:00:00Z' - payload: - referenceCompany: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: Toft stores - description: Syncing expenses - syncId: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd - transactions: - - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 - status: Completed - errorMessage: null - - id: e7f8a3d5-0c3c-4c9b-b5d3-56b4a43b62e4 - status: Failed - errorMessage: Insufficient funds - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - 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. -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\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-expenses-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: - 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 - - title: Modified dates - x-internal: true + | 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. | + lineItems: + type: array + nullable: true + description: Array of Bill line items. + items: + $ref: '#/components/schemas/Bill/definitions/billLineItem' + status: + $ref: '#/components/schemas/Bill/definitions/billStatus' + 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. + sourceModifiedDate: allOf: - - title: ModifiedDate - x-internal: true - type: object - properties: - modifiedDate: - allOf: - - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - - description: |- - The date when the record was last fetched from the accounting software, commerce software, or open banking provider 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/TransferTransactionRequest/properties/date/allOf/1' - - description: |- - The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. + - $ref: '#/components/schemas/Connection/properties/created' + - description: |- + The date when a record was last modified in the accounting software, 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 accounting software 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 + It is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when: + - Pulling attachments + - The accounting software 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. + In Codat's data model, dates and times are represented using the ISO 8601 standard. + required: + - supplierRef + - issueDate + - dueDate + - currency + - status definitions: - accountPrototype: - title: Account prototype + billPrototype: + title: Bill prototype + type: object + properties: + reference: + $ref: '#/components/schemas/Bill/properties/reference' + supplierRef: + $ref: '#/components/schemas/Supplier/definitions/supplierRef' + issueDate: + $ref: '#/components/schemas/Bill/properties/issueDate' + dueDate: + $ref: '#/components/schemas/Bill/properties/dueDate' + currency: + $ref: '#/components/schemas/Bill/properties/currency' + currencyRate: + $ref: '#/components/schemas/Bill/properties/currencyRate' + lineItems: + $ref: '#/components/schemas/Bill/properties/lineItems' + status: + $ref: '#/components/schemas/Bill/definitions/billStatus' + required: + - supplierRef + - issueDate + - dueDate + - currency + - status + billStatus: + description: Current state of the bill. If creating a bill the status must be `Open`. + type: string + enum: + - Unknown + - Open + - PartiallyPaid + - Paid + - Void + - Draft + example: Open + billLineItem: + title: Bill line item 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: + description: Friendly name of the goods or services received. + unitAmount: + type: number + format: decimal + description: Unit price of the goods or service. + quantity: + type: number + format: decimal + description: Number of units of goods or services received. + taxAmount: + type: number + format: decimal + description: Amount of tax applied to the line item. + accountRef: + $ref: '#/components/schemas/Bill/definitions/billAccountRef' + totalAmount: 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: + description: 'Total amount of the line, including tax.' + taxRateRef: + $ref: '#/components/schemas/Bill/definitions/billTaxRateRef' + trackingRefs: 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-expenses-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: + $ref: '#/components/schemas/Bill/definitions/trackingRef' + billAccountRef: 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.' + description: Reference to the account to which the line item is linked. properties: id: type: string description: '''id'' from the Accounts data type.' - name: + billTaxRateRef: + title: Tax rate reference + type: object + description: Reference to the tax rate to which the line item is linked. + properties: + id: 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 - AccountMappingInfo: - title: Account mapping info + description: Unique identifier for the tax rate in the accounting software. + bills: + title: Bills + type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Bill' + pagination: + $ref: '#/components/schemas/Pagination' + trackingRef: + type: object + title: Tracking reference + properties: + id: + type: string + example: e9a1b63d-9ff0-40e7-8038-016354b987e6 + description: Unique identifier of the linked tracking category or the unique identifier of the linked customer. + dataType: + type: string + example: trackingCategories + description: The type of the linked reference. + enum: + - trackingCategories + - customers + isBillable: + type: boolean + description: If a customer has been set as the trackingRefs.id then this boolean can be used to set whether the line item is billable to the customer or not. + BillEventWebhook: x-internal: true + title: Bill event webhook type: object - additionalProperties: false - x-examples: - Example AccountInfo: - id: 313a4dbe-b3a4-42f0-a5f5-43e382e62db9 - nominalCode: '720' - name: Travel - currency: GBP - accountType: Expense - fullyQualifiedCategory: Expense.Overhead - isBankAccount: false - validTransactionTypes: - - Payment - - Refund - validFor: - - expense-transactions.Payment - - expense-transactions.Refund - - reimbursable-expense-transactions properties: id: type: string - description: Unique identifier of account. - example: 127f3b99-8dc2-4b7e-854c-91ef9bd2757b - nullable: false - nominalCode: - type: string - description: Code used to identify each nominal account in the accounting software. - example: '300' - nullable: true - name: - type: string - description: Name of the account as it appears in the company's accounting software. - example: Purchases - nullable: false - currency: - type: string - description: Currency of the account. - example: GBP - nullable: false - accountType: + format: uuid + description: Unique identifier of the bill event. + type: type: string - description: Type of the account. - example: Expense - enum: - - Asset - - Liability - - Income - - Expense - - Equity - nullable: false - fullyQualifiedCategory: + description: Type of webhook event. + example: payables.bill.created + createdDate: type: string - description: Full account type and category of the account - example: Expense.DirectCosts - nullable: false - isBankAccount: - type: boolean - description: Confirms whether the account is a bank account or not. - validTransactionTypes: - $ref: '#/components/schemas/validTransactionTypes' - description: Supported transaction types for the account. - validFor: - $ref: '#/components/schemas/validFor' - description: Supported endpoints for the account. - AdjustmentTransactionLine: + description: The datetime in UTC of when the webhook event was produced by Codat. + examples: + - '2022-10-23T11:03:35Z' + payload: + $ref: '#/components/schemas/BillEventWebhook/definitions/billEventPayload' + definitions: + billEventPayload: + title: Bill event payload + type: object + properties: + companyId: + $ref: '#/components/parameters/companyId/schema' + connectionId: + $ref: '#/components/parameters/connectionId/schema' + pushOperationKey: + type: string + format: uuid + example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + description: Unique identifier for the push operation. + bill: + $ref: '#/components/schemas/Bill' + BillMappingOptions: x-internal: true - title: Adjustment transaction line + title: Mapping options bills + description: The bill mapping options for a company's accounting software. type: object properties: - amount: - type: number - format: decimal - example: 50 - description: Amount of the line. A positive line represents a debit; a negative line represents a credit. - accountRef: - $ref: '#/components/schemas/RecordRef' - description: - type: string - description: 'Any private, company notes about the transaction.' - example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - trackingRefs: + accounts: type: array - minItems: 1 - maxItems: 10 - nullable: true items: - $ref: '#/components/schemas/TrackingRefAdjustmentTransaction' - invoiceTo: - $ref: '#/components/schemas/InvoiceTo' - required: - - amount - - accountRef - AdjustmentTransactionRequest: - title: Adjustment transaction - type: object - properties: - id: - type: string - format: uuid - description: Your unique identifier for the transaction. - date: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: Date of the transaction. - currency: - type: string - description: Currency the transaction was recorded in. - currencyRate: - $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' - reference: - type: string - nullable: true - description: User-friendly reference for the adjustment transaction. - lines: + $ref: '#/components/schemas/BillMappingOptions/definitions/accountMappingOption' + taxRates: type: array - description: Array of transaction lines. - minItems: 1 - maxItems: 100 items: - $ref: '#/components/schemas/AdjustmentTransactionLine' - required: - - id - - date - - currency - - lines - AdjustmentTransactionResponse: - title: Adjustment response - x-internal: true - type: object - properties: - syncId: - type: string - example: cd937d46-8e41-43a9-9477-a79158ffd98a - format: uuid - description: Unique id of sync created - apAccountRef: - x-internal: true - type: object - title: Accounts Payable account reference - nullable: true - properties: - id: + $ref: '#/components/schemas/BillMappingOptions/definitions/taxRateMappingOption' + pagination: + $ref: '#/components/schemas/Pagination' + definitions: + accountMappingOption: + title: Account mapping option + type: object + allOf: + - properties: + id: + type: string + description: 'Identifier for the account, unique for the company.' + example: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + 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 Payable + type: + type: string + nullable: true + description: Type of account. + example: Liability + currency: + $ref: '#/components/schemas/Bill/properties/currency' + status: + $ref: '#/components/schemas/BillMappingOptions/definitions/accountStatus' + - $ref: '#/components/schemas/BankAccount/allOf/1' + taxRateMappingOption: + title: Tax rate mapping option + type: object + allOf: + - properties: + id: + type: string + description: 'Identifier for the tax rate, unique for the company in the accounting software.' + example: d2939064-dd3a-4c0f-9865-a238c2193515 + 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. + 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. + status: + title: Tax rate status + type: string + enum: + - Active + - Archived + 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. + accountStatus: type: string - example: 8000004C-1724173136 - description: Unique identifier for the Accounts Payable account associated with the transaction. The `apAccountRef` object is currently supported only for QuickBooks Desktop. - Attachment: - title: Attachment + description: The current status of the account. + enum: + - Active + - Archived + example: Active + BillPayment: + title: Bill payment type: object - x-examples: - Attachment Example: - companyId: bf1e0242-5b7a-418b-a307-9e09dbf9f39a - id: '1400000000122699154' - transactionId: f8f00edd-ddb0-4ca5-b36b-8f932e6b5160 + description: '' properties: - companyId: - type: string - format: uuid - description: Unique ID of company in Codat id: type: string - description: Unique identifier of attachment - transactionId: - type: string - description: Unique identifier of transaction - AttachmentUpload: - title: Attachment upload - type: object - x-internal: true - required: - - file - properties: - file: - $ref: '#/components/schemas/AttachmentUpload/definitions/codatFile' - definitions: - codatFile: + description: 'Identifier for the bill payment, unique for the company in the accounting software.' + amount: + type: number + format: decimal + description: Amount of the payment in the bill currency. + example: 1329.54 + date: + allOf: + - $ref: '#/components/schemas/Connection/properties/created' + - description: Date the bill payment was recorded in the accounting software. + reference: 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 [Banking: Account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) data type. - - ## 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/Account/allOf/2/properties/metadata' - supplementalData: - $ref: '#/components/schemas/SupplementalData' - - $ref: '#/components/schemas/Account/allOf/3' + nullable: true + description: Additional information associated with the payment. + example: Bill Payment against bill c13e37b6-dfaa-4894-b3be-9fe97bda9f44 + accountRef: + $ref: '#/components/schemas/BillPayment/definitions/billPaymentAccountRef' + currencyRate: + $ref: '#/components/schemas/Bill/properties/currencyRate' definitions: - bankAccountPrototype: - title: Bank account prototype + billPaymentPrototype: + title: Bill payment 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 + amount: + $ref: '#/components/schemas/BillPayment/properties/amount' + date: + $ref: '#/components/schemas/BillPayment/properties/date' + reference: + $ref: '#/components/schemas/BillPayment/properties/reference' + accountRef: + $ref: '#/components/schemas/BillPayment/definitions/billPaymentAccountRef' + currencyRate: + $ref: '#/components/schemas/Bill/properties/currencyRate' + required: + - amount + - date + - accountRef + billPaymentAccountRef: + description: Reference to the bank account / credit card which you are using to pay the bill. 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 + description: Unique ID of the bank account / credit card + required: + - id + example: + amount: 22 + date: '2022-10-23T00:00:00.000Z' + reference: Bill Payment against bill c13e37b6 dfaa-4894-b3be-9fe97bda9f44 + accountRef: + id: 9e32cbf8-e7d5-4d4d-a593-08d550682aab + currencyRate: 1 ClientRateLimitWebhook: title: Client rate limit webhook type: object @@ -10665,7 +2592,7 @@ components: - client.rateLimit.reset - client.rateLimit.reached generatedDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $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' @@ -10681,7 +2608,7 @@ components: type: integer description: Total number of requests remaining for your client. expiryDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' description: The date time in UTC when your daily quota is reset. Companies: title: Companies @@ -10696,7 +2623,7 @@ components: - $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-expenses-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." + 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' @@ -10726,10 +2653,10 @@ components: 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/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' nullable: true created: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' createdByUserName: type: string description: Name of user that created the company in Codat. @@ -10808,234 +2735,19 @@ components: products: - spend-insights - lending - CompanyConfiguration: - required: - - bankAccount - - supplier - - customer - title: Company configuration - type: object - x-examples: - Config Example: - bankAccount: - id: '89' - supplier: - id: '124' - customer: - id: '140' - properties: - bankAccount: - $ref: '#/components/schemas/CompanyConfiguration/definitions/BankAccountDetails' - supplier: - $ref: '#/components/schemas/CompanyConfiguration/definitions/SupplierDetails' - customer: - $ref: '#/components/schemas/CompanyConfiguration/definitions/CustomerDetails' - definitions: - BankAccountDetails: - title: Bank account details - type: object - properties: - id: - type: string - description: The id of the account from which purchases are made - example: '32' - SupplierDetails: - title: Supplier details - type: object - properties: - id: - $ref: '#/components/schemas/Supplier/allOf/0/properties/id' - CustomerDetails: - title: Customer details - type: object - properties: - id: - $ref: '#/components/schemas/Customer/allOf/0/properties/id' CompanyInformation: - title: 'Accounting: Company information' - description: |- - Company info provides standard details about a linked company such as their address, phone number, and company registration. - - > **Company information or companies?** - > - > Company information 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. + title: Company information type: object + description: Gets the latest basic info for a company. properties: companyName: type: string nullable: true description: Name of the linked company. - accountingPlatformRef: - type: string - nullable: true - description: Identifier or reference for the company in the accounting software. - companyLegalName: - type: string - nullable: true - description: Registered legal name of the linked company. - addresses: - type: array - nullable: true - description: An array of Addresses. - items: - title: 'Accounting: Address' - x-internal: true - type: object - properties: - type: - $ref: '#/components/schemas/CompanyInformation/properties/addresses/items/definitions/accountingAddressType' - line1: - type: string - nullable: true - description: Line 1 of the customer address. - line2: - type: string - nullable: true - description: Line 2 of the customer address. - city: - type: string - nullable: true - description: City of the customer address. - region: - type: string - nullable: true - description: Region of the customer address. - country: - type: string - nullable: true - description: Country of the customer address. - postalCode: - type: string - nullable: true - description: Postal code or zip code. - required: - - type - definitions: - accountingAddressType: - description: The type of the address - type: string - enum: - - Unknown - - Billing - - Delivery - phoneNumbers: - type: array - nullable: true - description: An array of phone numbers. - items: - title: Phone - type: object - x-internal: true - properties: - number: - type: string - nullable: true - examples: - - +44 25691 154789 - - (877) 492-8687 - - 01224 658 999 - description: A phone number. - type: - description: The type of phone number - type: string - enum: - - Primary - - Landline - - Mobile - - Fax - - Unknown - required: - - type - webLinks: - type: array - nullable: true - description: An array of weblinks. - items: - title: Weblink - description: Weblink associated with the company. - type: object - properties: - type: - description: The type of the weblink. - type: string - enum: - - Website - - Social - - Unknown - url: - description: The full URL for the weblink. - type: string - format: url - example: - type: Website - url: 'https://codat.io' - ledgerLockDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - 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/TransferTransactionRequest/properties/date/allOf/1' - 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/TransferTransactionRequest/properties/date/allOf/1' - 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 @@ -11055,70 +2767,6 @@ components: $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' required: - name - CompanySyncStatus: - title: Company sync status - type: object - additionalProperties: false - x-examples: - Success Data Pushed: - companyId: 20803807-4e9a-4cb7-b67b-9f889a3916e1 - syncId: aa4c9dfd-e945-4424-9628-9e724f14c267 - syncStatusCode: 2000 - syncStatus: Complete - errorMessage: '' - syncExceptionMessage: '' - syncUtc: '2023-01-24T14:15:22Z' - dataPushed: true - Success No Data Pushed: - companyId: 20803807-4e9a-4cb7-b67b-9f889a3916e1 - syncId: aa4c9dfd-e945-4424-9628-9e724f14c267 - syncStatusCode: 2040 - syncStatus: Complete - errorMessage: '' - syncExceptionMessage: '' - syncUtc: '2023-01-24T14:15:22Z' - dataPushed: false - properties: - companyId: - type: string - description: Unique identifier for your SMB in Codat. - example: d4d73051-ed31-42b6-99f6-d288cd940992 - nullable: true - syncId: - type: string - description: Unique identifier of the sync. - example: a6a22aff-a43a-411d-a910-2dae73217cce - nullable: true - syncStatusCode: - type: integer - format: int32 - description: Status code of the sync. - example: 2000 - syncStatus: - type: string - description: Text status of the sync. - examples: - - Complete - - PushError - - Started - - NotStarted - - Pushing - nullable: true - errorMessage: - type: string - description: Error message of the sync. - nullable: true - syncExceptionMessage: - type: string - description: Exception message of the sync. - nullable: true - syncUtc: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: Datetime of the sync. - nullable: true - dataPushed: - type: boolean - description: Boolean of whether the sync resulted in data being pushed. CompanyUpdateRequest: title: Update company request x-internal: true @@ -11136,7 +2784,7 @@ components: $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' Connection: title: Connection - description: "\uFEFFA connection represents a [company's](https://docs.codat.io/sync-for-expenses-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)." + 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: @@ -11178,295 +2826,117 @@ components: status: $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' lastSync: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' nullable: true created: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - dataConnectionErrors: - type: array - nullable: true - items: - $ref: '#/components/schemas/Connection/definitions/dataConnectionError' - connectionInfo: - type: object - nullable: true - additionalProperties: true - 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/TransferTransactionRequest/properties/date/allOf/1' - 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/TransferTransactionRequest/properties/date/allOf/1' - 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: Create account response - x-internal: true - allOf: - - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/Account' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - CreateAdjustmentRequest: - title: Create adjustment request - x-internal: true - type: array - minItems: 1 - maxItems: 50 - items: - $ref: '#/components/schemas/AdjustmentTransactionRequest' - CreateBankAccountResponse: - title: Create bank account response - x-internal: true - allOf: - - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/BankAccount' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - CreateCustomerResponse: - title: Create customer response - x-internal: true - allOf: - - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/Customer' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - CreateExpenseRequest: - title: Create expense request - x-internal: true - type: array - minItems: 1 - maxItems: 50 - items: - $ref: '#/components/schemas/ExpenseTransaction' - CreateExpenseResponse: - title: Create expense response - x-internal: true - type: object - properties: - syncId: - type: string - example: cd937d46-8e41-43a9-9477-a79158ffd98a - format: uuid - description: Unique id of sync created - CreateReimbursableExpenseResponse: - title: Create reimbursable expense response - x-internal: true - type: object - properties: - syncId: + title: Date time type: string - example: cd937d46-8e41-43a9-9477-a79158ffd98a - format: uuid - description: Unique id of sync created - CreateSupplierResponse: - title: Create supplier response - x-internal: true - allOf: - - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/Supplier' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - Customer: - title: 'Accounting: Customer' - description: | - ## Overview + examples: + - '2022-10-23T00:00:00Z' + - '2022-10-23' + 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: - A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). + ``` + 2020-10-08T22:40:50Z + 2021-01-01T00:00:00 + ``` - Customers' data links to accounts receivable [invoices](https://docs.codat.io/sync-for-expenses-api#/schemas/Invoice). - type: object - allOf: - - type: object - properties: - id: - type: string - description: 'Identifier for the customer, unique to the company in the accounting software.' - customerName: - type: string - nullable: true - description: 'Name of the customer as recorded in the accounting system, typically the company name.' - contactName: - type: string - nullable: true - description: Name of the main contact for the identified customer. - emailAddress: - type: string - nullable: true - description: Email address the customer can be contacted by. - defaultCurrency: - $ref: '#/components/schemas/Account/definitions/accountPrototype/properties/currency' - description: Default currency the transactional data of the customer is recorded in. - phone: - type: string - nullable: true - description: Phone number the customer can be contacted by. - addresses: - type: array - nullable: true - description: An array of Addresses. - items: - $ref: '#/components/schemas/CompanyInformation/properties/addresses/items' - contacts: - type: array - nullable: true - description: An array of Contacts. - items: - $ref: '#/components/schemas/Customer/definitions/contact' - registrationNumber: - type: string - nullable: true - description: 'Company number. In the UK, this is typically the Companies House company registration number.' - taxNumber: - type: string - nullable: true - description: Company tax number. - status: - $ref: '#/components/schemas/Customer/definitions/customerStatus' - description: Current state of the customer. - metadata: - $ref: '#/components/schemas/Account/allOf/2/properties/metadata' - supplementalData: - $ref: '#/components/schemas/SupplementalData' - - $ref: '#/components/schemas/Account/allOf/3' + + + 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: true + additionalProperties: false required: + - id + - integrationId + - integrationKey + - sourceId + - platformName + - linkUrl - status + - created + - sourceType definitions: - accountingCustomerRef: - type: object - properties: - id: - minLength: 1 - type: string - description: '`id` from the Customers data type' - companyName: - type: string - nullable: true - description: '`customerName` from the Customer data type' - required: - - id - customerStatus: - description: Status of customer. + dataConnectionStatus: + title: Data connection status + description: The current authorization status of the data connection. type: string enum: - - Unknown - - Active - - Archived - contact: + - PendingAuth + - Linked + - Unlinked + - Deauthorized + dataConnectionError: + title: Data connection error type: object properties: - name: + statusCode: type: string - nullable: true - description: Name of a contact for a customer. - email: + 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 - description: Email of a contact for a customer. - phone: - type: array + enum: + - Active + - Resolved + resolvedOnUtc: + description: The datetime in Utc that the error was resolved. nullable: true - description: An array of Phone numbers. - items: - $ref: '#/components/schemas/CompanyInformation/properties/phoneNumbers/items' - address: - $ref: '#/components/schemas/CompanyInformation/properties/addresses/items' - description: An object of Address information. - status: - $ref: '#/components/schemas/Customer/definitions/customerStatus' - modifiedDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - required: - - status - Customers: - title: Customers + $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 @@ -11474,7 +2944,7 @@ components: results: type: array items: - $ref: '#/components/schemas/Customer' + $ref: '#/components/schemas/Connection' - $ref: '#/components/schemas/PagingInfo' DataStatus: title: Data status @@ -11535,7 +3005,7 @@ components: - commerce-transactions example: invoices lastSuccessfulSync: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' currentStatus: $ref: '#/components/schemas/PullOperation/properties/status' latestSyncId: @@ -11554,12 +3024,6 @@ components: 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' @@ -11621,319 +3085,14 @@ components: type: string nullable: true description: Name of validator. - ExpenseContactRef: - type: object - title: Supplier/customer reference - x-internal: true - properties: - id: - type: string - example: 40e3e57c-2322-4898-966c-ca41adfd23fd - description: Identifier of supplier or customer. - type: - type: string - description: The type of contact. - example: Supplier - default: Supplier - enum: - - Supplier - required: - - id - ExpensesSyncWebhook: - title: Expenses sync webhook - type: object - properties: - id: - type: string - format: uuid - example: ba29118f-5406-4e59-b05c-ba307ca38d01 - description: Unique identifier of the event. - eventType: - type: string - description: The type of event. - examples: - - expenses.sync.successful - - expenses.sync.unsuccessful - generatedDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/ExpensesSyncWebhook/definitions/expensesSyncWebhookPayload' - definitions: - transaction: - title: Transaction - type: object - properties: - id: - type: string - description: Unique identifier of the transaction. - status: - type: string - enum: - - Unknown - - PushError - - Completed - - Failed - - Pending - description: Status of transaction. - errorMessage: - type: string - nullable: true - description: Error message for failed transaction. - expensesSyncWebhookPayload: - title: Expenses sync webhook payload - type: object - properties: - referenceCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - syncId: - type: string - description: Unique identifier of the sync. - transactions: - type: array - items: - $ref: '#/components/schemas/ExpensesSyncWebhook/definitions/transaction' - ExpenseTransaction: - title: Expense transaction - type: object - properties: - id: - type: string - example: 4d7c6929-7770-412b-91bb-44d3bc71d111 - format: uuid - description: Your unique identifier for the transaction. - type: - type: string - example: Payment - description: The type of transaction. - enum: - - Payment - - Refund - - Reward - - Chargeback - issueDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: Date of the transaction was recorded. - currency: - type: string - example: GBP - description: Currency the transaction was recorded in. - 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. | - contactRef: - description: Supplier or customer for the purchase to be associated to. - $ref: '#/components/schemas/ExpenseContactRef' - bankAccountRef: - type: object - title: Bank account reference - properties: - id: - type: string - example: 787dfb37-5707-4dc0-8a86-8d74e4cc78ea - description: Identifier of the bank account. - reference: - type: string - nullable: true - description: User-friendly reference for the expense transaction. - merchantName: - type: string - example: Amazon UK - description: Name of the merchant where the purchase took place - lines: - type: array - description: Array of transaction lines. - minItems: 1 - maxItems: 100 - items: - $ref: '#/components/schemas/ExpenseTransactionLine' - notes: - type: string - description: 'Any private, company notes about the transaction.' - example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - postAsDraft: - type: boolean - nullable: true - description: 'This optional property, when set to true, posts the transaction to a drafted state. Note that postAsDraft is only supported in Microsoft Dynamics 365 Business Central.' - required: - - id - - type - - issueDate - - currency - examples: - - id: a44135b0-6882-489a-83fe-a0c57a4afb19 - type: Payment - issueDate: '2024-05-21T00:00:00+00:00' - currency: GBP - currencyRate: 1 - contactRef: - id: '430' - type: Supplier - bankAccountRef: - id: '97' - merchantName: Amazon UK - notes: amazon purchase - lines: - - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 23_Bills - accountRef: - id: '35' - trackingRefs: - - id: DEPARTMENT_3 - - dataType: trackingCategories - invoiceTo: - id: '504' - type: customer - ExpenseTransactionLine: - x-internal: true - title: Expense transaction line - type: object - x-examples: - ExpenseTransactionLine: - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 08d37c46-8d5d-441b-8bad-76286c43047e - accountRef: - id: 16989b16-96d4-401a-9054-f5c620c655a6 - trackingRefs: - - id: e9a1b63d-9ff0-40e7-8038-016354b987e6 - invoiceTo: - id: 80000002-1674552702 - type: customer - properties: - netAmount: - type: number - format: decimal - example: 100 - description: 'Amount of the line, exclusive of tax.' - taxAmount: - type: number - format: decimal - example: 20 - description: Amount of tax for the line. - taxRateRef: - $ref: '#/components/schemas/RecordRef' - accountRef: - description: The `accountRef` contains the `id` of the account the transaction is against. The `accountRef` object is required for all integrations except QBD which currently supports either itemRef or accountRef. - $ref: '#/components/schemas/RecordRef' - itemRef: - $ref: '#/components/schemas/ItemRef' - trackingRefs: - type: array - minItems: 1 - maxItems: 10 - nullable: true - items: - $ref: '#/components/schemas/TrackingRef' - invoiceTo: - $ref: '#/components/schemas/InvoiceTo' - required: - - netAmount - IntegrationType: - title: Integration type - x-internal: true - type: string - description: Type of transaction that has been processed e.g. Expense or Bank Feed. - enum: - - expenses - - bankfeeds - default: expenses - example: expenses - nullable: true - InvoiceTo: - title: Billable customer reference - x-internal: true - type: object - nullable: true - description: Unique identifier for the customer billed for the transaction. The `invoiceTo` object is currently supported only for QuickBooks Online and QuickBooks Desktop. - properties: - id: - type: string - example: 80000002-1674552702 - description: identifier of customer. - type: - type: string - example: customer - description: The type of contact. - enum: - - customer - ItemRef: + Pagination: + title: Pagination metadata x-internal: true type: object - title: Item reference - nullable: true - properties: - id: - type: string - example: 80000002-1675158984 - description: 'Unique identifier for the item associated with the transaction. The `itemRef` object is currently supported only for QuickBooks Desktop. You can specify either `itemRef` or `accountRef`, but not both.' - MappingOptions: - title: Mapping options - type: object - additionalProperties: false - x-examples: {} properties: - expenseProvider: + continuationToken: type: string - description: Name of the expense integration. - example: Partner Expense - nullable: true - accounts: - type: array - description: Array of available accounts for mapping. - nullable: true - items: - $ref: '#/components/schemas/AccountMappingInfo' - trackingCategories: - type: array - description: Array of available tracking categories for mapping. - nullable: true - items: - $ref: '#/components/schemas/TrackingCategoryMappingInfo' - taxRates: - type: array - description: Array of available tax rates for mapping. - nullable: true - items: - $ref: '#/components/schemas/TaxRateMappingInfo' + description: 'A continuation token indicating there are more results to be fetched. Supply this value in the `continuationToken` query parameter in the next request to fetch the next set of results. Once no more results are available, the continuation token will not be present in the response.' PagingInfo: type: object title: Pagination information @@ -11994,6 +3153,69 @@ components: href: '/companies/{id}/data/{dataType}' current: href: '/companies/{id}/data/{dataType}?page=1&pageSize=10' + PaymentMappingOptions: + x-internal: true + title: Mapping Options Payments + description: Gets the bill payments mapping options for a company's accounting software + type: object + properties: + bankAccounts: + type: array + items: + $ref: '#/components/schemas/PaymentMappingOptions/definitions/bankAccountMappingOption' + pagination: + $ref: '#/components/schemas/Pagination' + definitions: + bankAccountMappingOption: + title: Bank account mapping option + type: object + allOf: + - properties: + id: + type: string + description: 'Identifier for the account, unique for the company in the accounting software.' + example: 3d5a8e00-d108-4045-8823-7f342676cffa + name: + type: string + nullable: true + description: Name of the bank account in the accounting software. + example: Bank of Dave current account + 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. + 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. + currency: + type: string + nullable: true + description: The bank account's base currency. + status: + $ref: '#/components/schemas/PaymentMappingOptions/definitions/bankAccountStatus' + accountType: + $ref: '#/components/schemas/BankAccountType' + - $ref: '#/components/schemas/BankAccount/allOf/1' + bankAccountStatus: + type: string + description: The current status of the bank account. + enum: + - Active + - Archived + example: Active PullOperation: title: Pull operation description: |- @@ -12057,9 +3279,9 @@ components: nullable: true description: A message about a transient or persistent error returned by Codat or the source platform. requested: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' completed: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' progress: type: integer description: An integer signifying the progress of the pull operation. @@ -12124,10 +3346,10 @@ components: dataConnectionKey: $ref: '#/components/parameters/connectionId/schema' requestedOnUtc: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' description: The datetime when the push was requested. completedOnUtc: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' description: 'The datetime when the push was completed, null if Pending.' timeoutInMinutes: type: integer @@ -12226,966 +3448,165 @@ components: 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' - RecordRef: - x-internal: true - type: object - title: Record reference - properties: - id: - type: string - example: 40e3e57c-2322-4898-966c-ca41adfd23fd - description: Identifier of linked reference from mapping options. - ReimbursableExpenseTransactionLine: - x-internal: true - title: Reimbursable expense transaction line - type: object - properties: - description: - type: string - example: 2-night hotel stay - description: line description - netAmount: - type: number - format: decimal - example: 100 - description: 'Amount of the line, exclusive of tax.' - taxAmount: - type: number - format: decimal - example: 20 - description: Amount of tax for the line. - taxRateRef: - $ref: '#/components/schemas/RecordRef' - accountRef: - description: The `accountRef` contains the `id` of the account the transaction is against. The `accountRef` object is required for all integrations except QBD which currently supports either itemRef or accountRef. - $ref: '#/components/schemas/RecordRef' - itemRef: - $ref: '#/components/schemas/ItemRef' - trackingRefs: - type: array - minItems: 1 - maxItems: 10 - nullable: true - items: - $ref: '#/components/schemas/TrackingRef' - invoiceTo: - $ref: '#/components/schemas/InvoiceTo' - required: - - netAmount - ReimbursableExpenseTransactionRequest: - title: Reimbursable expense transaction request - type: array - minItems: 1 - maxItems: 50 - items: - $ref: '#/components/schemas/ReimbursableExpenseTransactionRequest/definitions/reimbursableExpenseTransaction' - definitions: - reimbursableExpenseTransaction: - title: Reimbursable expense transaction - type: object - properties: - id: - type: string - example: 4d7c6929-7770-412b-91bb-44d3bc71d111 - format: uuid - description: Your unique identifier for the transaction. - reference: - type: string - nullable: true - description: User-friendly reference for the reimbursable expense. - contactRef: - $ref: '#/components/schemas/ReimbursementContactRef' - apAccountRef: - $ref: '#/components/schemas/apAccountRef' - issueDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: Date of the transaction was recorded. - dueDate: - description: Date the supplier is due to be paid. - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - currency: - type: string - example: GBP - description: Currency the transaction was recorded in. - currencyRate: - $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' - notes: - type: string - description: 'Any private, company notes about the transaction.' - example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - type: array - description: Array of transaction lines. - minItems: 1 - maxItems: 100 - items: - $ref: '#/components/schemas/ReimbursableExpenseTransactionLine' - required: - - id - - contactRef - - issueDate - - dueDate - - currency - ReimbursementContactRef: - type: object - title: Contact reference - x-internal: true - properties: - id: - type: string - example: 40e3e57c-2322-4898-966c-ca41adfd23fd - description: Identifier of contact. - required: - - id - 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: |- - ## Overview - - From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-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/CompanyInformation/properties/addresses/items' - registrationNumber: - type: string - nullable: true - description: 'Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House.' - taxNumber: - type: string - nullable: true - description: Supplier's company tax number. - status: - $ref: '#/components/schemas/Supplier/definitions/supplierStatus' - defaultCurrency: - type: string - nullable: true - description: Default currency the supplier's transactional data is recorded in. - metadata: - $ref: '#/components/schemas/Account/allOf/2/properties/metadata' - supplementalData: - $ref: '#/components/schemas/SupplementalData' - - $ref: '#/components/schemas/Account/allOf/3' - 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' - SyncCompleteWebhook: - title: Sync complete webhook - x-internal: true - description: Webhook request body used to notify that a sync has completed. - type: object - properties: - ClientId: - $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientId' - ClientName: - $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientName' - CompanyId: - $ref: '#/components/parameters/companyId/schema' - RuleId: - $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleId' - RuleType: - $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleType' - AlertId: - $ref: '#/components/schemas/SyncFailedWebhook/properties/AlertId' - Message: - $ref: '#/components/schemas/SyncFailedWebhook/properties/Message' - Data: - $ref: '#/components/schemas/SyncCompleteWebhook/definitions/SyncCompleteWebhookData' - definitions: - SyncCompleteWebhookData: - type: object - title: Sync complete webhook data - properties: - syncId: - $ref: '#/components/schemas/SyncFailedWebhook/definitions/SyncFailedWebhookData/properties/syncId' - syncType: - $ref: '#/components/schemas/SyncFailedWebhook/definitions/SyncFailedWebhookData/properties/syncType' - examples: - - ClientId: 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e - ClientName: Expense Sync - CompanyId: 1f9559e7-8368-48c9-bdf4-f158e16b8b85 - AlertId: 33a4f8e9-09ae-4334-9b00-7bbe83024672 - RuleId: 5c27631d-3b63-4b50-8228-ee502fd113eb - RuleType: Sync Completed - Message: Sync 321363b4-efa9-4fbc-b71c-0b58d62f3248 for company 1f9559e7-8368-48c9-bdf4-f158e16b8b85 of type Expense completed successfully. - Data: - syncId: 321363b4-efa9-4fbc-b71c-0b58d62f3248 - syncType: Expense - SyncFailedWebhook: - title: Sync failed webhook - x-internal: true - description: Webhook request body used to notify that a sync has failed. - 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. - CompanyId: - $ref: '#/components/parameters/companyId/schema' - 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/SyncFailedWebhook/definitions/SyncFailedWebhookData' - definitions: - SyncFailedWebhookData: - type: object - title: Sync failed webhook data - properties: - syncId: - type: string - format: uuid - example: a9367074-b5c3-42c4-9be4-be129f43577e - description: Unique identifier for the failed sync. - syncType: - type: string - description: The type of sync being performed. - FailureStage: - type: string - description: The stage of the job the sync failed. - examples: - - ClientId: 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e - ClientName: Expense Sync - CompanyId: 1f9559e7-8368-48c9-bdf4-f158e16b8b85 - RuleId: 289c80dc-2aee-4b71-afff-9acd8d051080 - RuleType: Sync Failed - AlertId: 72c1103b-7f17-4a3a-8db5-67c2d360a516 - Message: Sync 3bead2a1-1b3d-4d90-8077-cddc5ca68b01 for company 1f9559e7-8368-48c9-bdf4-f158e16b8b85 of type Expense has failed at step Pushing. - Data: - syncId: 3bead2a1-1b3d-4d90-8077-cddc5ca68b01 - syncType: Expense - FailureStage: Pushing - SyncInitiated: - title: Sync initiated - type: object - properties: - syncId: - type: string - format: uuid - description: Unique identifier for the sync initiated. - additionalProperties: false - TaxRateMappingInfo: - title: Tax rate mapping info + $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' + Supplier: + title: Supplier + description: "\uFEFFSuppliers are people or organizations that provide something, such as a product or service. Use the [List suppliers](https://docs.codat.io/sync-for-payables-v2-api#/operations/list-suppliers) endpoint to retrieve a list of all suppliers for a company.\n\nSuppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-payables-v2-api#/schemas/Bill).\n " type: object - additionalProperties: false - x-examples: - UK Tax Rate: - id: 23_Bills - name: 20% Bill tax Bills - code: 20% Bill tax - effectiveTaxRate: 20 - totalTaxRate: 20 - validTransactionTypes: - - Payment - - Reward properties: id: type: string - description: Unique identifier of tax rate. - example: 23_Bills - nullable: false - name: + description: 'Identifier for the supplier, unique to the company in the accounting software.' + supplierName: type: string - description: Name of the tax rate in the accounting software. - example: 20% Bill tax Bills - nullable: false - code: + description: 'Name of the supplier as recorded in the accounting system, typically the company name.' + contactName: type: string - description: Code for the tax rate from the accounting software. - example: 20% Bill tax nullable: true - effectiveTaxRate: - type: number - format: decimal - description: Effective tax rate. - example: 20 - totalTaxRate: - type: number - format: decimal - description: Total (not compounded) sum of the components of a tax rate. - example: 20 - validTransactionTypes: - $ref: '#/components/schemas/validTransactionTypes' - description: Supported transaction types for the tax rate. - TrackingCategoryMappingInfo: - title: Tracking category mapping info - x-internal: true - type: object - additionalProperties: false - x-examples: - Tracking Category with parentId: - id: DEPARTMENT_1 - name: TestLocation - hasChildren: false - parentId: DEPARTMENTS - Parent Tracking Category: - id: DEPARTMENTS - name: Departments - hasChildren: true - properties: - id: - type: string - description: Unique identifier of the tracking category. - example: DEPARTMENT_2 - nullable: false - name: - type: string - description: Name of the tracking category as it appears in the accounting software. - example: New York - nullable: false - hasChildren: - type: boolean - description: Boolean of whether the tracking category has child categories. - parentId: + description: Name of the main contact for the supplier. + emailAddress: type: string - description: ID of the parent tracking category - example: DEPARTMENTS nullable: true - TrackingRef: - type: object - title: Tracking reference - x-internal: true - properties: - id: - type: string - example: e9a1b63d-9ff0-40e7-8038-016354b987e6 - description: Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer. - dataType: - type: string - example: trackingCategories - default: trackingCategories - description: The type of the linked reference - enum: - - trackingCategories - - customers - TrackingRefAdjustmentTransaction: - type: object - title: Tracking reference - x-internal: true - properties: - id: - type: string - example: e9a1b63d-9ff0-40e7-8038-016354b987e6 - description: Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer or supplier. - dataType: - type: string - example: trackingCategories - default: trackingCategories - description: The type of the linked reference - enum: - - trackingCategories - - customers - - suppliers - Transaction: - title: Transaction - type: object - additionalProperties: false - properties: - transactionId: + description: Email address that the supplier may be contacted on. + phone: type: string - description: Your unique idenfier of the transaction. - example: aa02271d-ed5f-47f5-be76-778d5905225a 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' status: - $ref: '#/components/schemas/TransactionStatus' - message: - type: string - description: Metadata such as validation errors or the resulting record created in the accounting software. + $ref: '#/components/schemas/Supplier/definitions/supplierStatus' + balance: + type: number + format: decimal nullable: true - integrationType: - $ref: '#/components/schemas/IntegrationType' - x-examples: - Successful Transaction: - transactionId: 8fdba4ed-e327-4925-be1a-b7a2b04627f7 - status: Completed - integrationType: expense - Unsuccessful Transaction: - transactionId: 3d694cd1-4cd9-4136-91db-32408195c6fc - status: ValidationError - message: The line item total -208.10((-195.01 + -1.09) + (-10.01 + -1.99)) must equal the transaction total -1.1 - integrationType: string - TransactionResponse: - title: Transaction response - x-internal: true - type: array - items: - $ref: '#/components/schemas/Transaction' - Transactions: - title: Transactions - x-internal: true - additionalProperties: false - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/Transaction' - - $ref: '#/components/schemas/PagingInfo' - x-examples: - Example 1: - results: - - transactionId: aa02271d-ed5f-47f5-be76-778d5905225a - status: Completed - integrationType: expenses - - transactionId: 730177a2-8505-410a-9ebc-c2dd52e4bea9 - status: Completed - integrationType: expenses - pageNumber: 1 - pageSize: 100 - totalResults: 2 - links: - self: - href: string - current: - href: string - TransactionStatus: - title: Transaction status - x-internal: true - type: string - description: Status of the transaction. - enum: - - Unknown - - Pending - - ValidationError - - Completed - - PushError - example: Completed - nullable: true - TransferTransactionRequest: - title: Transfer - type: object - properties: - description: + description: Amount outstanding against the supplier. + defaultCurrency: type: string - description: 'Any private, company notes about the transaction.' - example: Transfer from bank account Y to bank account Z - date: + nullable: true + description: Default currency the supplier's transactional data is recorded in. + sourceModifiedDate: allOf: - - description: Date of the transfer transaction as recorded in the accounting software. - - title: Date time - type: string - examples: - - '2022-10-23T00:00:00Z' - - '2022-10-23' - 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 - ``` - + - $ref: '#/components/schemas/Connection/properties/created' + - description: |- + The date when a record was last modified in the accounting software, 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 accounting software 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 - 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. - from: + In Codat's data model, dates and times are represented using the ISO 8601 standard. + definitions: + supplierPrototype: + title: Supplier prototype type: object properties: - accountRef: - type: object - title: Account reference - description: Reference of the account you are transferring money from. - properties: - id: - type: string - description: '''id'' from the Accounts data type.' - required: - - id - amount: - type: number - format: decimal - description: Amount that has been transferred from the account in the native currency of the account. + supplierName: + $ref: '#/components/schemas/Supplier/properties/supplierName' + contactName: + $ref: '#/components/schemas/Supplier/properties/contactName' + emailAddress: + $ref: '#/components/schemas/Supplier/properties/emailAddress' + phone: + $ref: '#/components/schemas/Supplier/properties/phone' + addresses: + $ref: '#/components/schemas/Supplier/properties/addresses' + status: + $ref: '#/components/schemas/Supplier/definitions/supplierStatus' + balance: + $ref: '#/components/schemas/Supplier/properties/balance' + defaultCurrency: + $ref: '#/components/schemas/Supplier/properties/defaultCurrency' required: - - accountRef - - amount - to: + - supplierName + - status + supplierRef: + title: Supplier reference + description: Reference to the supplier the record relates to. type: object properties: - accountRef: - type: object - title: Account reference - description: Reference of the account you are transferring money to. - properties: - id: - type: string - description: '''id'' from the Accounts data type.' - required: - - id - amount: - type: number - format: decimal - description: Amount that has been transferred to the account in the native currency of the account. + id: + minLength: 1 + type: string + description: The supplier's unique ID + supplierName: + type: string + nullable: true + description: The supplier's name required: - - accountRef - - amount - required: - - date - - from - - to - TransferTransactionResponse: - title: Create transfer response - x-internal: true - type: object - properties: - syncId: - type: string - example: cd937d46-8e41-43a9-9477-a79158ffd98a - format: uuid - description: Unique id of sync created - UpdateCustomerResponse: - title: Update customer response - x-internal: true - allOf: - - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/Customer' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - UpdateExpenseRequest: - title: Updating expense transaction request - type: object - properties: - type: + - id + supplierStatus: + description: Status of the supplier. type: string - example: Payment - description: The type of transaction. enum: - - Payment - - Refund - - Reward - - Chargeback - issueDate: - type: string - description: Date the transaction was recorded. - example: '2022-06-28T00:00:00.000Z' - currency: - type: string - example: GBP - description: Currency the transaction was recorded in. - currencyRate: - $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' - contactRef: - description: Supplier or Customer for the purchase to be associated to. - $ref: '#/components/schemas/ExpenseContactRef' - bankAccountRef: + - Unknown + - Active + - Archived + suppliers: + title: Suppliers type: object - title: Bank account reference - properties: - id: - type: string - example: 787dfb37-5707-4dc0-8a86-8d74e4cc78ea - description: Identifier of the bank account. - merchantName: - type: string - description: Name of the merchant where the purchase took place - example: Amazon UK - lines: - type: array - description: Array of transaction lines. - items: - $ref: '#/components/schemas/ExpenseTransactionLine' - notes: - type: string - description: 'Any private, company notes about the transaction.' - example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - required: - - type - - issueDate - - currency - UpdateExpenseResponse: - title: Update expense response - x-internal: true - type: object - properties: - syncId: - type: string - description: Unique identifier for the update expense sync. - example: 1ad0695c-4566-4715-918c-adbb03eac81e - UpdateReimbursableExpenseTransactionRequest: - title: Updating reimbursable expense transaction request - type: object - properties: - reference: - type: string - nullable: true - description: User-friendly reference for the reimbursable expense. - contactRef: - $ref: '#/components/schemas/ReimbursementContactRef' - apAccountRef: - $ref: '#/components/schemas/apAccountRef' - issueDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: Date of the transaction was recorded. - dueDate: - description: Date the supplier is due to be paid. - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - currency: - type: string - example: GBP - description: Currency the transaction was recorded in. - currencyRate: - $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' - notes: - type: string - description: 'Any private, company notes about the transaction.' - example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - type: array - description: Array of transaction lines. - minItems: 1 - maxItems: 100 - items: - $ref: '#/components/schemas/ReimbursableExpenseTransactionLine' - required: - - contactRef - - issueDate - - dueDate - - currency - UpdateSupplierResponse: - title: Update supplier response - x-internal: true - allOf: - - type: object properties: - data: - allOf: - - $ref: '#/components/schemas/Supplier' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - validFor: - title: Valid endpoints - x-internal: true - type: array - description: Supported endpoints for the account. - nullable: false - items: - type: string - enum: - - expense-transactions.Payment - - expense-transactions.Refund - - expense-transactions.Reward - - expense-transactions.Chargeback - - reimbursable-expense-transactions - - transfer-transactions - - adjustment-transactions - example: expense-transactions.Payment - validTransactionTypes: - title: Valid transaction types - x-internal: true - type: array - description: Supported transaction types for the account. - nullable: false - items: - type: string - enum: - - Payment - - Refund - - Reward - - Chargeback - example: Payment + results: + type: array + items: + $ref: '#/components/schemas/Supplier' + pagination: + $ref: '#/components/schemas/Pagination' + examples: + - id: sup-10933920 + supplierName: Northridge Office Supplies + contactName: Sarah Johnson + emailAddress: sarah.johnson@northridgesupplies.co.uk + phone: +44 (0)1223 322410 + addresses: + - type: Billing + line1: Flat 1 + line2: 2 Dennis Avenue + city: London + region: Camden + country: GB + postalCode: EC1N 7TE + status: Active + balance: 0 + defaultCurrency: GBP + sourceModifiedDate: '2026-03-18T10:30:00Z' parameters: - syncId: - name: syncId + attachmentId: + name: attachmentId in: path required: true schema: type: string format: uuid - example: 6fb40d5e-b13e-11ed-afa1-0242ac120002 - description: Unique identifier for a sync. - transactionId: - name: transactionId - in: path - required: true - schema: - type: string - format: uuid - example: 336694d8-2dca-4cb5-a28d-3ccb83e55eee - description: The unique identifier for your SMB's transaction. + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + description: Unique identifier for an attachment. page: name: page in: query @@ -13223,6 +3644,18 @@ components: type: string example: '-modifiedDate' description: 'Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).' + 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. companyId: name: companyId in: path @@ -13243,58 +3676,22 @@ components: 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' - supplierId: - name: supplierId - in: path - required: true - schema: - type: string - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - 7110701885 - - EILBDVJVNUAGVKRQ - description: Unique identifier for a supplier. - customerId: - name: customerId - in: path - required: true - schema: - type: string - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - 7110701885 - - EILBDVJVNUAGVKRQ - description: Unique identifier for a customer. - timeoutInMinutes: - name: timeoutInMinutes - in: query - schema: - type: integer - format: int32 - description: Time limit for the push operation to complete before it is timed out. - allowSyncOnPushComplete: - name: allowSyncOnPushComplete + continuationToken: + name: continuationToken in: query + required: false schema: - type: boolean - default: true - description: Allow a sync upon push completion. - forceUpdate: - name: forceUpdate + type: string + example: continuationToken=eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ== + description: Retrieve the next page of results using the continuation token from the previous response. + statusQuery: + name: statusQuery in: query + required: false 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.' + type: string + example: status=Archived + description: 'Codat query string allows you to filter by `status` (`status=Active||status=Archived`). [Learn more](https://docs.codat.io/using-the-api/querying) about Codat''s query string.' responses: BadRequest: description: The request made is not valid. @@ -13432,8 +3829,8 @@ components: correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 - Unprocessable-Content: - description: The requests made can't be processed. This may be due to differences in platform support. + Idempotency-Conflict: + description: A request is in progress with the same idempotency key. content: application/json: schema: @@ -13441,10 +3838,10 @@ components: examples: Conflict: value: - statusCode: 422 - service: ExpenseSyncApi - error: Expense transaction updates are not supported for platforms other than Xero. - correlationId: 7c8e23841d211c87f49f30b248f70c93 + statusCode: 409 + service: PublicApi + error: The data set has not been requested. + correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 Too-Many-Requests: diff --git a/.speakeasy/logs/changes/old.openapi.yaml b/.speakeasy/logs/changes/old.openapi.yaml index 7a8bc7ccf..96267f7e1 100644 --- a/.speakeasy/logs/changes/old.openapi.yaml +++ b/.speakeasy/logs/changes/old.openapi.yaml @@ -1,43 +1,14 @@ openapi: 3.1.0 +servers: + - description: Production + url: 'https://api.codat.io' info: - title: Sync for Expenses - version: prealpha + title: Bill pay (synchronous solution) + description: "The API reference for the synchronous Bill Pay solution. \n\nThe synchronous Bill Pay solution is an API and a set of supporting tools designed to integrate a bill pay flow into your app as quickly as possible. It's ideal for facilitating essential bill payment processes within your SMB's accounting software.\n\n[Explore solution](https://docs.codat.io/payables/overview) | [See OpenAPI spec](https://github.com/codatio/oas)\n\n---\n## Supported Integrations\n\n| Integration | Supported |\n|-------------------------------|-----------|\n| FreeAgent | Yes |\n| QuickBooks Online | Yes |\n| Oracle NetSuite | Yes |\n| Sage Intacct | Yes |\n| Xero | Yes |\n| Zoho Books | Yes |\n\n---\n\n## Endpoints\n\n| Endpoints | Description |\n| :- |:- |\n| Companies | Create and manage your SMB users' companies. |\n| Connections | Create new and manage existing data connections for a company. |\n| Company information | View company profile from the source platform. |\n| Bills | Get, create, and update Bills. |\n| Bill payments | Get, create, and update Bill payments. |\n| Suppliers | Get, create, and update Suppliers. |\n| Bank accounts | Create a bank account for a given company's connection. |\n" + version: 3.0.0 contact: name: Codat - url: 'https://www.codat.io/' - email: expenses@codat.io - description: |- - The API for Sync for Expenses. - - Sync for Expenses is an API and a set of supporting tools. It has been built to - enable corporate card and expense management platforms to provide high-quality - integrations with multiple accounting software through a standardized API. - - [Explore product](https://docs.codat.io/sync-for-expenses/overview) | [See our OpenAPI spec](https://github.com/codatio/oas) - - Not seeing the endpoints you're expecting? We've [reorganized our products](https://docs.codat.io/updates/230901-new-products), and you may be using a [different version of Sync for Expenses](https://docs.codat.io/sync-for-expenses-v1-api#/). - - --- - - ## Endpoints - - | Endpoints | Description | - | :- |:- | - | Companies | Create and manage your SMB users' companies. | - | Connections | Create new and manage existing data connections for a company. | - | Configuration | View and manage mapping configuration and defaults for expense transactions. | - | Sync | Monitor the status of data syncs. | - | Expenses | Create and update transactions that represent your customers' spend. | - | Transfers | Create and update transactions that represent the movement of your customers' money. | - | Reimbursements | Create and update transactions that represent your customers' repayable spend. | - | Attachments | Attach receipts to a transaction for a complete audit trail. | - | Transaction status | Monitor the status of individual transactions in data syncs. | - | Manage data | Control and monitor the retrieval of data from an integration. | - | Push operations | View historic push operations. | - | Accounts | Create accounts and view account schemas. | - | Customers | Get, create, and update customers. | - | Suppliers | Get, create, and update suppliers. | - + email: support@codat.io termsOfService: 'https://www.codat.io/legals/' security: - auth_header: [] @@ -78,7 +49,7 @@ x-speakeasy-name-override: methodNameOverride: download-attachment - operationId: ^upload-.*?-attachment methodNameOverride: upload-attachment -x-codat-docs-path: sync-for-expenses-api +x-codat-docs-path: sync-for-payables-api x-codat-keep-docs-paths-local: true x-codat-speakeasy-pagination: type: offsetLimit @@ -93,40 +64,16 @@ tags: description: Create and manage your SMB users' companies. - name: Connections description: Create new and manage existing data connections for a company. - - name: Company info - description: View the company information of your customers' linked accounting software. - - name: Manage data - description: Control and monitor the retrieval of data from an integration. - - name: Mapping options - description: 'Get accounts, trackingCategories and taxRates that can be used in your create and update requests.' - - name: Accounts - description: Create accounts and view create account options. - - name: Bank accounts - description: Create bank accounts and view create bank account options. - - name: Customers - description: 'Get, create, and update customers.' + - name: Company information + description: View company profile from the source platform. + - name: Bills + description: 'Get, create, and update Bills.' + - name: Bill payments + description: 'Get, create, and update Bill payments.' - name: Suppliers - description: 'Get, create, and update suppliers.' - - name: Push operations - description: View historic push operations. - - name: Configuration - description: View and manage mapping configuration and defaults for expense transactions. - - name: Expenses - description: Create and update transactions that represent your customers' spend. - - name: Reimbursements - description: Create and update transactions that represent your customers' repayable spend. - - name: Transfers - description: Create and update transactions that represent the movement of your customers' money. - - name: Adjustments - description: Create transactions that represent your adjustments to your customers' spend. - - name: Attachments - description: Attach receipts to a transaction for a complete audit trail. - - name: Sync - description: Monitor the status of data syncs. - - name: Transaction status - description: Monitor the status of individual transactions in data syncs. -servers: - - url: 'https://api.codat.io' + description: 'Get, create, and update Suppliers.' + - name: Bank accounts + description: Create a bank account for a given company's connection. paths: /companies: get: @@ -163,6 +110,11 @@ paths: sourceType: Accounting created: '2022-01-01T11:30:00Z' createdByUserName: Mike Smith + products: + - spend-insights + - lending + - expenses-v1 + - commerce referenceSubsidiaryCompanies: [] pageNumber: 1 pageSize: 100 @@ -194,6 +146,10 @@ paths: sourceType: Accounting created: '2022-01-01T11:30:00Z' createdByUserName: Joe Bloggs + products: + - spend-insights + - lending + - payables-v2 referenceSubsidiaryCompanies: [] - id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 name: Toft stores @@ -201,6 +157,8 @@ paths: dataConnections: [] created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar + products: + - spend-insights referenceSubsidiaryCompanies: - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d name: Toft stores UK @@ -226,6 +184,10 @@ paths: sourceType: Accounting created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar + products: + - lending + - spend-insights + - payables referenceParentCompany: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 name: Toft stores @@ -248,6 +210,8 @@ paths: sourceType: Accounting created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar + products: + - spend-insights referenceParentCompany: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 name: Toft stores @@ -279,12 +243,18 @@ paths: '503': $ref: '#/components/responses/Service-Unavailable' operationId: list-companies - description: "\uFEFF\x54\x68\x65\x20\x2A\x4C\x69\x73\x74\x20\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x61\x73\x73\x6F\x63\x69\x61\x74\x65\x64\x20\x74\x6F\x20\x79\x6F\x75\x72\x20\x69\x6E\x73\x74\x61\x6E\x63\x65\x73\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E" + description: "\uFEFF\x54\x68\x65\x20\x2A\x4C\x69\x73\x74\x20\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x61\x73\x73\x6F\x63\x69\x61\x74\x65\x64\x20\x74\x6F\x20\x79\x6F\x75\x72\x20\x69\x6E\x73\x74\x61\x6E\x63\x65\x73\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n\n\x23\x23\x20\x46\x69\x6C\x74\x65\x72\x20\x62\x79\x20\x74\x61\x67\x73\n\n\x54\x68\x65\x20\x2A\x4C\x69\x73\x74\x20\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x73\x75\x70\x70\x6F\x72\x74\x73\x20\x74\x68\x65\x20\x66\x69\x6C\x74\x65\x72\x69\x6E\x67\x20\x6F\x66\x20\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x20\x75\x73\x69\x6E\x67\x20\x5B\x74\x61\x67\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x75\x73\x69\x6E\x67\x2D\x74\x68\x65\x2D\x61\x70\x69\x2F\x6D\x61\x6E\x61\x67\x69\x6E\x67\x2D\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x23\x61\x64\x64\x2D\x6D\x65\x74\x61\x64\x61\x74\x61\x2D\x74\x6F\x2D\x61\x2D\x63\x6F\x6D\x70\x61\x6E\x79\x29\x2E\x20\x49\x74\x20\x73\x75\x70\x70\x6F\x72\x74\x73\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x6F\x70\x65\x72\x61\x74\x6F\x72\x73\x20\x77\x69\x74\x68\x20\x5B\x43\x6F\x64\x61\x74\u2019\x73\x20\x71\x75\x65\x72\x79\x20\x6C\x61\x6E\x67\x75\x61\x67\x65\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x75\x73\x69\x6E\x67\x2D\x74\x68\x65\x2D\x61\x70\x69\x2F\x71\x75\x65\x72\x79\x69\x6E\x67\x29\x3A\n\n\x2D\x20\x65\x71\x75\x61\x6C\x73\x20\x28\x60\x3D\x60\x29\n\x2D\x20\x6E\x6F\x74\x20\x65\x71\x75\x61\x6C\x73\x20\x28\x60\x21\x3D\x60\x29\n\x2D\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x28\x60\x7E\x60\x29\n\n\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x75\x73\x65\x20\x74\x68\x65\x20\x71\x75\x65\x72\x79\x69\x6E\x67\x20\x74\x6F\x20\x66\x69\x6C\x74\x65\x72\x20\x63\x6F\x6D\x70\x61\x6E\x69\x65\x73\x20\x74\x61\x67\x67\x65\x64\x20\x77\x69\x74\x68\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x66\x6F\x72\x65\x69\x67\x6E\x20\x6B\x65\x79\x2C\x20\x72\x65\x67\x69\x6F\x6E\x2C\x20\x6F\x72\x20\x6F\x77\x6E\x69\x6E\x67\x20\x74\x65\x61\x6D\x3A\x20\n\x2D\x20\x46\x6F\x72\x65\x69\x67\x6E\x20\x6B\x65\x79\x3A\x20\x60\x75\x69\x64\x20\x3D\x20\x7B\x79\x6F\x75\x72\x43\x75\x73\x74\x6F\x6D\x65\x72\x49\x64\x7D\x60\n\x2D\x20\x52\x65\x67\x69\x6F\x6E\x3A\x20\x60\x72\x65\x67\x69\x6F\x6E\x20\x21\x3D\x20\x75\x6B\x60\n\x2D\x20\x4F\x77\x6E\x69\x6E\x67\x20\x74\x65\x61\x6D\x20\x61\x6E\x64\x20\x72\x65\x67\x69\x6F\x6E\x3A\x20\x60\x72\x65\x67\x69\x6F\x6E\x20\x3D\x20\x75\x6B\x20\x26\x26\x20\x6F\x77\x6E\x69\x6E\x67\x54\x65\x61\x6D\x20\x3D\x20\x69\x6E\x76\x6F\x69\x63\x65\x2D\x66\x69\x6E\x61\x6E\x63\x65\x60" parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/query' - $ref: '#/components/parameters/orderBy' + - name: tags + in: query + schema: + type: string + example: region=uk && team=invoice-finance + description: 'Filter companies by tags using the "equals" (=), "not equals" (!=), and "contains" (~) operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying).' post: summary: Create company tags: @@ -309,6 +279,8 @@ paths: dataConnections: [] created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar + products: + - spend-insights referenceSubsidiaryCompanies: [] With a description: value: @@ -320,6 +292,8 @@ paths: dataConnections: [] created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar + products: + - spend-insights referenceSubsidiaryCompanies: [] With a tag: value: @@ -331,6 +305,8 @@ paths: dataConnections: [] created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar + products: + - spend-insights tags: region: us referenceSubsidiaryCompanies: [] @@ -348,7 +324,7 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x43\x72\x65\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x63\x72\x65\x61\x74\x65\x20\x61\x20\x6E\x65\x77\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x74\x68\x61\x74\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x79\x6F\x75\x72\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x69\x6E\x20\x43\x6F\x64\x61\x74\x2E\x20\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n\n\x49\x66\x20\x66\x6F\x72\x62\x69\x64\x64\x65\x6E\x20\x63\x68\x61\x72\x61\x63\x74\x65\x72\x73\x20\x28\x73\x65\x65\x20\x60\x6E\x61\x6D\x65\x60\x20\x70\x61\x74\x74\x65\x72\x6E\x29\x20\x61\x72\x65\x20\x70\x72\x65\x73\x65\x6E\x74\x20\x69\x6E\x20\x74\x68\x65\x20\x72\x65\x71\x75\x65\x73\x74\x2C\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x77\x69\x6C\x6C\x20\x62\x65\x20\x63\x72\x65\x61\x74\x65\x64\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x72\x62\x69\x64\x64\x65\x6E\x20\x63\x68\x61\x72\x61\x63\x74\x65\x72\x73\x20\x72\x65\x6D\x6F\x76\x65\x64\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x60\x43\x6F\x6D\x70\x61\x6E\x79\x20\x28\x43\x6F\x64\x61\x74\x5B\x31\x5D\x29\x60\x20\x77\x69\x74\x68\x20\x62\x65\x20\x63\x72\x65\x61\x74\x65\x64\x20\x61\x73\x20\x60\x43\x6F\x6D\x70\x61\x6E\x79\x20\x43\x6F\x64\x61\x74\x31\x60\x2E" + description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x43\x72\x65\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x63\x72\x65\x61\x74\x65\x20\x61\x20\x6E\x65\x77\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x74\x68\x61\x74\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x79\x6F\x75\x72\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x69\x6E\x20\x43\x6F\x64\x61\x74\x2E\x20\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n\n\x49\x66\x20\x66\x6F\x72\x62\x69\x64\x64\x65\x6E\x20\x63\x68\x61\x72\x61\x63\x74\x65\x72\x73\x20\x28\x73\x65\x65\x20\x60\x6E\x61\x6D\x65\x60\x20\x70\x61\x74\x74\x65\x72\x6E\x29\x20\x61\x72\x65\x20\x70\x72\x65\x73\x65\x6E\x74\x20\x69\x6E\x20\x74\x68\x65\x20\x72\x65\x71\x75\x65\x73\x74\x2C\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x77\x69\x6C\x6C\x20\x62\x65\x20\x63\x72\x65\x61\x74\x65\x64\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x72\x62\x69\x64\x64\x65\x6E\x20\x63\x68\x61\x72\x61\x63\x74\x65\x72\x73\x20\x72\x65\x6D\x6F\x76\x65\x64\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x60\x43\x6F\x6D\x70\x61\x6E\x79\x20\x28\x43\x6F\x64\x61\x74\x5B\x31\x5D\x29\x60\x20\x77\x69\x74\x68\x20\x62\x65\x20\x63\x72\x65\x61\x74\x65\x64\x20\x61\x73\x20\x60\x43\x6F\x6D\x70\x61\x6E\x79\x20\x43\x6F\x64\x61\x74\x31\x60\x2E" requestBody: content: application/json: @@ -364,9 +340,10 @@ paths: description: 'Technology services, including web and app design and development' '/companies/{companyId}': put: - summary: Update company - description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x55\x70\x64\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x75\x70\x64\x61\x74\x65\x20\x62\x6F\x74\x68\x20\x74\x68\x65\x20\x6E\x61\x6D\x65\x20\x61\x6E\x64\x20\x64\x65\x73\x63\x72\x69\x70\x74\x69\x6F\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E" - operationId: update-company + summary: Replace company + description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x52\x65\x70\x6C\x61\x63\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x72\x65\x70\x6C\x61\x63\x65\x20\x74\x68\x65\x20\x65\x78\x69\x73\x74\x69\x6E\x67\x20\x6E\x61\x6D\x65\x2C\x20\x64\x65\x73\x63\x72\x69\x70\x74\x69\x6F\x6E\x2C\x20\x61\x6E\x64\x20\x74\x61\x67\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\x43\x61\x6C\x6C\x69\x6E\x67\x20\x74\x68\x65\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x77\x69\x6C\x6C\x20\x72\x65\x70\x6C\x61\x63\x65\x20\x65\x78\x69\x73\x74\x69\x6E\x67\x20\x76\x61\x6C\x75\x65\x73\x20\x65\x76\x65\x6E\x20\x69\x66\x20\x6E\x65\x77\x20\x76\x61\x6C\x75\x65\x73\x20\x68\x61\x76\x65\x6E\x27\x74\x20\x62\x65\x65\x6E\x20\x64\x65\x66\x69\x6E\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6C\x6F\x61\x64\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E" + operationId: replace-company + x-speakeasy-name-override: replace parameters: - $ref: '#/components/parameters/companyId' tags: @@ -405,12 +382,54 @@ paths: value: name: Same name description: Additional documents required + patch: + summary: Update company + description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x55\x70\x64\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x75\x70\x64\x61\x74\x65\x20\x74\x68\x65\x20\x6E\x61\x6D\x65\x2C\x20\x64\x65\x73\x63\x72\x69\x70\x74\x69\x6F\x6E\x2C\x20\x6F\x72\x20\x74\x61\x67\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\n\n\x54\x68\x65\x20\x2A\x55\x70\x64\x61\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x64\x6F\x65\x73\x6E\x27\x74\x20\x68\x61\x76\x65\x20\x61\x6E\x79\x20\x72\x65\x71\x75\x69\x72\x65\x64\x20\x66\x69\x65\x6C\x64\x73\x2E\x20\x49\x66\x20\x61\x6E\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x66\x69\x65\x6C\x64\x73\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x20\x61\x72\x65\x20\x60\x6E\x75\x6C\x6C\x60\x20\x6F\x72\x20\x6E\x6F\x74\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x2C\x20\x74\x68\x65\x79\x20\x77\x6F\x6E\x27\x74\x20\x62\x65\x20\x69\x6E\x63\x6C\x75\x64\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x75\x70\x64\x61\x74\x65\x2E\x20\x20\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E" + 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/CompanyUpdateRequest' + examples: + Update tags: + value: + tags: + refrence: new reference + Update name: + value: + name: New Name delete: summary: Delete a company operationId: delete-company parameters: - $ref: '#/components/parameters/companyId' - description: "\uFEFF\x54\x68\x65\x20\x2A\x44\x65\x6C\x65\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x70\x65\x72\x6D\x61\x6E\x65\x6E\x74\x6C\x79\x20\x64\x65\x6C\x65\x74\x65\x73\x20\x61\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x2C\x20\x69\x74\x73\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x61\x6E\x64\x20\x61\x6E\x79\x20\x63\x61\x63\x68\x65\x64\x20\x64\x61\x74\x61\x2E\x20\x54\x68\x69\x73\x20\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x20\x69\x73\x20\x69\x72\x72\x65\x76\x65\x72\x73\x69\x62\x6C\x65\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n" + description: "\uFEFF\x54\x68\x65\x20\x2A\x44\x65\x6C\x65\x74\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x70\x65\x72\x6D\x61\x6E\x65\x6E\x74\x6C\x79\x20\x64\x65\x6C\x65\x74\x65\x73\x20\x61\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x2C\x20\x69\x74\x73\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x61\x6E\x64\x20\x61\x6E\x79\x20\x63\x61\x63\x68\x65\x64\x20\x64\x61\x74\x61\x2E\x20\x54\x68\x69\x73\x20\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x20\x69\x73\x20\x69\x72\x72\x65\x76\x65\x72\x73\x69\x62\x6C\x65\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n" tags: - Companies responses: @@ -433,7 +452,7 @@ paths: get: summary: Get company operationId: get-company - description: "\uFEFF\x54\x68\x65\x20\x2A\x47\x65\x74\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x66\x6F\x72\x20\x61\x20\x67\x69\x76\x65\x6E\x20\x60\x63\x6F\x6D\x70\x61\x6E\x79\x49\x64\x60\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n" + description: "\uFEFF\x54\x68\x65\x20\x2A\x47\x65\x74\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x66\x6F\x72\x20\x61\x20\x67\x69\x76\x65\x6E\x20\x60\x63\x6F\x6D\x70\x61\x6E\x79\x49\x64\x60\x2E\n\n\x41\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\n\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x58\x65\x72\x6F\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x50\x6C\x61\x69\x64\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5A\x65\x74\x74\x6C\x65\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n" parameters: - $ref: '#/components/parameters/companyId' tags: @@ -456,6 +475,11 @@ paths: dataConnections: [] created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar + products: + - spend-insights + - lending + - expenses-v1 + - commerce referenceSubsidiaryCompanies: [] Parent multi-entity company: value: @@ -467,6 +491,11 @@ paths: dataConnections: [] created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar + products: + - spend-insights + - lending + - expenses-v1 + - commerce referenceSubsidiaryCompanies: - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d name: Toft stores UK @@ -496,6 +525,11 @@ paths: sourceType: Accounting created: '2022-11-10T10:45:18Z' createdByUserName: Dan Tzabar + products: + - spend-insights + - lending + - expenses-v1 + - commerce referenceParentCompany: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 name: Toft stores @@ -752,24 +786,30 @@ paths: value: status: Unlinked description: '' - '/companies/{companyId}/sync/expenses/connections/partnerExpense': - post: + '/companies/{companyId}/connections/{connectionId}/payables/info': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get company information + description: |+ + Use the *Get company information* endpoint to return information about the company available from the underlying accounting software. + + operationId: get-company-information tags: - - Connections - description: Creates a partner expense data connection - summary: Create partner expense connection - operationId: create-partner-expense-connection - x-speakeasy-name-override: create-partner-expense-connection - parameters: - - $ref: '#/components/parameters/companyId' + - Company information responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/Connection' - examples: {} + $ref: '#/components/schemas/CompanyInformation' + examples: + Company information: + value: + companyName: Bank of Dave + baseCurrency: GBP '400': $ref: '#/components/responses/BadRequest' '401': @@ -786,60 +826,50 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/data/info': + '/companies/{companyId}/connections/{connectionId}/payables/mappingOptions/bills': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' get: + summary: Get bill mapping options + description: "\uFEFF\x55\x73\x65\x20\x74\x68\x65\x20\x2A\x47\x65\x74\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x6F\x70\x74\x69\x6F\x6E\x73\x20\x2D\x20\x42\x69\x6C\x6C\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x72\x65\x74\x75\x72\x6E\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x76\x61\x69\x6C\x61\x62\x6C\x65\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x6F\x70\x74\x69\x6F\x6E\x73\x20\x66\x6F\x72\x20\x61\x20\x67\x69\x76\x65\x6E\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x49\x44\x2E\n\n\x42\x79\x20\x64\x65\x66\x61\x75\x6C\x74\x2C\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x63\x74\x69\x76\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x74\x61\x78\x20\x72\x61\x74\x65\x73\x2E\x20\x59\x6F\x75\x20\x63\x61\x6E\x20\x75\x73\x65\x20\x5B\x71\x75\x65\x72\x79\x69\x6E\x67\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x75\x73\x69\x6E\x67\x2D\x74\x68\x65\x2D\x61\x70\x69\x2F\x71\x75\x65\x72\x79\x69\x6E\x67\x29\x20\x74\x6F\x20\x63\x68\x61\x6E\x67\x65\x20\x74\x68\x61\x74\x2E\n\n\x4D\x61\x70\x70\x69\x6E\x67\x20\x6F\x70\x74\x69\x6F\x6E\x73\x20\x61\x72\x65\x20\x61\x20\x73\x65\x74\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x74\x61\x78\x20\x72\x61\x74\x65\x73\x20\x75\x73\x65\x64\x20\x74\x6F\x20\x63\x6F\x6E\x66\x69\x67\x75\x72\x65\x20\x74\x68\x65\x20\x53\x4D\x42\x27\x73\x20\x70\x61\x79\x61\x62\x6C\x65\x73\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x2E" + operationId: get-mapping-options-bills + x-speakeasy-name-override: get-bill-options tags: - - Company info - summary: Get company info - description: Gets the latest basic info for a company. - operationId: get-company-info + - Bills parameters: - - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/continuationToken' + - $ref: '#/components/parameters/statusQuery' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/CompanyInformation' + $ref: '#/components/schemas/BillMappingOptions' examples: - Example 1: + Mapping options: 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' + accounts: + - id: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + nominalCode: 879-i + name: Accounts payable + type: Liability + currency: GBP + status: Active + sourceModifiedDate: '2022-10-23T00:00:00.000Z' + taxRates: + - id: d2939064-dd3a-4c0f-9865-a238c2193515 + name: VAT @ 20% + code: VAT20 + effectiveTaxRate: 20 + totalTaxRate: 20 + status: Active + sourceModifiedDate: '2022-10-23T00:00:00.000Z' + pagination: + continuationToken: eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ== + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -848,28 +878,50 @@ paths: $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}/sync/expenses/config': + '/companies/{companyId}/connections/{connectionId}/payables/mappingOptions/payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' get: + summary: Get payment mapping options + description: "Use the *Get mapping options - Payments* endpoint to return a list of available mapping options for a given company's connection ID.\r\n\r\nBy default, this endpoint returns a list of active bank accounts. You can use [querying](https://docs.codat.io/using-the-api/querying) to change that.\r\n\r\nMapping options are a set of bank accounts used to configure the SMB's payables integration." + operationId: get-mapping-options-payments + x-speakeasy-name-override: get-payment-options tags: - - Configuration + - Bill payments parameters: - - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/continuationToken' + - $ref: '#/components/parameters/statusQuery' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/CompanyConfiguration' - examples: {} + $ref: '#/components/schemas/PaymentMappingOptions' + examples: + Mapping options: + value: + bankAccounts: + - id: 3d5a8e00-d108-4045-8823-7f342676cffa + name: Bank of Dave current account + accountNumber: '12345678' + currency: GBP + nominalCode: '1234567' + sortCode: '123456' + status: Active + accountType: Debit + sourceModifiedDate: '2022-10-23T00:00:00.000Z' + pagination: + continuationToken: eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ== + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -884,29 +936,101 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - summary: Get company configuration - description: Gets a company's expense sync configuration - operationId: get-company-configuration - post: + '/companies/{companyId}/connections/{connectionId}/payables/bills': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List bills + 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. + + [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. + + By default, the endpoint will return all bills with a status of 'Open' & 'PartiallyPaid' to show all oustanding bills. + operationId: list-bills tags: - - Configuration + - Bills parameters: - - $ref: '#/components/parameters/companyId' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyConfiguration' - examples: {} + - $ref: '#/components/parameters/continuationToken' + - name: query + in: query + required: false + schema: + type: string + examples: + Status (open): + value: status=Open + Status (partially paid): + value: status=PartiallyPaid + Source modified date: + value: 'sourceModifiedDate>2023-12-15T00:00:00.000Z' + Status (open) & source modified date: + value: 'sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Open' + Status (partially paid) & source modified date: + value: 'sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=PartiallyPaid' + description: 'Codat query string allows you to filter by `status` and `sourceModifiedDate`. Learn more about Codat''s query string [here](https://docs.codat.io/using-the-api/querying). Platfrom specfic statuses: Xero supports Open | PartiallyPaid | Paid | Void | Draft. Qbo supports Open | PartiallyPaid | Paid. FreeAgent supports Open | PartiallyPaid | Paid.' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/CompanyConfiguration' + $ref: '#/components/schemas/Bill/definitions/bills' + examples: + Bills: + value: + results: + - id: '18' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: '1,' + lineItems: + - description: Dance shoes + unitAmount: 5 + quantity: 1 + taxAmount: 0 + accountRef: + id: '16' + taxRateRef: + id: NON + totalAmount: 5 + status: Open + totalAmount: 5 + amountDue: 0 + sourceModifiedDate: '2022-05-26T10:34:10Z' + - id: '22' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Dance shoes + unitAmount: 5 + quantity: 1 + taxAmount: 0 + accountRef: + id: '16' + taxRateRef: + id: NON + totalAmount: 5 + status: Paid + totalAmount: 5 + amountDue: 0 + sourceModifiedDate: '2022-05-26T10:34:10Z' + pagination: + continuationToken: eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ== '400': - $ref: '#/components/responses/BadRequest' + $ref: '#/components/responses/Malformed-Query' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -915,32 +1039,131 @@ paths: $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: Set company configuration - description: Sets a company's expense sync configuration - operationId: set-company-configuration - x-speakeasy-name-override: set - parameters: - - $ref: '#/components/parameters/companyId' - '/companies/{companyId}/sync/expenses/mappingOptions': - get: + post: + summary: Create bill + 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. + operationId: create-bill tags: - - Mapping options + - Bills parameters: - - $ref: '#/components/parameters/companyId' + - in: header + name: Idempotency-Key + description: A unique identifier to ensure idempotent behaviour for subsequent requests. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Bill/definitions/billPrototype' + examples: + Create bill: + value: + reference: bill_b8qmmj4ksf1suax + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + 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 + taxAmount: 360 + totalAmount: 2160 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + taxRateRef: + id: INPUT2 + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + taxAmount: 800 + totalAmount: 4800 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + taxRateRef: + id: INPUT2 + - description: Stationery charges + unitAmount: 32 + quantity: 8 + taxAmount: 51.2 + totalAmount: 307.2 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + taxRateRef: + id: INPUT2 + trackingRefs: + - id: dba3d4da-f9ed-4eee-8e0b-452d11fdb1fa + dataType: trackingCategories + status: Open responses: - '200': - description: Success + '201': + description: Created content: application/json: schema: - $ref: '#/components/schemas/MappingOptions' - examples: {} + $ref: '#/components/schemas/Bill' + examples: + Created bill: + value: + id: bill-1029932 + reference: bill_b8qmmj4ksf1suax + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + issueDate: '2023-04-23T00:00:00' + dueDate: '2023-04-23T00:00:00' + currency: GBP + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + taxAmount: 360 + totalAmount: 2160 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + taxRateRef: + id: INPUT2 + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + taxAmount: 800 + totalAmount: 4800 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + taxRateRef: + id: INPUT2 + - description: Stationery charges + unitAmount: 32 + quantity: 8 + taxAmount: 51.2 + totalAmount: 307.2 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + taxRateRef: + id: INPUT2 + trackingRefs: + - id: dba3d4da-f9ed-4eee-8e0b-452d11fdb1fa + dataType: trackingCategories + status: Open + totalAmount: 7267.2 + amountDue: 7267.2 + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -949,32 +1172,128 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Idempotency-Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - description: 'Gets the mapping options (accounts, trackingCategories and taxRates) for a company''s accounting software' - summary: Mapping options - operationId: get-mapping-options - x-speakeasy-name-override: get-mapping-options + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}': parameters: - $ref: '#/components/parameters/companyId' - '/companies/{companyId}/sync/expenses/syncs/lastSuccessful/status': - get: + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/billId' + put: + summary: Update bill + 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. + + ### Supported Integrations + + | Integration | Supported | + |-------------------------------|-----------| + | FreeAgent | Yes | + | QuickBooks Online | Yes | + | Xero | Yes | + | Oracle NetSuite | No | + | Sage Intacct | No | + | Zoho Books | No | + operationId: update-bill tags: - - Sync + - Bills parameters: - - $ref: '#/components/parameters/companyId' + - in: header + name: Idempotency-Key + description: A unique identifier to ensure idempotent behaviour for subsequent requests. + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Bill/definitions/billPrototype' + examples: + Update bill: + value: + reference: bill_updated_ref + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + issueDate: '2023-04-23T00:00:00' + dueDate: '2023-05-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Updated line item - Microsoft Office training + unitAmount: 2000 + quantity: 1 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + taxRateRef: + id: INPUT2 + - description: Desktop/network support via email & phone - updated rate + unitAmount: 4500 + quantity: 1 + taxAmount: 900 + totalAmount: 5400 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + taxRateRef: + id: INPUT2 + trackingRefs: + - id: dba3d4da-f9ed-4eee-8e0b-452d11fdb1fa + dataType: trackingCategories + status: Open responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/CompanySyncStatus' - examples: {} + $ref: '#/components/schemas/Bill' + examples: + Updated bill: + value: + id: bill-1029932 + reference: bill_updated_ref + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + issueDate: '2023-04-23T00:00:00' + dueDate: '2023-05-23T00:00:00' + currency: GBP + lineItems: + - description: Updated line item - Microsoft Office training + unitAmount: 2000 + quantity: 1 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + taxRateRef: + id: INPUT2 + - description: Desktop/network support via email & phone - updated rate + unitAmount: 4500 + quantity: 1 + taxAmount: 900 + totalAmount: 5400 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + taxRateRef: + id: INPUT2 + trackingRefs: + - id: dba3d4da-f9ed-4eee-8e0b-452d11fdb1fa + dataType: trackingCategories + status: Open + totalAmount: 7800 + amountDue: 7800 + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -983,32 +1302,49 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Idempotency-Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - description: Gets the status of the last successful sync - summary: Last successful sync - operationId: get-last-successful-sync - x-speakeasy-name-override: get-last-successful-sync + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/attachments': parameters: - $ref: '#/components/parameters/companyId' - '/companies/{companyId}/sync/expenses/syncs/latest/status': - get: + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/billId' + post: + summary: Upload bill attachment + description: "The *Upload bill attachment* endpoint uploads an attachment and assigns it against a specific `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." + operationId: upload-bill-attachment tags: - - Sync - parameters: - - $ref: '#/components/parameters/companyId' + - Bills + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/AttachmentUpload' responses: - '200': - description: Success + '201': + description: Created content: application/json: schema: - $ref: '#/components/schemas/CompanySyncStatus' - examples: {} + $ref: '#/components/schemas/Attachment' + examples: + Attachment metadata: + value: + id: 422f093f-e556-4bf3-91c0-93af70c3e850 + name: receipt.png + contentType: image/png + dateCreated: '2022-10-23T00:00:00.000Z' + fileSize: 100 + includeWhenSent: true + sourceModifiedDate: '2022-05-26T10:34:10Z' + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1023,28 +1359,36 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - description: Gets the latest sync status - summary: Latest sync status - operationId: get-latest-sync - x-speakeasy-name-override: get-latest-sync - parameters: - - $ref: '#/components/parameters/companyId' - '/companies/{companyId}/sync/expenses/syncs/list/status': - parameters: - - $ref: '#/components/parameters/companyId' get: + 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." + operationId: list-bill-attachments tags: - - Sync + - Bills responses: '200': description: Success content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/CompanySyncStatus' - examples: {} + $ref: '#/components/schemas/Attachment/definitions/attachments' + examples: + Success: + value: + - id: 422f093f-e556-4bf3-91c0-93af70c3e850 + name: receipt.png + contentType: image/png + dateCreated: '2022-10-23T00:00:00.000Z' + fileSize: 100 + includeWhenSent: true + sourceModifiedDate: '2022-05-26T10:34:10Z' + - id: 20cfd269-2f0f-44ef-a28c-7b5f725cf1aa + name: another_receipt.png + contentType: image/png + dateCreated: '2022-10-24T00:00:00.000Z' + fileSize: 98 + includeWhenSent: true + sourceModifiedDate: '2022-05-27T12:38:10Z' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1053,30 +1397,40 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - summary: List sync statuses - description: Gets a list of sync statuses - operationId: list-syncs - '/companies/{companyId}/sync/expenses/syncs/{syncId}/status': + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/billId' + - $ref: '#/components/parameters/attachmentId' get: + 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 tags: - - Sync - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' + - Bills responses: '200': description: Success content: - application/json: + application/octet-stream: schema: - $ref: '#/components/schemas/CompanySyncStatus' - examples: {} + title: Data + type: string + format: binary '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1091,29 +1445,58 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - summary: Get sync status - description: Get the sync status for a specified sync - operationId: get-sync-by-id + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/payment': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' - '/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions': - get: - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/billId' + - in: header + name: Idempotency-Key + description: A unique identifier to ensure idempotent behaviour for subsequent requests. + schema: + type: string + post: + summary: Create bill payment + 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 Accounts Payable account. + operationId: create-bill-payment + tags: + - Bill payments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BillPayment/definitions/billPaymentPrototype' + examples: + Bill payment example: + value: + amount: 22 + currencyRate: 1 + date: '2022-10-23T00:00:00.000Z' + accountRef: + id: 7bda9f44sr56 + reference: Bill Payment against bill c13e37b6 dfaa-4894-b3be-9fe97bda9f44 responses: - '200': - description: Success + '201': + description: Created content: application/json: schema: - $ref: '#/components/schemas/Transactions' - examples: {} + $ref: '#/components/schemas/BillPayment' + examples: + Bill payment: + value: + id: billPayment-1029932 + amount: 22 + currencyRate: 1 + date: '2022-10-23T00:00:00.000Z' + accountRef: + id: 7bda9f44sr56 + reference: Bill Payment against bill c13e37b6 dfaa-4894-b3be-9fe97bda9f44 '400': - $ref: '#/components/responses/Malformed-Query' + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1122,80 +1505,86 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Idempotency-Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - tags: - - Transaction status - summary: List sync transactions - description: Gets the transactions and status for a sync - operationId: list-sync-transactions + '/companies/{companyId}/connections/{connectionId}/payables/suppliers': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' - '/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}': + - $ref: '#/components/parameters/connectionId' get: + tags: + - Suppliers + summary: List suppliers + 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.\n\n[Suppliers](https://docs.codat.io/sync-for-payables-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nBy default, this endpoint returns a list of active and archived suppliers. You can use [querying](https://docs.codat.io/using-the-api/querying) to change that. \n\nFor example, to retrieve only active suppliers (i.e. `status=Active`) or suppliers created within the specified number of days (e.g. `sourceModifiedDate>2023-12-15T00:00:00.000Z`), query the endpoint as follows: `/payables/suppliers?query=sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Active`.For example, to retrieve active suppliers modified after a particular date use `query=sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Active`." + operationId: list-suppliers parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' - - $ref: '#/components/parameters/transactionId' + - $ref: '#/components/parameters/continuationToken' + - name: query + in: query + required: false + schema: + type: string + examples: + Source modified date: + value: 'sourceModifiedDate>2023-12-15T00:00:00.000Z' + Status (active): + value: status=Active + Status (archived): + value: status=Archived + Status (active) & source modified date: + value: 'sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Active' + Status (archived) & source modified date: + value: 'sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Archived' + description: 'Codat query string allows you to filter by `sourceModifiedDate` or if a supplier is `Active` or `Archived` in the accounting software. Learn more about Codat''s query string [here](https://docs.codat.io/using-the-api/querying).' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/TransactionResponse' - 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' - tags: - - Transaction status - summary: Get sync transaction - description: Gets the status of a transaction for a sync - operationId: get-sync-transaction - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' - - $ref: '#/components/parameters/transactionId' - '/companies/{companyId}/sync/expenses/expense-transactions': - parameters: - - $ref: '#/components/parameters/companyId' - post: - summary: Create expense transaction - operationId: create-expense-transaction - description: "The *Create expense* endpoint creates an [expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) in the accounting software for a given company's connection. \n\n[Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. \n\n### Supported Integrations\n\n| Integration | Supported |\n|-------------------------------|-----------|\n| Dynamics 365 Business Central | Yes |\n| FreeAgent | Yes |\n| QuickBooks Desktop | Yes |\n| QuickBooks Online | Yes |\n| Oracle NetSuite | Yes |\n| Xero | Yes |" - tags: - - Expenses - responses: - '200': - description: OK - content: - application/json: - x-speakeasy-usage-example: true - schema: - $ref: '#/components/schemas/CreateExpenseResponse' + $ref: '#/components/schemas/Supplier/definitions/suppliers' examples: - Example 1: + Suppliers: value: - syncId: cd937d46-8e41-43a9-9477-a79158ffd98a + results: + - id: c523e12f-8b74-4d3a-bbd8-32d7a2f598b4 + supplierName: City Limousines + contactName: Martin Dale + emailAddress: martyd@citylim.co + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + line2: Bakersfield Industrial Estate + city: Bakersfield + region: California + country: USA + postalcode: '93308' + status: Active + balance: 100 + defaultCurrency: GBP + sourceModifiedDate: '2022-10-23T00:00:00Z' + - id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + defaultCurrency: GBP + sourceModifiedDate: '2022-12-07T10:48:18Z' + pagination: + continuationToken: eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ== '400': - $ref: '#/components/responses/BadRequest' + $ref: '#/components/responses/Malformed-Query' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1204,156 +1593,73 @@ paths: $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' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateExpenseRequest' - examples: - Payment: - value: - - id: 4d7c6929-7770-412b-91bb-44d3bc71d111 - type: Payment - issueDate: '2024-05-21T00:00:00+00:00' - currency: GBP - currencyRate: 1 - contactRef: - id: '430' - type: Supplier - bankAccountRef: - id: '97' - merchantName: Amazon UK - notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 23_Bills - accountRef: - id: '35' - trackingRefs: - - id: DEPARTMENT_5 - dataType: trackingCategories - invoiceTo: - id: '504' - type: customer - Refund: - value: - - id: 7008d3f2-aeb4-11ed-afa1-0242ac120002 - type: Refund - issueDate: '2024-02-17T00:00:00+00:00' - currency: GBP - contactRef: - id: '430' - type: Supplier - bankAccountRef: - id: '97' - merchantName: Amazon UK - notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 23_Bills - accountRef: - id: '42' - trackingRefs: - - id: DEPARTMENT_6 - '/companies/{companyId}/sync/expenses/expense-transactions/{transactionId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/transactionId' - put: - summary: Update expense transactions + post: tags: - - Expenses - responses: - '202': - description: Accepted - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateExpenseResponse' - '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' - '422': - $ref: '#/components/responses/Unprocessable-Content' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - operationId: update-expense-transaction - description: "The *Update expense* endpoint updates an existing [expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) in the accounting software for a given company's connection. \n\n[Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateExpenseRequest) represent transactions made with a company debit or credit card. \n\n### Supported Integrations\nThe following integrations are supported for the [Payment](https://docs.codat.io/expenses/sync-process/expense-transactions#transaction-types) transaction `type` only: \n| Integration | Supported |\n|-----------------------|-----------|\n| FreeAgent | Yes |\n| QuickBooks Online | Yes |\n| Oracle NetSuite | Yes |\n| Xero | Yes |" + - Suppliers + 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.\r\n\r\n[Suppliers](https://docs.codat.io/sync-for-payables-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n" + operationId: create-supplier + parameters: + - in: header + name: Idempotency-Key + description: A unique identifier to ensure idempotent behaviour for subsequent requests. + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateExpenseRequest' + $ref: '#/components/schemas/Supplier/definitions/supplierPrototype' examples: - Payment: + Suppliers: value: - type: Payment - issueDate: '2024-05-21T00:00:00+00:00' - currency: GBP - currencyRate: 1 - contactRef: - id: '430' - type: Supplier - bankAccountRef: - id: '97' - merchantName: Amazon UK - notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 23_Bills - accountRef: - id: '35' - trackingRefs: - - id: DEPARTMENT_5 - dataType: trackingCategories - invoiceTo: - id: '504' - type: customer - '/companies/{companyId}/sync/expenses/transfer-transactions/{transactionId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/transactionId' - put: - summary: Create transfer transaction - operationId: create-transfer-transaction - description: "Use the *Create transfer* endpoint to create or update a [transfer transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/TransferTransactionRequest) in the accounting software for a given company's connection. \r\n\r\nTransfers record the movement of money between two bank accounts, or between a bank account and a nominal account. Use them to represent actions such as topping up a debit card account or a balance transfer to another credit card.\r\n\r\nThe `from.amount` and `to.amount` fields are in the native currency of the account.\r\n\r\n### Supported Integrations\r\n| Integration | Supported |\r\n|-----------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Desktop | Yes |\r\n| QuickBooks Online | Yes |\r\n| Xero | Yes |" - tags: - - Transfers + supplierName: Greggs + contactName: Greg Greggs + emailAddress: greg@greggs.com + phone: +44 (0)1223 322410 + addresses: + - type: Billing + line1: Flat 1 + line2: 2 Dennis Avenue + city: London + region: Camden + country: GBR + postalCode: EC1N 7TE + status: Active + defaultCurrency: GBP responses: - '200': - description: OK + '201': + description: Created content: application/json: - x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/TransferTransactionResponse' + $ref: '#/components/schemas/Supplier' examples: - Example 1: - value: - syncId: cd937d46-8e41-43a9-9477-a79158ffd98a + Suppliers: + value: + id: sup-10933920 + supplierName: Greggs + contactName: Greg Greggs + emailAddress: greg@greggs.com + phone: +44 (0)1223 322410 + address: + - type: Billing + line1: Flat 1 + line2: 2 Dennis Avenue + city: London + region: Camden + country: GBR + postalCode: EC1N 7TE + status: Active + defaultCurrency: GBP '400': $ref: '#/components/responses/BadRequest' '401': @@ -1370,113 +1676,45 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TransferTransactionRequest' - examples: - Create transfer: - value: - description: Sample transfer description - date: '2021-05-21T00:00:00+00:00' - from: - accountRef: - id: 787dfb37-5707-4dc0-8a86-8d74e4cc78ea - amount: 100 - to: - accountRef: - id: 777dfb37-5506-3dc0-6g86-8d34z4cc78ea - amount: 100 - '/companies/{companyId}/sync/expenses/adjustment-transactions': + '/companies/{companyId}/connections/{connectionId}/payables/bankAccounts': parameters: - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' post: - summary: Create adjustment transaction - operationId: create-adjustment-transaction - description: "Use the *Create adjustment expense* endpoint to create an [adjustment](https://docs.codat.io/sync-for-expenses-api#/schemas/AdjustmentTransactionRequest) in the accounting software for a given company's connection. \n\nAdjustments represent write-offs and transaction alterations, such as foreign exchange adjustments, in the form of a journal entry. \n\n### Supported Integrations\n\n| Integration | Supported |\n|-----------------------|-----------|\n| QuickBooks Desktop | Yes |" tags: - - Adjustments - responses: - '200': - description: OK - content: - application/json: - x-speakeasy-usage-example: true - schema: - $ref: '#/components/schemas/AdjustmentTransactionResponse' - examples: - Example 1: - value: - syncId: cd937d46-8e41-43a9-9477-a79158ffd98a - '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' + - Bank accounts + summary: Create bank account + parameters: + - in: header + name: Idempotency-Key + description: A unique identifier to ensure idempotent behaviour for subsequent requests. + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateAdjustmentRequest' + $ref: '#/components/schemas/BankAccount/definitions/bankAccountPrototype' examples: - Create adjustment: + Bank account example: value: - - id: 3357b3df-5f2e-465d-b9ba-226519dbb8f1 - date: '2024-05-21T00:00:00+00:00' - currency: USD - currencyRate: 1 - reference: test reference - lines: - - amount: 50 - accountRef: - id: 80000018-1671793811 - description: debit line - trackingRefs: - - id: 80000003-1674553958 - dataType: trackingCategories - invoiceTo: - id: 80000002-1674552702 - type: customer - - amount: -50 - accountRef: - id: 80000028-1671794219 - description: credit line - trackingRefs: - - id: 80000003-1674553958 - dataType: trackingCategories - '/companies/{companyId}/sync/expenses/reimbursable-expense-transactions': - parameters: - - $ref: '#/components/parameters/companyId' - post: - summary: Create reimbursable expense transaction - operationId: create-reimbursable-expense-transaction - description: "Use the *Create reimbursable expense* endpoint to submit an employee expense claim in the accounting platform for a given company's connection.\r\n\r\n[Reimbursable expense requests](https://docs.codat.io/sync-for-expenses-api#/schemas/ReimbursableExpenseTransactionRequest) are reflected in the accounting software in the form of **Bills** against an employee (who exists as a supplier in the accounting platform).\r\n\r\n### Supported Integrations\r\n| Integration | Supported |\r\n|-----------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Desktop | Yes |\r\n| QuickBooks Online | Yes |\r\n| Oracle NetSuite | Yes |" - tags: - - Reimbursements + id: fb623ab2-f6ff-4b22-b7d3-b7cc2a4aa0ea + nominalCode: '22' + name: Plutus - Payables - Bank Account 12 + accountNumber: 0120 0440 + sortCode: 50-50-50 + currency: GBP + accountType: Debit + status: Active + sourceModifiedDate: '2024-02-22T14:46:43.99Z' responses: - '200': - description: OK + '201': + description: Created content: application/json: - x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/CreateReimbursableExpenseResponse' - examples: - Example 1: - value: - syncId: cd937d46-8e41-43a9-9477-a79158ffd98a + $ref: '#/components/schemas/BankAccount' + examples: {} '400': $ref: '#/components/responses/BadRequest' '401': @@ -1493,9004 +1731,596 @@ paths: $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." + operationId: create-bank-account +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/ReimbursableExpenseTransactionRequest' + $ref: '#/components/schemas/ClientRateLimitWebhook' examples: - Create reimbursable expense: + Reached: value: - - id: 4d7c6929-7770-412b-91bb-44d3bc71d111 - reference: expenses w/c 01/07 - contactRef: - id: '752' - issueDate: '2024-05-21' - dueDate: '2024-05-21' - currency: GBP - currencyRate: 1 - notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - - description: Hotel - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 23_Bills - accountRef: - id: '35' - trackingRefs: - - id: DEPARTMENT_5 - dataType: trackingCategories - invoiceTo: - id: '504' - type: customer - '/companies/{companyId}/sync/expenses/reimbursable-expense-transactions/{transactionId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/transactionId' - put: - summary: Update reimbursable expense transaction - operationId: update-reimbursable-expense-transaction - description: "The *Update reimbursable expense* endpoint updates an existing employee expense claim in the accounting platform for a given company's connection. \r\n\r\nUpdating an existing [reimbursable expense transaction](https://docs.codat.io/sync-for-expenses-api#/schemas/UpdateReimbursableExpenseTransactionRequest) will update the existing **bill** against an employee (who exists as a supplier in the accounting software).\r\n\r\n### Supported Integrations\r\n| Integration | Supported |\r\n|-----------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Online | Yes |\r\n| Oracle NetSuite | Yes |" - tags: - - Reimbursements + 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: OK - content: - application/json: - schema: - $ref: '#/components/schemas/CreateReimbursableExpenseResponse' - examples: - Example 1: - value: - syncId: cd937d46-8e41-43a9-9477-a79158ffd98a - '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: 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/UpdateReimbursableExpenseTransactionRequest' + $ref: '#/components/schemas/ClientRateLimitWebhook' examples: - Update reimbursable expense: + Reset: value: - reference: expenses w/c 01/07 - contactRef: - id: '752' - issueDate: '2024-05-21' - dueDate: '2024-05-21' - currency: GBP - currencyRate: 1 - notes: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - - description: Hotel - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 23_Bills - accountRef: - id: '35' - trackingRefs: - - id: DEPARTMENT_5 - dataType: trackingCategories - invoiceTo: - id: '504' - type: customer - '/companies/{companyId}/sync/expenses/syncs/{syncId}/transactions/{transactionId}/attachments': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/syncId' - - $ref: '#/components/parameters/transactionId' - post: - summary: Upload attachment - operationId: upload-expense-attachment - x-speakeasy-name-override: upload - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Attachment' - 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' - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/AttachmentUpload' - tags: - - Attachments - description: "The *Upload attachment* endpoint uploads an attachment in the accounting software against the given transactionId. \n\n[Expense transactions](https://docs.codat.io/sync-for-expenses-api#/schemas/ExpenseTransaction) represent transactions made with a company debit or credit card. Attachments for `Adjustment` and `Transfer` transaction types are not supported for any integrations.\n\n**Integration-specific behaviour**\n\nEach accounting software supports different file formats and sizes.\n\n| Integration | File size | File extension |Supported transaction type\n|-------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------|\n| **Xero** | 3 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 | All supported types |\n| **QuickBooks Online** | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | `ReimbursableExpenses`, `ExpensePayment`, `ExpenseRefund` |\n| **NetSuite** | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |`ExpensePayment`, `ExpenseRefund` |\n| **Dynamics 365 Business Central** | 350 MB | [No explicit requirements outlined](https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice) for text, image, and video files. | All supported types\n| **QuickBooks Desktop** | NA | Does not support attachment upload | N/A |\n| **FreeAgent** | 5MB | PNG, X-PNG, JPEG, PJG, GIF, X-PDF " - '/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}/data/history/{datasetId}': - parameters: - - $ref: '#/components/parameters/companyId' - - 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. - 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': - 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}/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}/connections/{connectionId}/push/accounts': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - post: - tags: - - Accounts - summary: Create account - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - - $ref: '#/components/parameters/allowSyncOnPushComplete' - 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-expenses-api#/schemas/Account) for a given company's connection. - - [Accounts](https://docs.codat.io/sync-for-expenses-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-expenses-api#/operations/get-create-chartOfAccounts-model). - operationId: create-account - '/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - get: - summary: Get create account model - tags: - - Accounts - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/PushOption' - examples: - Exact (Netherlands): - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - validation: - warnings: [] - information: - - field: NominalCode - details: Must be provided. - name: - type: String - displayName: Name - description: Name of the account - required: true - validation: - warnings: [] - information: - - field: Name - details: Must be provided. - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: Asset.Assets.Cash - type: String - displayName: Asset.Assets.Cash - required: false - - value: Asset.Assets.Bank - type: String - displayName: Asset.Assets.Bank - required: false - - value: Asset.Assets.PaymentServices - type: String - displayName: Asset.Assets.PaymentServices - required: false - - value: Asset.Assets.AccountsReceivable - type: String - displayName: Asset.Assets.AccountsReceivable - required: false - - value: Liability.EquityAndLiabilities.AccountsPayable - type: String - displayName: Liability.EquityAndLiabilities.AccountsPayable - required: false - - value: Asset.Assets.VAT - type: String - displayName: Asset.Assets.VAT - required: false - - value: Liability.EquityAndLiabilities.EmployeesPayable - type: String - displayName: Liability.EquityAndLiabilities.EmployeesPayable - required: false - - value: Asset.Assets.PrepaidExpenses - type: String - displayName: Asset.Assets.PrepaidExpenses - required: false - - value: Liability.EquityAndLiabilities.AccruedExpenses - type: String - displayName: Liability.EquityAndLiabilities.AccruedExpenses - required: false - - value: Liability.EquityAndLiabilities.IncomeTaxesPayable - type: String - displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable - required: false - - value: Asset.Assets.FixedAssets - type: String - displayName: Asset.Assets.FixedAssets - required: false - - value: Asset.Assets.OtherAssets - type: String - displayName: Asset.Assets.OtherAssets - required: false - - value: Asset.Assets.AccumulatedDeprecation - type: String - displayName: Asset.Assets.AccumulatedDeprecation - required: false - - value: Asset.Assets.Inventory - type: String - displayName: Asset.Assets.Inventory - required: false - - value: Equity.EquityAndLiabilities.CapitalStock - type: String - displayName: Equity.EquityAndLiabilities.CapitalStock - required: false - - value: Equity.EquityAndLiabilities.RetainedEarnings - type: String - displayName: Equity.EquityAndLiabilities.RetainedEarnings - required: false - - value: Liability.EquityAndLiabilities.LongTermDebt - type: String - displayName: Liability.EquityAndLiabilities.LongTermDebt - required: false - - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt - type: String - displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt - required: false - - value: Unknown.EquityAndLiabilities.Intercompany - type: String - displayName: Unknown.EquityAndLiabilities.Intercompany - required: false - - value: Unknown.General.General - type: String - displayName: Unknown.General.General - required: false - - value: Income.NetIncome.Revenue - type: String - displayName: Income.NetIncome.Revenue - required: false - - value: Expense.NetIncome.CostOfGoods - type: String - displayName: Expense.NetIncome.CostOfGoods - required: false - - value: Expense.NetIncome.OtherCosts - type: String - displayName: Expense.NetIncome.OtherCosts - required: false - - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses - type: String - displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses - required: false - - value: Expense.NetIncome.DeprecationCosts - type: String - displayName: Expense.NetIncome.DeprecationCosts - required: false - - value: Expense.NetIncome.ResearchAndDevelopment - type: String - displayName: Expense.NetIncome.ResearchAndDevelopment - required: false - - value: Expense.NetIncome.EmployeeCosts - type: String - displayName: Expense.NetIncome.EmployeeCosts - required: false - - value: Expense.NetIncome.EmploymentCosts - type: String - displayName: Expense.NetIncome.EmploymentCosts - required: false - - value: Expense.ExceptionalIncome.ExceptionalCosts - type: String - displayName: Expense.ExceptionalIncome.ExceptionalCosts - required: false - - value: Income.ExceptionalIncome.ExceptionalIncome - type: String - displayName: Income.ExceptionalIncome.ExceptionalIncome - required: false - - value: Expense.ExceptionalIncome.IncomeTaxes - type: String - displayName: Expense.ExceptionalIncome.IncomeTaxes - required: false - - value: Income.ExceptionalIncome.InterestIncome - type: String - displayName: Income.ExceptionalIncome.InterestIncome - required: false - required: true - validation: - warnings: [] - information: - - field: FullyQualifiedCategory - details: Must be provided. - status: - type: String - displayName: Account Status - description: The status of the account - options: - - value: Active - type: String - displayName: Active - required: false - - value: Pending - type: String - displayName: Pending - required: false - - value: Unknown - type: String - displayName: Unknown - required: false - required: true - validation: - warnings: [] - information: - - field: Status - details: Must be provided. - required: true - Exact (UK): - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - validation: - warnings: [] - information: - - field: NominalCode - details: Must be provided. - name: - type: String - displayName: Name - description: Name of the account - required: true - validation: - warnings: [] - information: - - field: Name - details: Must be provided. - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: Asset.Assets.Cash - type: String - displayName: Asset.Assets.Cash - required: false - - value: Asset.Assets.Bank - type: String - displayName: Asset.Assets.Bank - required: false - - value: Asset.Assets.PaymentServices - type: String - displayName: Asset.Assets.PaymentServices - required: false - - value: Asset.Assets.AccountsReceivable - type: String - displayName: Asset.Assets.AccountsReceivable - required: false - - value: Liability.EquityAndLiabilities.AccountsPayable - type: String - displayName: Liability.EquityAndLiabilities.AccountsPayable - required: false - - value: Asset.Assets.VAT - type: String - displayName: Asset.Assets.VAT - required: false - - value: Liability.EquityAndLiabilities.EmployeesPayable - type: String - displayName: Liability.EquityAndLiabilities.EmployeesPayable - required: false - - value: Asset.Assets.PrepaidExpenses - type: String - displayName: Asset.Assets.PrepaidExpenses - required: false - - value: Liability.EquityAndLiabilities.AccruedExpenses - type: String - displayName: Liability.EquityAndLiabilities.AccruedExpenses - required: false - - value: Liability.EquityAndLiabilities.IncomeTaxesPayable - type: String - displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable - required: false - - value: Asset.Assets.FixedAssets - type: String - displayName: Asset.Assets.FixedAssets - required: false - - value: Asset.Assets.OtherAssets - type: String - displayName: Asset.Assets.OtherAssets - required: false - - value: Asset.Assets.AccumulatedDeprecation - type: String - displayName: Asset.Assets.AccumulatedDeprecation - required: false - - value: Asset.Assets.Inventory - type: String - displayName: Asset.Assets.Inventory - required: false - - value: Equity.EquityAndLiabilities.CapitalStock - type: String - displayName: Equity.EquityAndLiabilities.CapitalStock - required: false - - value: Equity.EquityAndLiabilities.RetainedEarnings - type: String - displayName: Equity.EquityAndLiabilities.RetainedEarnings - required: false - - value: Liability.EquityAndLiabilities.LongTermDebt - type: String - displayName: Liability.EquityAndLiabilities.LongTermDebt - required: false - - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt - type: String - displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt - required: false - - value: Unknown.EquityAndLiabilities.Intercompany - type: String - displayName: Unknown.EquityAndLiabilities.Intercompany - required: false - - value: Unknown.General.General - type: String - displayName: Unknown.General.General - required: false - - value: Income.NetIncome.Revenue - type: String - displayName: Income.NetIncome.Revenue - required: false - - value: Expense.NetIncome.CostOfGoods - type: String - displayName: Expense.NetIncome.CostOfGoods - required: false - - value: Expense.NetIncome.OtherCosts - type: String - displayName: Expense.NetIncome.OtherCosts - required: false - - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses - type: String - displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses - required: false - - value: Expense.NetIncome.DeprecationCosts - type: String - displayName: Expense.NetIncome.DeprecationCosts - required: false - - value: Expense.NetIncome.ResearchAndDevelopment - type: String - displayName: Expense.NetIncome.ResearchAndDevelopment - required: false - - value: Expense.NetIncome.EmployeeCosts - type: String - displayName: Expense.NetIncome.EmployeeCosts - required: false - - value: Expense.NetIncome.EmploymentCosts - type: String - displayName: Expense.NetIncome.EmploymentCosts - required: false - - value: Expense.ExceptionalIncome.ExceptionalCosts - type: String - displayName: Expense.ExceptionalIncome.ExceptionalCosts - required: false - - value: Income.ExceptionalIncome.ExceptionalIncome - type: String - displayName: Income.ExceptionalIncome.ExceptionalIncome - required: false - - value: Expense.ExceptionalIncome.IncomeTaxes - type: String - displayName: Expense.ExceptionalIncome.IncomeTaxes - required: false - - value: Income.ExceptionalIncome.InterestIncome - type: String - displayName: Income.ExceptionalIncome.InterestIncome - required: false - required: true - validation: - warnings: [] - information: - - field: FullyQualifiedCategory - details: Must be provided. - status: - type: String - displayName: Account Status - description: The status of the account - options: - - value: Active - type: String - displayName: Active - required: false - - value: Pending - type: String - displayName: Pending - required: false - - value: Unknown - type: String - displayName: Unknown - required: false - required: true - validation: - warnings: [] - information: - - field: Status - details: Must be provided. - required: true - MYOB AccountRight and Essentials: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - validation: - warnings: - - field: NominalCode - details: 'If alphanumeric is supported, must be between 1 and 10 characters. Otherwise format is x-xxxx' - information: [] - name: - type: String - displayName: Name - description: Name of the account - required: false - validation: - warnings: - - field: Name - details: Must have a length between 1 and 60 characters - information: [] - description: - type: String - displayName: Description - description: Description of the account - required: false - validation: - warnings: - - field: Description - details: Must have a length between 1 and 255 characters - information: [] - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: Asset.Bank - type: String - displayName: Bank - required: false - - value: Asset.AccountReceivable - type: String - displayName: Accounts Receivable - required: false - - value: Asset.OtherCurrentAsset - type: String - displayName: Other Current Asset - required: false - - value: Asset.FixedAsset - type: String - displayName: Fixed Asset - required: false - - value: Asset.OtherAsset - type: String - displayName: Other Asset - required: false - - value: Asset.CashAndBank - type: String - displayName: Cash - required: false - - value: Asset.Property Plant and Equipment - type: String - displayName: Equipment Machinery - required: false - - value: Liability.CreditCard - type: String - displayName: Credit Card - required: false - - value: Liability.AccountsPayable - type: String - displayName: Accounts Payable - required: false - - value: Liability.OtherCurrentLiability - type: String - displayName: Other Current Liability - required: false - - value: Liability.LongTermLiability - type: String - displayName: Long Term Liability - required: false - - value: Liability.OtherLiability - type: String - displayName: Other Liability - required: false - - value: Equity - type: String - displayName: Equity - required: false - - value: Equity.Equity - type: String - displayName: Retained Earnings - required: false - - value: Equity.Equity.RetainedEarnings - type: String - displayName: Retained Earnings - required: false - - value: Equity.Owner's Equity - type: String - displayName: Retained Earnings - required: false - - value: Income - type: String - displayName: Income - required: false - - value: OtherIncome - type: String - displayName: Other Income - required: false - - value: Expense - type: String - displayName: Expense - required: false - - value: Expense.Expense - type: String - displayName: Sales Marketing - required: false - - value: Expense.Expense.Insurance - type: String - displayName: General Administrative - required: false - - value: Expense.Overhead - type: String - displayName: General Administrative - required: false - - value: Expense.Expense.RepairMaintenance - type: String - displayName: Repairs Maintenance - required: false - - value: OtherExpense - type: String - displayName: Other Expense - required: false - - value: CostOfSales - type: String - displayName: Cost of Sales - required: false - - value: Cost Of Goods Sold.Cost of Sales - type: String - displayName: Other - required: false - required: true - status: - type: String - displayName: Account Status - description: The status of the account - options: - - value: Active - type: String - displayName: Active - required: false - - value: Archived - type: String - displayName: Archived - required: false - required: true - required: true - QuickBooks Desktop: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - validation: - warnings: - - field: NominalCode - details: Max length of 7 characters. - information: [] - name: - type: String - displayName: Name - description: Name of the account - required: true - validation: - warnings: - - field: Name - details: Max length of 31 characters. - information: [] - description: - type: String - displayName: Description - description: Description of the account - required: false - validation: - warnings: - - field: Description - details: Max length of 200 characters. - information: [] - currency: - type: String - displayName: Currency - description: The currency of the account - required: false - validation: - warnings: - - field: Currency - details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' - - field: Currency - details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company - - field: Currency - details: Can only be set if the Quickbooks Desktop company has Multicurrency enabled. - information: - - field: Currency - details: 'If not set, will default to the base currency of the QuickBooks Desktop company' - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: Asset.AccountsReceivable - type: String - displayName: Account Receivable - required: false - - value: Asset.FixedAsset - type: String - displayName: Fixed Asset - required: false - - value: Asset.OtherCurrentAsset - type: String - displayName: Other Current Asset - required: false - - value: Asset.OtherAsset - type: String - displayName: Other Asset - required: false - - value: Income.Income - type: String - displayName: Income - required: false - - value: Income.OtherIncome - type: String - displayName: Other Income - required: false - - value: Liability.AccountsPayable - type: String - displayName: Accounts Payable - required: false - - value: Liability.CreditCard - type: String - displayName: Credit Card - required: false - - value: Liability.LongTermLiability - type: String - displayName: Long Term Liability - required: false - - value: Liability.OtherCurrentLiability - type: String - displayName: Other Current Liability - required: false - - value: Liability.CostOfGoodsSold - type: String - displayName: Cost Of Goods Sold - required: false - - value: Equity.Equity - type: String - displayName: Equity - required: false - - value: Expense.Expense - type: String - displayName: Expense - required: false - - value: Expense.OtherExpense - type: String - displayName: Other Expense - required: false - required: true - currentBalance: - type: Number - displayName: Current Balance - description: The current balance in the account - required: false - required: true - QuickBooks Online Sandbox: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: false - validation: - warnings: [] - information: - - field: NominalCode - details: If included must have a length between 1 and 7 characters - name: - type: String - displayName: Name - description: Name of the account - required: true - validation: - warnings: - - field: Name - details: Must have a length between 1 and 100 characters - information: [] - currency: - type: String - displayName: Currency - description: The currency of the account - required: false - validation: - warnings: [] - information: - - field: Currency - details: When not specified company base currency will be used - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: Asset.Bank.CashOnHand - type: String - displayName: Cash On Hand - required: false - - value: Asset.Bank.Checking - type: String - displayName: Checking - required: false - - value: Asset.Bank.MoneyMarket - type: String - displayName: Money Market - required: false - - value: Asset.Bank.RentsHeldInTrust - type: String - displayName: Rents Held In Trust - required: false - - value: Asset.Bank.Savings - type: String - displayName: Savings - required: false - - value: Asset.Bank.TrustAccounts - type: String - displayName: Trust Accounts - required: false - - value: Asset.Bank.CashAndCashEquivalents - type: String - displayName: Cash And Cash Equivalents - required: false - - value: Asset.Bank.OtherEarmarkedBankAccounts - type: String - displayName: Other Earmarked Bank Accounts - required: false - - value: Asset.Other Current Asset.AllowanceForBadDebts - type: String - displayName: Allowance For Bad Debts - required: false - - value: Asset.Other Current Asset.DevelopmentCosts - type: String - displayName: Development Costs - required: false - - value: Asset.Other Current Asset.EmployeeCashAdvances - type: String - displayName: Employee Cash Advances - required: false - - value: Asset.Other Current Asset.OtherCurrentAssets - type: String - displayName: Other Current Assets - required: false - - value: Asset.Other Current Asset.Inventory - type: String - displayName: Inventory - required: false - - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans - type: String - displayName: Investment Mortgage Real Estate Loans - required: false - - value: Asset.Other Current Asset.Investment_Other - type: String - displayName: Investment Other - required: false - - value: Asset.Other Current Asset.Investment_TaxExemptSecurities - type: String - displayName: Investment Tax Exempt Securities - required: false - - value: Asset.Other Current Asset.Investment_USGovernmentObligations - type: String - displayName: Investment US Government Obligations - required: false - - value: Asset.Other Current Asset.LoansToOfficers - type: String - displayName: Loans To Officers - required: false - - value: Asset.Other Current Asset.LoansToOthers - type: String - displayName: Loans To Others - required: false - - value: Asset.Other Current Asset.LoansToStockholders - type: String - displayName: Loans To Stockholders - required: false - - value: Asset.Other Current Asset.PrepaidExpenses - type: String - displayName: Prepaid Expenses - required: false - - value: Asset.Other Current Asset.Retainage - type: String - displayName: Retainage - required: false - - value: Asset.Other Current Asset.UndepositedFunds - type: String - displayName: Undeposited Funds - required: false - - value: Asset.Other Current Asset.AssetsAvailableForSale - type: String - displayName: Assets Available For Sale - required: false - - value: Asset.Other Current Asset.BalWithGovtAuthorities - type: String - displayName: Balance With Govt Authorities - required: false - - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid - type: String - displayName: Called Up Share Capital Not Paid - required: false - - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit - type: String - displayName: Expenditure Authorisations And Letters Of Credit - required: false - - value: Asset.Other Current Asset.GlobalTaxDeferred - type: String - displayName: Global Tax Deferred - required: false - - value: Asset.Other Current Asset.GlobalTaxRefund - type: String - displayName: Global Tax Refund - required: false - - value: Asset.Other Current Asset.InternalTransfers - type: String - displayName: Internal Transfers - required: false - - value: Asset.Other Current Asset.OtherConsumables - type: String - displayName: Other Consumables - required: false - - value: Asset.Other Current Asset.ProvisionsCurrentAssets - type: String - displayName: Provisions Current Assets - required: false - - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties - type: String - displayName: Short Term Investments In Related Parties - required: false - - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties - type: String - displayName: Short Term Loans And Advances To Related Parties - required: false - - value: Asset.Other Current Asset.TradeAndOtherReceivables - type: String - displayName: Trade And Other Receivables - required: false - - value: Asset.Fixed Asset.AccumulatedDepletion - type: String - displayName: Accumulated Depletion - required: false - - value: Asset.Fixed Asset.AccumulatedDepreciation - type: String - displayName: Accumulated Depreciation - required: false - - value: Asset.Fixed Asset.DepletableAssets - type: String - displayName: Depletable Assets - required: false - - value: Asset.Fixed Asset.FixedAssetComputers - type: String - displayName: Fixed Asset Computers - required: false - - value: Asset.Fixed Asset.FixedAssetCopiers - type: String - displayName: Fixed Asset Copiers - required: false - - value: Asset.Fixed Asset.FixedAssetFurniture - type: String - displayName: Fixed Asset Furniture - required: false - - value: Asset.Fixed Asset.FixedAssetPhone - type: String - displayName: Fixed Asset Phone - required: false - - value: Asset.Fixed Asset.FixedAssetPhotoVideo - type: String - displayName: Fixed Asset Photo Video - required: false - - value: Asset.Fixed Asset.FixedAssetSoftware - type: String - displayName: Fixed Asset Software - required: false - - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment - type: String - displayName: Fixed Asset Other Tools Equipment - required: false - - value: Asset.Fixed Asset.FurnitureAndFixtures - type: String - displayName: Furniture And Fixtures - required: false - - value: Asset.Fixed Asset.Land - type: String - displayName: Land - required: false - - value: Asset.Fixed Asset.LeaseholdImprovements - type: String - displayName: Leasehold Improvements - required: false - - value: Asset.Fixed Asset.OtherFixedAssets - type: String - displayName: Other Fixed Assets - required: false - - value: Asset.Fixed Asset.AccumulatedAmortization - type: String - displayName: Accumulated Amortization - required: false - - value: Asset.Fixed Asset.Buildings - type: String - displayName: Buildings - required: false - - value: Asset.Fixed Asset.IntangibleAssets - type: String - displayName: Intangible Assets - required: false - - value: Asset.Fixed Asset.MachineryAndEquipment - type: String - displayName: Machinery And Equipment - required: false - - value: Asset.Fixed Asset.Vehicles - type: String - displayName: Vehicles - required: false - - value: Asset.Fixed Asset.AssetsInCourseOfConstruction - type: String - displayName: Assets In Course Of Construction - required: false - - value: Asset.Fixed Asset.CapitalWip - type: String - displayName: Capital Wip - required: false - - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets - type: String - displayName: Cumulative Depreciation On Intangible Assets - required: false - - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment - type: String - displayName: Intangible Assets Under Development - required: false - - value: Asset.Fixed Asset.LandAsset - type: String - displayName: Land Asset - required: false - - value: Asset.Fixed Asset.NonCurrentAssets - type: String - displayName: Non Current Assets - required: false - - value: Asset.Fixed Asset.ParticipatingInterests - type: String - displayName: Participating Interests - required: false - - value: Asset.Fixed Asset.ProvisionsFixedAssets - type: String - displayName: Provisions Fixed Assets - required: false - - value: Asset.Other Asset.LeaseBuyout - type: String - displayName: Lease Buyout - required: false - - value: Asset.Other Asset.OtherLongTermAssets - type: String - displayName: Other Long Term Assets - required: false - - value: Asset.Other Asset.SecurityDeposits - type: String - displayName: Security Deposits - required: false - - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets - type: String - displayName: Accumulated Amortization Of Other Assets - required: false - - value: Asset.Other Asset.Goodwill - type: String - displayName: Goodwill - required: false - - value: Asset.Other Asset.Licenses - type: String - displayName: Licenses - required: false - - value: Asset.Other Asset.OrganizationalCosts - type: String - displayName: Organizational Costs - required: false - - value: Asset.Other Asset.AssetsHeldForSale - type: String - displayName: Assets Held For Sale - required: false - - value: Asset.Other Asset.AvailableForSaleFinancialAssets - type: String - displayName: Available For Sale Financial Assets - required: false - - value: Asset.Other Asset.DeferredTax - type: String - displayName: Deferred Tax - required: false - - value: Asset.Other Asset.Investments - type: String - displayName: Investments - required: false - - value: Asset.Other Asset.LongTermInvestments - type: String - displayName: Long Term Investments - required: false - - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties - type: String - displayName: Long Term Loans And Advances To Related Parties - required: false - - value: Asset.Other Asset.OtherIntangibleAssets - type: String - displayName: Other Intangible Assets - required: false - - value: Asset.Other Asset.OtherLongTermInvestments - type: String - displayName: Other Long Term Investments - required: false - - value: Asset.Other Asset.OtherLongTermLoansAndAdvances - type: String - displayName: Other Long Term Loans And Advances - required: false - - value: Asset.Other Asset.PrepaymentsAndAccruedIncome - type: String - displayName: Prepayments And Accrued Income - required: false - - value: Asset.Other Asset.ProvisionsNonCurrentAssets - type: String - displayName: Provisions Non-Current Assets - required: false - - value: Asset.Accounts Receivable.AccountsReceivable - type: String - displayName: Accounts Receivable - required: false - - value: Expense.Expense.AdvertisingPromotional - type: String - displayName: Advertising/Promotional - required: false - - value: Expense.Expense.BadDebts - type: String - displayName: Bad Debts - required: false - - value: Expense.Expense.BankCharges - type: String - displayName: Bank Charges - required: false - - value: Expense.Expense.CharitableContributions - type: String - displayName: Charitable Contributions - required: false - - value: Expense.Expense.CommissionsAndFees - type: String - displayName: Commissions And Fees - required: false - - value: Expense.Expense.Entertainment - type: String - displayName: Entertainment - required: false - - value: Expense.Expense.EntertainmentMeals - type: String - displayName: Entertainment Meals - required: false - - value: Expense.Expense.EquipmentRental - type: String - displayName: Equipment Rental - required: false - - value: Expense.Expense.FinanceCosts - type: String - displayName: Finance Costs - required: false - - value: Expense.Expense.GlobalTaxExpense - type: String - displayName: Global Tax Expense - required: false - - value: Expense.Expense.Insurance - type: String - displayName: Insurance - required: false - - value: Expense.Expense.InterestPaid - type: String - displayName: Interest Paid - required: false - - value: Expense.Expense.LegalProfessionalFees - type: String - displayName: Legal And Professional Fees - required: false - - value: Expense.Expense.OfficeExpenses - type: String - displayName: Office Expenses - required: false - - value: Expense.Expense.OfficeGeneralAdministrativeExpenses - type: String - displayName: Office/General Administrative Expenses - required: false - - value: Expense.Expense.OtherBusinessExpenses - type: String - displayName: Other Business Expenses - required: false - - value: Expense.Expense.OtherMiscellaneousServiceCost - type: String - displayName: Other Miscellaneous Service Cost - required: false - - value: Expense.Expense.PromotionalMeals - type: String - displayName: Promotional Meals - required: false - - value: Expense.Expense.RentOrLeaseOfBuildings - type: String - displayName: Rent Or Lease Of Buildings - required: false - - value: Expense.Expense.RepairMaintenance - type: String - displayName: Repair And Maintenance - required: false - - value: Expense.Expense.ShippingFreightDelivery - type: String - displayName: 'Shipping, Freight And Delivery' - required: false - - value: Expense.Expense.SuppliesMaterials - type: String - displayName: Supplies And Materials - required: false - - value: Expense.Expense.Travel - type: String - displayName: Travel - required: false - - value: Expense.Expense.TravelMeals - type: String - displayName: Travel Meals - required: false - - value: Expense.Expense.Utilities - type: String - displayName: Utilities - required: false - - value: Expense.Expense.Auto - type: String - displayName: Auto - required: false - - value: Expense.Expense.CostOfLabor - type: String - displayName: Cost Of Labor - required: false - - value: Expense.Expense.DuesSubscriptions - type: String - displayName: Dues And Subscriptions - required: false - - value: Expense.Expense.PayrollExpenses - type: String - displayName: Payroll Expenses - required: false - - value: Expense.Expense.TaxesPaid - type: String - displayName: Taxes Paid - required: false - - value: Expense.Expense.UnappliedCashBillPaymentExpense - type: String - displayName: Unapplied Cash Bill Payment Expense - required: false - - value: Expense.Expense.Utilities - type: String - displayName: Utilities - required: false - - value: Expense.Expense.AmortizationExpense - type: String - displayName: Amortization Expense - required: false - - value: Expense.Expense.AppropriationsToDepreciation - type: String - displayName: Appropriations To Depreciation - required: false - - value: Expense.Expense.BorrowingCost - type: String - displayName: Borrowing Cost - required: false - - value: Expense.Expense.CommissionsAndFees - type: String - displayName: Commissions And Fees - required: false - - value: Expense.Expense.DistributionCosts - type: String - displayName: Distribution Costs - required: false - - value: Expense.Expense.ExternalServices - type: String - displayName: External Services - required: false - - value: Expense.Expense.ExtraordinaryCharges - type: String - displayName: Extraordinary Charges - required: false - - value: Expense.Expense.IncomeTaxExpense - type: String - displayName: Income Tax Expense - required: false - - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax - type: String - displayName: Loss On Discontinued Operations Net Of Tax - required: false - - value: Expense.Expense.ManagementCompensation - type: String - displayName: Management Compensation - required: false - - value: Expense.Expense.OtherCurrentOperatingCharges - type: String - displayName: Other Current Operating Charges - required: false - - value: Expense.Expense.OtherExternalServices - type: String - displayName: Other External Services - required: false - - value: Expense.Expense.OtherRentalCosts - type: String - displayName: Other Rental Costs - required: false - - value: Expense.Expense.OtherSellingExpenses - type: String - displayName: Other Selling Expenses - required: false - - value: Expense.Expense.ProjectStudiesSurveysAssessments - type: String - displayName: Project Studies Surveys Assessments - required: false - - value: Expense.Expense.PurchasesRebates - type: String - displayName: Purchases Rebates - required: false - - value: Expense.Expense.ShippingAndDeliveryExpense - type: String - displayName: Shipping And Delivery Expense - required: false - - value: Expense.Expense.StaffCosts - type: String - displayName: Staff Costs - required: false - - value: Expense.Expense.Sundry - type: String - displayName: Sundry - required: false - - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses - type: String - displayName: Travel Expenses General And Admin Expenses - required: false - - value: Expense.Expense.TravelExpensesSellingExpense - type: String - displayName: Travel Expenses Selling Expense - required: false - - value: Expense.Other Expense.Depreciation - type: String - displayName: Depreciation - required: false - - value: Expense.Other Expense.ExchangeGainOrLoss - type: String - displayName: Exchange Gain Or Loss - required: false - - value: Expense.Other Expense.OtherMiscellaneousExpense - type: String - displayName: Other Miscellaneous Expense - required: false - - value: Expense.Other Expense.PenaltiesSettlements - type: String - displayName: Penalties And Settlements - required: false - - value: Expense.Other Expense.Amortization - type: String - displayName: Amortization - required: false - - value: Expense.Other Expense.GasAndFuel - type: String - displayName: Gas And Fuel - required: false - - value: Expense.Other Expense.HomeOffice - type: String - displayName: Home Office - required: false - - value: Expense.Other Expense.HomeOwnerRentalInsurance - type: String - displayName: Home Owner Rental Insurance - required: false - - value: Expense.Other Expense.OtherHomeOfficeExpenses - type: String - displayName: Other Home Office Expenses - required: false - - value: Expense.Other Expense.MortgageInterest - type: String - displayName: Mortgage Interest - required: false - - value: Expense.Other Expense.RentAndLease - type: String - displayName: Rent And Lease - required: false - - value: Expense.Other Expense.RepairsAndMaintenance - type: String - displayName: Repairs And Maintenance - required: false - - value: Expense.Other Expense.ParkingAndTolls - type: String - displayName: Parking And Tolls - required: false - - value: Expense.Other Expense.Vehicle - type: String - displayName: Vehicle - required: false - - value: Expense.Other Expense.VehicleInsurance - type: String - displayName: Vehicle Insurance - required: false - - value: Expense.Other Expense.VehicleLease - type: String - displayName: Vehicle Lease - required: false - - value: Expense.Other Expense.VehicleLoanInterest - type: String - displayName: Vehicle Loan Interest - required: false - - value: Expense.Other Expense.VehicleLoan - type: String - displayName: Vehicle Loan - required: false - - value: Expense.Other Expense.VehicleRegistration - type: String - displayName: Vehicle Registration - required: false - - value: Expense.Other Expense.VehicleRepairs - type: String - displayName: Vehicle Repairs - required: false - - value: Expense.Other Expense.OtherVehicleExpenses - type: String - displayName: Other Vehicle Expenses - required: false - - value: Expense.Other Expense.Utilities - type: String - displayName: Utilities - required: false - - value: Expense.Other Expense.WashAndRoadServices - type: String - displayName: Wash And Road Services - required: false - - value: Expense.Other Expense.DeferredTaxExpense - type: String - displayName: Deferred Tax Expense - required: false - - value: Expense.Other Expense.Depletion - type: String - displayName: Depletion - required: false - - value: Expense.Other Expense.ExceptionalItems - type: String - displayName: Exceptional Items - required: false - - value: Expense.Other Expense.ExtraordinaryItems - type: String - displayName: Extraordinary Items - required: false - - value: Expense.Other Expense.IncomeTaxOtherExpense - type: String - displayName: Income Tax Other Expense - required: false - - value: Expense.Other Expense.MatCredit - type: String - displayName: Mat Credit - required: false - - value: Expense.Other Expense.PriorPeriodItems - type: String - displayName: Prior Period Items - required: false - - value: Expense.Other Expense.TaxRoundoffGainOrLoss - type: String - displayName: Tax Roundoff Gain Or Loss - required: false - - value: Expense.Cost of Goods Sold.EquipmentRentalCos - type: String - displayName: Equipment Rental - COS - required: false - - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos - type: String - displayName: Other Costs Of Sales - COS - required: false - - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos - type: String - displayName: 'Shipping, Freight And Delivery - COS' - required: false - - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs - type: String - displayName: Supplies And Materials - COS - required: false - - value: Expense.Cost of Goods Sold.CostOfLaborCos - type: String - displayName: Cost Of Labor - COS - required: false - - value: Expense.Cost of Goods Sold.CostOfSales - type: String - displayName: Cost Of Sales - required: false - - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost - type: String - displayName: Freight And Delivery Cost - required: false - - value: Income.Income.NonProfitIncome - type: String - displayName: Non Profit Income - required: false - - value: Income.Income.OtherPrimaryIncome - type: String - displayName: Other Primary Income - required: false - - value: Income.Income.SalesOfProductIncome - type: String - displayName: Sales Of ProductIncome - required: false - - value: Income.Income.ServiceFeeIncome - type: String - displayName: Service Fee Income - required: false - - value: Income.Income.DiscountsRefundsGiven - type: String - displayName: Discounts Refunds Given - required: false - - value: Income.Income.UnappliedCashPaymentIncome - type: String - displayName: Unapplied Cash Payment Income - required: false - - value: Income.Income.CashReceiptIncome - type: String - displayName: Cash Receipt Income - required: false - - value: Income.Income.OperatingGrants - type: String - displayName: Operating Grants - required: false - - value: Income.Income.OtherCurrentOperatingIncome - type: String - displayName: Other Current Operating Income - required: false - - value: Income.Income.OwnWorkCapitalized - type: String - displayName: Own Work Capitalized - required: false - - value: Income.Income.RevenueGeneral - type: String - displayName: Revenue General - required: false - - value: Income.Income.SalesRetail - type: String - displayName: Sales Retail - required: false - - value: Income.Income.SalesWholesale - type: String - displayName: Sales Wholesale - required: false - - value: Income.Income.SavingsByTaxScheme - type: String - displayName: Savings By Tax Scheme - required: false - - value: Income.Other Income.DividendIncome - type: String - displayName: Dividend Income - required: false - - value: Income.Other Income.InterestEarned - type: String - displayName: Interest Earned - required: false - - value: Income.Other Income.OtherInvestmentIncome - type: String - displayName: Other Investment Income - required: false - - value: Income.Other Income.OtherMiscellaneousIncome - type: String - displayName: Other Miscellaneous Income - required: false - - value: Income.Other Income.TaxExemptInterest - type: String - displayName: Tax Exempt Interest - required: false - - value: Income.Other Income.GainLossOnSaleOfFixedAssets - type: String - displayName: Gain Loss On Sale Of Fixed Assets - required: false - - value: Income.Other Income.GainLossOnSaleOfInvestments - type: String - displayName: Gain Loss On Sale Of Investments - required: false - - value: Income.Other Income.LossOnDisposalOfAssets - type: String - displayName: Loss On Disposal Of Assets - required: false - - value: Income.Other Income.OtherOperatingIncome - type: String - displayName: Other Operating Income - required: false - - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax - type: String - displayName: Unrealised Loss On Securities Net Of Tax - required: false - - value: Liability.Accounts Payable.AccountsPayable - type: String - displayName: Accounts Payable - required: false - - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise - type: String - displayName: Outstanding Dues Micro Small Enterprise - required: false - - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise - type: String - displayName: Outstanding Dues Other Than Micro Small Enterprise - required: false - - value: Liability.Credit Card.CreditCard - type: String - displayName: Credit Card - required: false - - value: Liability.Long Term Liability.NotesPayable - type: String - displayName: Notes Payable - required: false - - value: Liability.Long Term Liability.OtherLongTermLiabilities - type: String - displayName: Other Long Term Liabilities - required: false - - value: Liability.Long Term Liability.ShareholderNotesPayable - type: String - displayName: Shareholder Notes Payable - required: false - - value: Liability.Long Term Liability.AccrualsAndDeferredIncome - type: String - displayName: Accruals And Deferred Income - required: false - - value: Liability.Long Term Liability.AccruedLongLermLiabilities - type: String - displayName: Accrued Long Lerm Liabilities - required: false - - value: Liability.Long Term Liability.AccruedVacationPayable - type: String - displayName: Accrued Vacation Payable - required: false - - value: Liability.Long Term Liability.BankLoans - type: String - displayName: Bank Loans - required: false - - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests - type: String - displayName: Debts Related To Participating Interests - required: false - - value: Liability.Long Term Liability.DeferredTaxLiabilities - type: String - displayName: Deferred Tax Liabilities - required: false - - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities - type: String - displayName: Government And Other Public Authorities - required: false - - value: Liability.Long Term Liability.GroupAndAssociates - type: String - displayName: Group And Associates - required: false - - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale - type: String - displayName: Liabilities Related To Assets Held For Sale - required: false - - value: Liability.Long Term Liability.LongTermBorrowings - type: String - displayName: Long Term Borrowings - required: false - - value: Liability.Long Term Liability.LongTermDebit - type: String - displayName: Long Term Debit - required: false - - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations - type: String - displayName: Long Term Employee Benefit Obligations - required: false - - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases - type: String - displayName: Obligations Under Finance Leases - required: false - - value: Liability.Long Term Liability.OtherLongTermProvisions - type: String - displayName: Other Long Term Provisions - required: false - - value: Liability.Long Term Liability.ProvisionForLiabilities - type: String - displayName: Provision For Liabilities - required: false - - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities - type: String - displayName: Provisions Non Current Liabilities - required: false - - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts - type: String - displayName: Staff And Related Long Term Liability Accounts - required: false - - value: Liability.Other Current Liability.DirectDepositPayable - type: String - displayName: Direct Deposit Payable - required: false - - value: Liability.Other Current Liability.LineOfCredit - type: String - displayName: Line Of Credit - required: false - - value: Liability.Other Current Liability.LoanPayable - type: String - displayName: Loan Payable - required: false - - value: Liability.Other Current Liability.GlobalTaxPayable - type: String - displayName: Global Tax Payable - required: false - - value: Liability.Other Current Liability.GlobalTaxSuspense - type: String - displayName: Global Tax Suspense - required: false - - value: Liability.Other Current Liability.OtherCurrentLiabilities - type: String - displayName: Other Current Liabilities - required: false - - value: Liability.Other Current Liability.PayrollClearing - type: String - displayName: Payroll Clearing - required: false - - value: Liability.Other Current Liability.PayrollTaxPayable - type: String - displayName: Payroll Tax Payable - required: false - - value: Liability.Other Current Liability.PrepaidExpensesPayable - type: String - displayName: Prepaid Expenses Payable - required: false - - value: Liability.Other Current Liability.RentsInTrustLiability - type: String - displayName: Rents In Trust Liability - required: false - - value: Liability.Other Current Liability.TrustAccountsLiabilities - type: String - displayName: Trust Accounts Liabilities - required: false - - value: Liability.Other Current Liability.FederalIncomeTaxPayable - type: String - displayName: Federal Income Tax Payable - required: false - - value: Liability.Other Current Liability.InsurancePayable - type: String - displayName: Insurance Payable - required: false - - value: Liability.Other Current Liability.SalesTaxPayable - type: String - displayName: Sales Tax Payable - required: false - - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable - type: String - displayName: State Local Income Tax Payable - required: false - - value: Liability.Other Current Liability.AccruedLiabilities - type: String - displayName: Accrued Liabilities - required: false - - value: Liability.Other Current Liability.CurrentLiabilities - type: String - displayName: Current Liabilities - required: false - - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations - type: String - displayName: Current Portion EmployeeBenefits Obligations - required: false - - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases - type: String - displayName: Current Portion Of Obligations Under Finance Leases - required: false - - value: Liability.Other Current Liability.CurrentTaxLiability - type: String - displayName: Current Tax Liability - required: false - - value: Liability.Other Current Liability.DividendsPayable - type: String - displayName: Dividends Payable - required: false - - value: Liability.Other Current Liability.DutiesAndTaxes - type: String - displayName: Duties And Taxes - required: false - - value: Liability.Other Current Liability.InterestPayables - type: String - displayName: Interest Payables - required: false - - value: Liability.Other Current Liability.ProvisionForWarrantyObligations - type: String - displayName: Provision For Warranty Obligations - required: false - - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities - type: String - displayName: Provisions Current Liabilities - required: false - - value: Liability.Other Current Liability.ShortTermBorrowings - type: String - displayName: Short Term Borrowings - required: false - - value: Liability.Other Current Liability.SocialSecurityAgencies - type: String - displayName: Social Security Agencies - required: false - - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts - type: String - displayName: Staff And Related Liability Accounts - required: false - - value: Liability.Other Current Liability.SundryDebtorsAndCreditors - type: String - displayName: Sundry Debtors And Creditors - required: false - - value: Liability.Other Current Liability.TradeAndOtherPayables - type: String - displayName: Trade And Other Payables - required: false - - value: Equity.Equity.OpeningBalanceEquity - type: String - displayName: Opening Balance Equity - required: false - - value: Equity.Equity.PartnersEquity - type: String - displayName: Partners Equity - required: false - - value: Equity.Equity.RetainedEarnings - type: String - displayName: Retained Earnings - required: false - - value: Equity.Equity.AccumulatedAdjustment - type: String - displayName: Accumulated Adjustment - required: false - - value: Equity.Equity.OwnersEquity - type: String - displayName: Owners Equity - required: false - - value: Equity.Equity.PaidInCapitalOrSurplus - type: String - displayName: Paid In Capital Or Surplus - required: false - - value: Equity.Equity.PartnerContributions - type: String - displayName: Partner Contributions - required: false - - value: Equity.Equity.PartnerDistributions - type: String - displayName: Partner Distributions - required: false - - value: Equity.Equity.PreferredStock - type: String - displayName: Preferred Stock - required: false - - value: Equity.Equity.CommonStock - type: String - displayName: Common Stock - required: false - - value: Equity.Equity.TreasuryStock - type: String - displayName: Treasury Stock - required: false - - value: Equity.Equity.EstimatedTaxes - type: String - displayName: Estimated Taxes - required: false - - value: Equity.Equity.Healthcare - type: String - displayName: Healthcare - required: false - - value: Equity.Equity.PersonalIncome - type: String - displayName: Personal Income - required: false - - value: Equity.Equity.PersonalExpense - type: String - displayName: Personal Expense - required: false - - value: Equity.Equity.AccumulatedOtherComprehensiveIncome - type: String - displayName: Accumulated Other Comprehensive Income - required: false - - value: Equity.Equity.CalledUpShareCapital - type: String - displayName: Called Up Share Capital - required: false - - value: Equity.Equity.CapitalReserves - type: String - displayName: Capital Reserves - required: false - - value: Equity.Equity.DividendDisbursed - type: String - displayName: Dividend Disbursed - required: false - - value: Equity.Equity.EquityInEarningsOfSubsiduaries - type: String - displayName: Equity In Earnings Of Subsiduaries - required: false - - value: Equity.Equity.InvestmentGrants - type: String - displayName: Investment Grants - required: false - - value: Equity.Equity.MoneyReceivedAgainstShareWarrants - type: String - displayName: Money Received Against Share Warrants - required: false - - value: Equity.Equity.OtherFreeReserves - type: String - displayName: Other Free Reserves - required: false - - value: Equity.Equity.ShareApplicationMoneyPendingAllotment - type: String - displayName: Share Application Money Pending Allotment - required: false - - value: Equity.Equity.ShareCapital - type: String - displayName: Share Capital - required: false - - value: Equity.Equity.Funds - type: String - displayName: Funds - required: false - required: true - required: true - QuickBooks Online: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: false - validation: - warnings: [] - information: - - field: NominalCode - details: If included must have a length between 1 and 7 characters - name: - type: String - displayName: Name - description: Name of the account - required: true - validation: - warnings: - - field: Name - details: Must have a length between 1 and 100 characters - information: [] - currency: - type: String - displayName: Currency - description: The currency of the account - required: false - validation: - warnings: [] - information: - - field: Currency - details: When not specified company base currency will be used - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: Asset.Bank.CashOnHand - type: String - displayName: Cash On Hand - required: false - - value: Asset.Bank.Checking - type: String - displayName: Checking - required: false - - value: Asset.Bank.MoneyMarket - type: String - displayName: Money Market - required: false - - value: Asset.Bank.RentsHeldInTrust - type: String - displayName: Rents Held In Trust - required: false - - value: Asset.Bank.Savings - type: String - displayName: Savings - required: false - - value: Asset.Bank.TrustAccounts - type: String - displayName: Trust Accounts - required: false - - value: Asset.Bank.CashAndCashEquivalents - type: String - displayName: Cash And Cash Equivalents - required: false - - value: Asset.Bank.OtherEarmarkedBankAccounts - type: String - displayName: Other Earmarked Bank Accounts - required: false - - value: Asset.Other Current Asset.AllowanceForBadDebts - type: String - displayName: Allowance For Bad Debts - required: false - - value: Asset.Other Current Asset.DevelopmentCosts - type: String - displayName: Development Costs - required: false - - value: Asset.Other Current Asset.EmployeeCashAdvances - type: String - displayName: Employee Cash Advances - required: false - - value: Asset.Other Current Asset.OtherCurrentAssets - type: String - displayName: Other Current Assets - required: false - - value: Asset.Other Current Asset.Inventory - type: String - displayName: Inventory - required: false - - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans - type: String - displayName: Investment Mortgage Real Estate Loans - required: false - - value: Asset.Other Current Asset.Investment_Other - type: String - displayName: Investment Other - required: false - - value: Asset.Other Current Asset.Investment_TaxExemptSecurities - type: String - displayName: Investment Tax Exempt Securities - required: false - - value: Asset.Other Current Asset.Investment_USGovernmentObligations - type: String - displayName: Investment US Government Obligations - required: false - - value: Asset.Other Current Asset.LoansToOfficers - type: String - displayName: Loans To Officers - required: false - - value: Asset.Other Current Asset.LoansToOthers - type: String - displayName: Loans To Others - required: false - - value: Asset.Other Current Asset.LoansToStockholders - type: String - displayName: Loans To Stockholders - required: false - - value: Asset.Other Current Asset.PrepaidExpenses - type: String - displayName: Prepaid Expenses - required: false - - value: Asset.Other Current Asset.Retainage - type: String - displayName: Retainage - required: false - - value: Asset.Other Current Asset.UndepositedFunds - type: String - displayName: Undeposited Funds - required: false - - value: Asset.Other Current Asset.AssetsAvailableForSale - type: String - displayName: Assets Available For Sale - required: false - - value: Asset.Other Current Asset.BalWithGovtAuthorities - type: String - displayName: Balance With Govt Authorities - required: false - - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid - type: String - displayName: Called Up Share Capital Not Paid - required: false - - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit - type: String - displayName: Expenditure Authorisations And Letters Of Credit - required: false - - value: Asset.Other Current Asset.GlobalTaxDeferred - type: String - displayName: Global Tax Deferred - required: false - - value: Asset.Other Current Asset.GlobalTaxRefund - type: String - displayName: Global Tax Refund - required: false - - value: Asset.Other Current Asset.InternalTransfers - type: String - displayName: Internal Transfers - required: false - - value: Asset.Other Current Asset.OtherConsumables - type: String - displayName: Other Consumables - required: false - - value: Asset.Other Current Asset.ProvisionsCurrentAssets - type: String - displayName: Provisions Current Assets - required: false - - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties - type: String - displayName: Short Term Investments In Related Parties - required: false - - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties - type: String - displayName: Short Term Loans And Advances To Related Parties - required: false - - value: Asset.Other Current Asset.TradeAndOtherReceivables - type: String - displayName: Trade And Other Receivables - required: false - - value: Asset.Fixed Asset.AccumulatedDepletion - type: String - displayName: Accumulated Depletion - required: false - - value: Asset.Fixed Asset.AccumulatedDepreciation - type: String - displayName: Accumulated Depreciation - required: false - - value: Asset.Fixed Asset.DepletableAssets - type: String - displayName: Depletable Assets - required: false - - value: Asset.Fixed Asset.FixedAssetComputers - type: String - displayName: Fixed Asset Computers - required: false - - value: Asset.Fixed Asset.FixedAssetCopiers - type: String - displayName: Fixed Asset Copiers - required: false - - value: Asset.Fixed Asset.FixedAssetFurniture - type: String - displayName: Fixed Asset Furniture - required: false - - value: Asset.Fixed Asset.FixedAssetPhone - type: String - displayName: Fixed Asset Phone - required: false - - value: Asset.Fixed Asset.FixedAssetPhotoVideo - type: String - displayName: Fixed Asset Photo Video - required: false - - value: Asset.Fixed Asset.FixedAssetSoftware - type: String - displayName: Fixed Asset Software - required: false - - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment - type: String - displayName: Fixed Asset Other Tools Equipment - required: false - - value: Asset.Fixed Asset.FurnitureAndFixtures - type: String - displayName: Furniture And Fixtures - required: false - - value: Asset.Fixed Asset.Land - type: String - displayName: Land - required: false - - value: Asset.Fixed Asset.LeaseholdImprovements - type: String - displayName: Leasehold Improvements - required: false - - value: Asset.Fixed Asset.OtherFixedAssets - type: String - displayName: Other Fixed Assets - required: false - - value: Asset.Fixed Asset.AccumulatedAmortization - type: String - displayName: Accumulated Amortization - required: false - - value: Asset.Fixed Asset.Buildings - type: String - displayName: Buildings - required: false - - value: Asset.Fixed Asset.IntangibleAssets - type: String - displayName: Intangible Assets - required: false - - value: Asset.Fixed Asset.MachineryAndEquipment - type: String - displayName: Machinery And Equipment - required: false - - value: Asset.Fixed Asset.Vehicles - type: String - displayName: Vehicles - required: false - - value: Asset.Fixed Asset.AssetsInCourseOfConstruction - type: String - displayName: Assets In Course Of Construction - required: false - - value: Asset.Fixed Asset.CapitalWip - type: String - displayName: Capital Wip - required: false - - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets - type: String - displayName: Cumulative Depreciation On Intangible Assets - required: false - - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment - type: String - displayName: Intangible Assets Under Development - required: false - - value: Asset.Fixed Asset.LandAsset - type: String - displayName: Land Asset - required: false - - value: Asset.Fixed Asset.NonCurrentAssets - type: String - displayName: Non Current Assets - required: false - - value: Asset.Fixed Asset.ParticipatingInterests - type: String - displayName: Participating Interests - required: false - - value: Asset.Fixed Asset.ProvisionsFixedAssets - type: String - displayName: Provisions Fixed Assets - required: false - - value: Asset.Other Asset.LeaseBuyout - type: String - displayName: Lease Buyout - required: false - - value: Asset.Other Asset.OtherLongTermAssets - type: String - displayName: Other Long Term Assets - required: false - - value: Asset.Other Asset.SecurityDeposits - type: String - displayName: Security Deposits - required: false - - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets - type: String - displayName: Accumulated Amortization Of Other Assets - required: false - - value: Asset.Other Asset.Goodwill - type: String - displayName: Goodwill - required: false - - value: Asset.Other Asset.Licenses - type: String - displayName: Licenses - required: false - - value: Asset.Other Asset.OrganizationalCosts - type: String - displayName: Organizational Costs - required: false - - value: Asset.Other Asset.AssetsHeldForSale - type: String - displayName: Assets Held For Sale - required: false - - value: Asset.Other Asset.AvailableForSaleFinancialAssets - type: String - displayName: Available For Sale Financial Assets - required: false - - value: Asset.Other Asset.DeferredTax - type: String - displayName: Deferred Tax - required: false - - value: Asset.Other Asset.Investments - type: String - displayName: Investments - required: false - - value: Asset.Other Asset.LongTermInvestments - type: String - displayName: Long Term Investments - required: false - - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties - type: String - displayName: Long Term Loans And Advances To Related Parties - required: false - - value: Asset.Other Asset.OtherIntangibleAssets - type: String - displayName: Other Intangible Assets - required: false - - value: Asset.Other Asset.OtherLongTermInvestments - type: String - displayName: Other Long Term Investments - required: false - - value: Asset.Other Asset.OtherLongTermLoansAndAdvances - type: String - displayName: Other Long Term Loans And Advances - required: false - - value: Asset.Other Asset.PrepaymentsAndAccruedIncome - type: String - displayName: Prepayments And Accrued Income - required: false - - value: Asset.Other Asset.ProvisionsNonCurrentAssets - type: String - displayName: Provisions Non-Current Assets - required: false - - value: Asset.Accounts Receivable.AccountsReceivable - type: String - displayName: Accounts Receivable - required: false - - value: Expense.Expense.AdvertisingPromotional - type: String - displayName: Advertising/Promotional - required: false - - value: Expense.Expense.BadDebts - type: String - displayName: Bad Debts - required: false - - value: Expense.Expense.BankCharges - type: String - displayName: Bank Charges - required: false - - value: Expense.Expense.CharitableContributions - type: String - displayName: Charitable Contributions - required: false - - value: Expense.Expense.CommissionsAndFees - type: String - displayName: Commissions And Fees - required: false - - value: Expense.Expense.Entertainment - type: String - displayName: Entertainment - required: false - - value: Expense.Expense.EntertainmentMeals - type: String - displayName: Entertainment Meals - required: false - - value: Expense.Expense.EquipmentRental - type: String - displayName: Equipment Rental - required: false - - value: Expense.Expense.FinanceCosts - type: String - displayName: Finance Costs - required: false - - value: Expense.Expense.GlobalTaxExpense - type: String - displayName: Global Tax Expense - required: false - - value: Expense.Expense.Insurance - type: String - displayName: Insurance - required: false - - value: Expense.Expense.InterestPaid - type: String - displayName: Interest Paid - required: false - - value: Expense.Expense.LegalProfessionalFees - type: String - displayName: Legal And Professional Fees - required: false - - value: Expense.Expense.OfficeExpenses - type: String - displayName: Office Expenses - required: false - - value: Expense.Expense.OfficeGeneralAdministrativeExpenses - type: String - displayName: Office/General Administrative Expenses - required: false - - value: Expense.Expense.OtherBusinessExpenses - type: String - displayName: Other Business Expenses - required: false - - value: Expense.Expense.OtherMiscellaneousServiceCost - type: String - displayName: Other Miscellaneous Service Cost - required: false - - value: Expense.Expense.PromotionalMeals - type: String - displayName: Promotional Meals - required: false - - value: Expense.Expense.RentOrLeaseOfBuildings - type: String - displayName: Rent Or Lease Of Buildings - required: false - - value: Expense.Expense.RepairMaintenance - type: String - displayName: Repair And Maintenance - required: false - - value: Expense.Expense.ShippingFreightDelivery - type: String - displayName: 'Shipping, Freight And Delivery' - required: false - - value: Expense.Expense.SuppliesMaterials - type: String - displayName: Supplies And Materials - required: false - - value: Expense.Expense.Travel - type: String - displayName: Travel - required: false - - value: Expense.Expense.TravelMeals - type: String - displayName: Travel Meals - required: false - - value: Expense.Expense.Utilities - type: String - displayName: Utilities - required: false - - value: Expense.Expense.Auto - type: String - displayName: Auto - required: false - - value: Expense.Expense.CostOfLabor - type: String - displayName: Cost Of Labor - required: false - - value: Expense.Expense.DuesSubscriptions - type: String - displayName: Dues And Subscriptions - required: false - - value: Expense.Expense.PayrollExpenses - type: String - displayName: Payroll Expenses - required: false - - value: Expense.Expense.TaxesPaid - type: String - displayName: Taxes Paid - required: false - - value: Expense.Expense.UnappliedCashBillPaymentExpense - type: String - displayName: Unapplied Cash Bill Payment Expense - required: false - - value: Expense.Expense.Utilities - type: String - displayName: Utilities - required: false - - value: Expense.Expense.AmortizationExpense - type: String - displayName: Amortization Expense - required: false - - value: Expense.Expense.AppropriationsToDepreciation - type: String - displayName: Appropriations To Depreciation - required: false - - value: Expense.Expense.BorrowingCost - type: String - displayName: Borrowing Cost - required: false - - value: Expense.Expense.CommissionsAndFees - type: String - displayName: Commissions And Fees - required: false - - value: Expense.Expense.DistributionCosts - type: String - displayName: Distribution Costs - required: false - - value: Expense.Expense.ExternalServices - type: String - displayName: External Services - required: false - - value: Expense.Expense.ExtraordinaryCharges - type: String - displayName: Extraordinary Charges - required: false - - value: Expense.Expense.IncomeTaxExpense - type: String - displayName: Income Tax Expense - required: false - - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax - type: String - displayName: Loss On Discontinued Operations Net Of Tax - required: false - - value: Expense.Expense.ManagementCompensation - type: String - displayName: Management Compensation - required: false - - value: Expense.Expense.OtherCurrentOperatingCharges - type: String - displayName: Other Current Operating Charges - required: false - - value: Expense.Expense.OtherExternalServices - type: String - displayName: Other External Services - required: false - - value: Expense.Expense.OtherRentalCosts - type: String - displayName: Other Rental Costs - required: false - - value: Expense.Expense.OtherSellingExpenses - type: String - displayName: Other Selling Expenses - required: false - - value: Expense.Expense.ProjectStudiesSurveysAssessments - type: String - displayName: Project Studies Surveys Assessments - required: false - - value: Expense.Expense.PurchasesRebates - type: String - displayName: Purchases Rebates - required: false - - value: Expense.Expense.ShippingAndDeliveryExpense - type: String - displayName: Shipping And Delivery Expense - required: false - - value: Expense.Expense.StaffCosts - type: String - displayName: Staff Costs - required: false - - value: Expense.Expense.Sundry - type: String - displayName: Sundry - required: false - - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses - type: String - displayName: Travel Expenses General And Admin Expenses - required: false - - value: Expense.Expense.TravelExpensesSellingExpense - type: String - displayName: Travel Expenses Selling Expense - required: false - - value: Expense.Other Expense.Depreciation - type: String - displayName: Depreciation - required: false - - value: Expense.Other Expense.ExchangeGainOrLoss - type: String - displayName: Exchange Gain Or Loss - required: false - - value: Expense.Other Expense.OtherMiscellaneousExpense - type: String - displayName: Other Miscellaneous Expense - required: false - - value: Expense.Other Expense.PenaltiesSettlements - type: String - displayName: Penalties And Settlements - required: false - - value: Expense.Other Expense.Amortization - type: String - displayName: Amortization - required: false - - value: Expense.Other Expense.GasAndFuel - type: String - displayName: Gas And Fuel - required: false - - value: Expense.Other Expense.HomeOffice - type: String - displayName: Home Office - required: false - - value: Expense.Other Expense.HomeOwnerRentalInsurance - type: String - displayName: Home Owner Rental Insurance - required: false - - value: Expense.Other Expense.OtherHomeOfficeExpenses - type: String - displayName: Other Home Office Expenses - required: false - - value: Expense.Other Expense.MortgageInterest - type: String - displayName: Mortgage Interest - required: false - - value: Expense.Other Expense.RentAndLease - type: String - displayName: Rent And Lease - required: false - - value: Expense.Other Expense.RepairsAndMaintenance - type: String - displayName: Repairs And Maintenance - required: false - - value: Expense.Other Expense.ParkingAndTolls - type: String - displayName: Parking And Tolls - required: false - - value: Expense.Other Expense.Vehicle - type: String - displayName: Vehicle - required: false - - value: Expense.Other Expense.VehicleInsurance - type: String - displayName: Vehicle Insurance - required: false - - value: Expense.Other Expense.VehicleLease - type: String - displayName: Vehicle Lease - required: false - - value: Expense.Other Expense.VehicleLoanInterest - type: String - displayName: Vehicle Loan Interest - required: false - - value: Expense.Other Expense.VehicleLoan - type: String - displayName: Vehicle Loan - required: false - - value: Expense.Other Expense.VehicleRegistration - type: String - displayName: Vehicle Registration - required: false - - value: Expense.Other Expense.VehicleRepairs - type: String - displayName: Vehicle Repairs - required: false - - value: Expense.Other Expense.OtherVehicleExpenses - type: String - displayName: Other Vehicle Expenses - required: false - - value: Expense.Other Expense.Utilities - type: String - displayName: Utilities - required: false - - value: Expense.Other Expense.WashAndRoadServices - type: String - displayName: Wash And Road Services - required: false - - value: Expense.Other Expense.DeferredTaxExpense - type: String - displayName: Deferred Tax Expense - required: false - - value: Expense.Other Expense.Depletion - type: String - displayName: Depletion - required: false - - value: Expense.Other Expense.ExceptionalItems - type: String - displayName: Exceptional Items - required: false - - value: Expense.Other Expense.ExtraordinaryItems - type: String - displayName: Extraordinary Items - required: false - - value: Expense.Other Expense.IncomeTaxOtherExpense - type: String - displayName: Income Tax Other Expense - required: false - - value: Expense.Other Expense.MatCredit - type: String - displayName: Mat Credit - required: false - - value: Expense.Other Expense.PriorPeriodItems - type: String - displayName: Prior Period Items - required: false - - value: Expense.Other Expense.TaxRoundoffGainOrLoss - type: String - displayName: Tax Roundoff Gain Or Loss - required: false - - value: Expense.Cost of Goods Sold.EquipmentRentalCos - type: String - displayName: Equipment Rental - COS - required: false - - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos - type: String - displayName: Other Costs Of Sales - COS - required: false - - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos - type: String - displayName: 'Shipping, Freight And Delivery - COS' - required: false - - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs - type: String - displayName: Supplies And Materials - COS - required: false - - value: Expense.Cost of Goods Sold.CostOfLaborCos - type: String - displayName: Cost Of Labor - COS - required: false - - value: Expense.Cost of Goods Sold.CostOfSales - type: String - displayName: Cost Of Sales - required: false - - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost - type: String - displayName: Freight And Delivery Cost - required: false - - value: Income.Income.NonProfitIncome - type: String - displayName: Non Profit Income - required: false - - value: Income.Income.OtherPrimaryIncome - type: String - displayName: Other Primary Income - required: false - - value: Income.Income.SalesOfProductIncome - type: String - displayName: Sales Of ProductIncome - required: false - - value: Income.Income.ServiceFeeIncome - type: String - displayName: Service Fee Income - required: false - - value: Income.Income.DiscountsRefundsGiven - type: String - displayName: Discounts Refunds Given - required: false - - value: Income.Income.UnappliedCashPaymentIncome - type: String - displayName: Unapplied Cash Payment Income - required: false - - value: Income.Income.CashReceiptIncome - type: String - displayName: Cash Receipt Income - required: false - - value: Income.Income.OperatingGrants - type: String - displayName: Operating Grants - required: false - - value: Income.Income.OtherCurrentOperatingIncome - type: String - displayName: Other Current Operating Income - required: false - - value: Income.Income.OwnWorkCapitalized - type: String - displayName: Own Work Capitalized - required: false - - value: Income.Income.RevenueGeneral - type: String - displayName: Revenue General - required: false - - value: Income.Income.SalesRetail - type: String - displayName: Sales Retail - required: false - - value: Income.Income.SalesWholesale - type: String - displayName: Sales Wholesale - required: false - - value: Income.Income.SavingsByTaxScheme - type: String - displayName: Savings By Tax Scheme - required: false - - value: Income.Other Income.DividendIncome - type: String - displayName: Dividend Income - required: false - - value: Income.Other Income.InterestEarned - type: String - displayName: Interest Earned - required: false - - value: Income.Other Income.OtherInvestmentIncome - type: String - displayName: Other Investment Income - required: false - - value: Income.Other Income.OtherMiscellaneousIncome - type: String - displayName: Other Miscellaneous Income - required: false - - value: Income.Other Income.TaxExemptInterest - type: String - displayName: Tax Exempt Interest - required: false - - value: Income.Other Income.GainLossOnSaleOfFixedAssets - type: String - displayName: Gain Loss On Sale Of Fixed Assets - required: false - - value: Income.Other Income.GainLossOnSaleOfInvestments - type: String - displayName: Gain Loss On Sale Of Investments - required: false - - value: Income.Other Income.LossOnDisposalOfAssets - type: String - displayName: Loss On Disposal Of Assets - required: false - - value: Income.Other Income.OtherOperatingIncome - type: String - displayName: Other Operating Income - required: false - - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax - type: String - displayName: Unrealised Loss On Securities Net Of Tax - required: false - - value: Liability.Accounts Payable.AccountsPayable - type: String - displayName: Accounts Payable - required: false - - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise - type: String - displayName: Outstanding Dues Micro Small Enterprise - required: false - - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise - type: String - displayName: Outstanding Dues Other Than Micro Small Enterprise - required: false - - value: Liability.Credit Card.CreditCard - type: String - displayName: Credit Card - required: false - - value: Liability.Long Term Liability.NotesPayable - type: String - displayName: Notes Payable - required: false - - value: Liability.Long Term Liability.OtherLongTermLiabilities - type: String - displayName: Other Long Term Liabilities - required: false - - value: Liability.Long Term Liability.ShareholderNotesPayable - type: String - displayName: Shareholder Notes Payable - required: false - - value: Liability.Long Term Liability.AccrualsAndDeferredIncome - type: String - displayName: Accruals And Deferred Income - required: false - - value: Liability.Long Term Liability.AccruedLongLermLiabilities - type: String - displayName: Accrued Long Lerm Liabilities - required: false - - value: Liability.Long Term Liability.AccruedVacationPayable - type: String - displayName: Accrued Vacation Payable - required: false - - value: Liability.Long Term Liability.BankLoans - type: String - displayName: Bank Loans - required: false - - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests - type: String - displayName: Debts Related To Participating Interests - required: false - - value: Liability.Long Term Liability.DeferredTaxLiabilities - type: String - displayName: Deferred Tax Liabilities - required: false - - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities - type: String - displayName: Government And Other Public Authorities - required: false - - value: Liability.Long Term Liability.GroupAndAssociates - type: String - displayName: Group And Associates - required: false - - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale - type: String - displayName: Liabilities Related To Assets Held For Sale - required: false - - value: Liability.Long Term Liability.LongTermBorrowings - type: String - displayName: Long Term Borrowings - required: false - - value: Liability.Long Term Liability.LongTermDebit - type: String - displayName: Long Term Debit - required: false - - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations - type: String - displayName: Long Term Employee Benefit Obligations - required: false - - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases - type: String - displayName: Obligations Under Finance Leases - required: false - - value: Liability.Long Term Liability.OtherLongTermProvisions - type: String - displayName: Other Long Term Provisions - required: false - - value: Liability.Long Term Liability.ProvisionForLiabilities - type: String - displayName: Provision For Liabilities - required: false - - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities - type: String - displayName: Provisions Non Current Liabilities - required: false - - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts - type: String - displayName: Staff And Related Long Term Liability Accounts - required: false - - value: Liability.Other Current Liability.DirectDepositPayable - type: String - displayName: Direct Deposit Payable - required: false - - value: Liability.Other Current Liability.LineOfCredit - type: String - displayName: Line Of Credit - required: false - - value: Liability.Other Current Liability.LoanPayable - type: String - displayName: Loan Payable - required: false - - value: Liability.Other Current Liability.GlobalTaxPayable - type: String - displayName: Global Tax Payable - required: false - - value: Liability.Other Current Liability.GlobalTaxSuspense - type: String - displayName: Global Tax Suspense - required: false - - value: Liability.Other Current Liability.OtherCurrentLiabilities - type: String - displayName: Other Current Liabilities - required: false - - value: Liability.Other Current Liability.PayrollClearing - type: String - displayName: Payroll Clearing - required: false - - value: Liability.Other Current Liability.PayrollTaxPayable - type: String - displayName: Payroll Tax Payable - required: false - - value: Liability.Other Current Liability.PrepaidExpensesPayable - type: String - displayName: Prepaid Expenses Payable - required: false - - value: Liability.Other Current Liability.RentsInTrustLiability - type: String - displayName: Rents In Trust Liability - required: false - - value: Liability.Other Current Liability.TrustAccountsLiabilities - type: String - displayName: Trust Accounts Liabilities - required: false - - value: Liability.Other Current Liability.FederalIncomeTaxPayable - type: String - displayName: Federal Income Tax Payable - required: false - - value: Liability.Other Current Liability.InsurancePayable - type: String - displayName: Insurance Payable - required: false - - value: Liability.Other Current Liability.SalesTaxPayable - type: String - displayName: Sales Tax Payable - required: false - - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable - type: String - displayName: State Local Income Tax Payable - required: false - - value: Liability.Other Current Liability.AccruedLiabilities - type: String - displayName: Accrued Liabilities - required: false - - value: Liability.Other Current Liability.CurrentLiabilities - type: String - displayName: Current Liabilities - required: false - - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations - type: String - displayName: Current Portion EmployeeBenefits Obligations - required: false - - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases - type: String - displayName: Current Portion Of Obligations Under Finance Leases - required: false - - value: Liability.Other Current Liability.CurrentTaxLiability - type: String - displayName: Current Tax Liability - required: false - - value: Liability.Other Current Liability.DividendsPayable - type: String - displayName: Dividends Payable - required: false - - value: Liability.Other Current Liability.DutiesAndTaxes - type: String - displayName: Duties And Taxes - required: false - - value: Liability.Other Current Liability.InterestPayables - type: String - displayName: Interest Payables - required: false - - value: Liability.Other Current Liability.ProvisionForWarrantyObligations - type: String - displayName: Provision For Warranty Obligations - required: false - - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities - type: String - displayName: Provisions Current Liabilities - required: false - - value: Liability.Other Current Liability.ShortTermBorrowings - type: String - displayName: Short Term Borrowings - required: false - - value: Liability.Other Current Liability.SocialSecurityAgencies - type: String - displayName: Social Security Agencies - required: false - - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts - type: String - displayName: Staff And Related Liability Accounts - required: false - - value: Liability.Other Current Liability.SundryDebtorsAndCreditors - type: String - displayName: Sundry Debtors And Creditors - required: false - - value: Liability.Other Current Liability.TradeAndOtherPayables - type: String - displayName: Trade And Other Payables - required: false - - value: Equity.Equity.OpeningBalanceEquity - type: String - displayName: Opening Balance Equity - required: false - - value: Equity.Equity.PartnersEquity - type: String - displayName: Partners Equity - required: false - - value: Equity.Equity.RetainedEarnings - type: String - displayName: Retained Earnings - required: false - - value: Equity.Equity.AccumulatedAdjustment - type: String - displayName: Accumulated Adjustment - required: false - - value: Equity.Equity.OwnersEquity - type: String - displayName: Owners Equity - required: false - - value: Equity.Equity.PaidInCapitalOrSurplus - type: String - displayName: Paid In Capital Or Surplus - required: false - - value: Equity.Equity.PartnerContributions - type: String - displayName: Partner Contributions - required: false - - value: Equity.Equity.PartnerDistributions - type: String - displayName: Partner Distributions - required: false - - value: Equity.Equity.PreferredStock - type: String - displayName: Preferred Stock - required: false - - value: Equity.Equity.CommonStock - type: String - displayName: Common Stock - required: false - - value: Equity.Equity.TreasuryStock - type: String - displayName: Treasury Stock - required: false - - value: Equity.Equity.EstimatedTaxes - type: String - displayName: Estimated Taxes - required: false - - value: Equity.Equity.Healthcare - type: String - displayName: Healthcare - required: false - - value: Equity.Equity.PersonalIncome - type: String - displayName: Personal Income - required: false - - value: Equity.Equity.PersonalExpense - type: String - displayName: Personal Expense - required: false - - value: Equity.Equity.AccumulatedOtherComprehensiveIncome - type: String - displayName: Accumulated Other Comprehensive Income - required: false - - value: Equity.Equity.CalledUpShareCapital - type: String - displayName: Called Up Share Capital - required: false - - value: Equity.Equity.CapitalReserves - type: String - displayName: Capital Reserves - required: false - - value: Equity.Equity.DividendDisbursed - type: String - displayName: Dividend Disbursed - required: false - - value: Equity.Equity.EquityInEarningsOfSubsiduaries - type: String - displayName: Equity In Earnings Of Subsiduaries - required: false - - value: Equity.Equity.InvestmentGrants - type: String - displayName: Investment Grants - required: false - - value: Equity.Equity.MoneyReceivedAgainstShareWarrants - type: String - displayName: Money Received Against Share Warrants - required: false - - value: Equity.Equity.OtherFreeReserves - type: String - displayName: Other Free Reserves - required: false - - value: Equity.Equity.ShareApplicationMoneyPendingAllotment - type: String - displayName: Share Application Money Pending Allotment - required: false - - value: Equity.Equity.ShareCapital - type: String - displayName: Share Capital - required: false - - value: Equity.Equity.Funds - type: String - displayName: Funds - required: false - required: true - required: true - Sage Business Cloud Accounting: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - name: - type: String - displayName: Name - description: Name of the account - required: true - validation: - warnings: [] - information: - - field: Name - details: Should not be longer than 200 characters. - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - validation: - warnings: [] - information: - - field: NominalCode - details: Should be a number between 1 and 99999999. - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - options: - - value: SALES - type: String - displayName: Sales - required: false - - value: OTHER_INCOME - type: String - displayName: Other Income - required: false - - value: DIRECT_EXPENSES - type: String - displayName: Direct Expenses - required: false - - value: OVERHEADS - type: String - displayName: Overheads - required: false - - value: DEPRECIATION - type: String - displayName: Depreciation - required: false - - value: CURRENT_ASSETS - type: String - displayName: Current Assets - required: false - - value: FIXED_ASSETS - type: String - displayName: Fixed Assets - required: false - - value: FUTURE_ASSETS - type: String - displayName: Future Assets - required: false - - value: BANK - type: String - displayName: Bank - required: false - - value: CURRENT_LIABILITY - type: String - displayName: Current Liability - required: false - - value: FUTURE_LIABILITY - type: String - displayName: Future Liability - required: false - - value: EQUITY - type: String - displayName: Equity - required: false - - value: LINE_OF_CREDIT - type: String - displayName: Credit Card / Loan - required: false - required: true - required: true - Sage Intacct: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - validation: - warnings: - - field: NominalCode - details: Must be unique within the entity. - - field: NominalCode - details: 'Must be at most 24 characters in length, although restrictions may vary between entities.' - information: [] - name: - type: String - displayName: Name - description: Name of the account - required: true - status: - type: String - displayName: Account Status - description: The status of the account - options: - - value: Active - type: String - displayName: Active - required: false - - value: Archived - type: String - displayName: Archived - required: false - required: true - type: - type: String - displayName: Account Type - description: 'The type, or base category, of the account' - options: - - value: Asset - type: String - displayName: Asset - required: false - - value: Equity - type: String - displayName: Equity - required: false - - value: Expense - type: String - displayName: Expense - required: false - - value: Income - type: String - displayName: Income - required: false - - value: Liability - type: String - displayName: Liability - required: false - required: true - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - required: true - validation: - warnings: [] - information: - - field: FullyQualifiedCategory - details: 'Any category that is part of the hierarchy of one of: ''Assets'', ''Equity'', ''Liabilities'', ''Total Expenses'' and ''Total Income'' is permitted.' - required: true - Sandbox: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: true - name: - type: String - displayName: Name - description: Name of the account - required: true - description: - type: String - displayName: Description - description: Description of the account - required: true - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: The full category of the account e.g. Liability.Current or Income.Revenue - required: true - fullyQualifiedName: - type: String - displayName: Fully Qualified Name - description: The full name of the account e.g. Liability.Current.VAT or Income.Revenue.Sales - required: true - currency: - type: String - displayName: Currency - description: The currency of the account - required: true - currentBalance: - type: Number - displayName: Current Balance - description: The current balance in the account - required: true - type: - type: String - displayName: Account Type - description: 'The type, or base category, of the account' - required: true - status: - type: String - displayName: Account Status - description: The status of the account - required: true - isBankAccount: - type: Boolean - displayName: Is Bank Account? - description: Confirms whether the nominal account represents a bank account or not - required: true - validDatatypeLinks: - type: Array - displayName: Valid Datatype Links - description: Describes which fields on other data types are valid links to this account in the originating system - properties: - property: - type: String - displayName: Property - description: The field on the source data type that other data types can link to - required: true - links: - type: Array - displayName: Links - description: 'A collection of absolute names of fields from other data types, e.g. Invoice.LineItems.AccountRef.Id' - required: true - required: true - metadata: - type: Object - displayName: Metadata - description: Miscellaneous data about the item - properties: - isDeleted: - type: Boolean - displayName: IsDeleted - description: A boolean to indicate whether the object has been deleted - required: true - required: true - required: true - Xero: - value: - type: Object - displayName: Nominal Account - description: Nominal Accounts are the categories a business uses to record transactions - properties: - nominalCode: - type: String - displayName: Nominal Code - description: Identifier for the nominal account. - required: true - validation: - warnings: - - field: NominalCode - details: Max length of 10 characters. - information: [] - name: - type: String - displayName: Name - description: Name of account as it appears in the chart of accounts or general ledger. - required: true - validation: - warnings: [] - information: - - field: Name - details: Payments are enabled to this account if the name ends in .PaymentsEnabled. - description: - type: String - displayName: Description - description: Description for the nominal account. - required: false - fullyQualifiedCategory: - type: String - displayName: Fully Qualified Category - description: Account type and category for nominal account. - options: - - value: Asset.Current - type: String - displayName: Current Asset - required: false - - value: Asset.Fixed - type: String - displayName: Fixed Asset - required: false - - value: Asset.Inventory - type: String - displayName: Inventory - required: false - - value: Asset.NonCurrent - type: String - displayName: Non-current Asset - required: false - - value: Asset.Prepayment - type: String - displayName: Prepayment - required: false - - value: Expense.DirectCosts - type: String - displayName: Direct Costs - required: false - - value: Expense.Expense - type: String - displayName: Expense - required: false - - value: Expense.Overhead - type: String - displayName: Overhead - required: false - - value: Expense.Superannuation - type: String - displayName: Superannuation - required: false - - value: Expense.Wages - type: String - displayName: Wages - required: false - - value: Income.Sales - type: String - displayName: Sales - required: false - - value: Income.Revenue - type: String - displayName: Revenue - required: false - - value: Income.Other - type: String - displayName: Other Income - required: false - - value: Liability.Current - type: String - displayName: Current Liability - required: false - - value: Liability.Depreciation - type: String - displayName: Depreciation - required: false - - value: Liability.Liability - type: String - displayName: Liability - required: false - - value: Liability.NonCurrent - type: String - displayName: Non Current Liability - required: false - - value: Liability.PayAsYouGo - type: String - displayName: Pay As You Go Liability - required: false - - value: Liability.Superannuation - type: String - displayName: Superannuation Liability - required: false - - value: Liability.WagesPayable - type: String - displayName: Wages Payable Liability - required: false - - value: Equity.Equity - type: String - displayName: Equity - required: false - required: true - required: true - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - operationId: get-create-chartOfAccounts-model - description: |- - The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) for a given company and integration. - - [Accounts](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) are the categories a business uses to record accounting transactions. - - **Integration-specific behaviour** - - See the *response examples* for integration-specific indicative models. - '/companies/{companyId}/connections/{connectionId}/push/bankAccounts': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - post: - tags: - - Bank accounts - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - - $ref: '#/components/parameters/allowSyncOnPushComplete' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BankAccount' - examples: - QuickBooks Online: - value: - accountName: GBP Bank Account - accountType: Debit - accountNumber: '12345678' - currency: GBP - status: Active - Xero: - value: - accountName: Xero GBP Bank Account - accountType: Debit - sortCode: '445566' - accountNumber: '12345678' - currency: GBP - status: Active - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateBankAccountResponse' - examples: {} - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - summary: Create bank account - description: "The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/sync-for-expenses-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/sync-for-expenses-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-expenses-api#/operations/get-create-update-bankAccounts-model)." - operationId: create-bank-account - '/companies/{companyId}/connections/{connectionId}/options/bankAccounts': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - get: - summary: Get create 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-expenses-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/sync-for-expenses-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" - '/companies/{companyId}/data/customers': - parameters: - - $ref: '#/components/parameters/companyId' - get: - tags: - - Customers - summary: List customers - parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' - - $ref: '#/components/parameters/query' - - $ref: '#/components/parameters/orderBy' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/Customers' - examples: - Clear Books: - value: - results: - - id: c8180244-74ac-40cf-a5df-6d83661c44d7 - customerName: Arjun Kuvalis - contactName: Werner Langworth - emailAddress: Arjun34@hotmail.com - defaultCurrency: GBP - phone: 014605 64820 - addresses: - - type: Delivery - line1: Suite 214 - line2: 8439 Lueilwitz Passage - city: Fernandohaven - region: Northern Ireland - country: United Kingdom - postalCode: JG04 7PV - - type: Delivery - line1: Suite 096 - line2: 864 Halie Course - city: Juliochester - region: England - country: United Kingdom - postalCode: DZ8 4BF - - type: Delivery - line1: Suite 001 - line2: 416 Stokes Fords - city: Naderborough - region: Wales - country: United Kingdom - postalCode: XG25 0XX - contacts: - - name: Werner Langworth - email: Werner_Langworth@hotmail.com - phone: [] - address: - type: Delivery - line1: Apt. 145 - line2: 317 Williamson Freeway - city: Hortenseville - region: Scotland - country: United Kingdom - postalCode: CV4 2HR - status: Active - - name: Belle Glover - email: Belle51@yahoo.com - phone: [] - address: - type: Delivery - line1: Suite 075 - line2: 9921 Dickens Walk - city: South Ali - region: Scotland - country: United Kingdom - postalCode: TI04 4OO - status: Active - registrationNumber: NI7JEJVM - taxNumber: '7505220209.583549' - status: Active - modifiedDate: '2023-04-26T12:38:16Z' - sourceModifiedDate: '2022-07-03T01:27:00' - metadata: - isDeleted: false - - id: 6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0 - customerName: 'Breitenberg, Emard and Schiller' - contactName: Miguel Hahn - emailAddress: contact@BreitenbergEmardandSchiller.biz - defaultCurrency: GBP - phone: 0800 445 6957 - addresses: - - type: Billing - line1: Apt. 184 - line2: 60578 Louie Springs - city: East Khalid - region: Wales - country: United Kingdom - postalCode: XW89 7NT - contacts: - - name: Miguel Hahn - email: Miguel.Hahn@gmail.com - phone: - - number: 018555 09614 - type: Landline - address: - type: Delivery - line1: Suite 400 - line2: 21930 Milan Lane - city: Reingerton - region: Wales - country: United Kingdom - postalCode: QG10 2DL - status: Active - registrationNumber: KME0AMIL - taxNumber: '8560920952.553111' - status: Archived - modifiedDate: '2023-04-26T12:38:16Z' - sourceModifiedDate: '2022-12-03T11:05:01' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 20 - _links: - current: - href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=1&pageSize=2 - self: - href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers - next: - href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=2&pageSize=2 - Dynamics 365 Business Central: - value: - results: - - id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 - customerName: '' - contactName: '' - emailAddress: '' - defaultCurrency: GBP - phone: '' - addresses: - - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: '' - postalCode: '' - contacts: - - name: '' - email: '' - phone: [] - address: - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: '' - postalCode: '' - status: Active - taxNumber: '' - status: Active - modifiedDate: '2023-03-27T14:21:25Z' - sourceModifiedDate: '2023-01-17T14:50:54Z' - metadata: - isDeleted: false - - id: 0ef95175-48c4-eb11-9f0a-0022481b4343 - customerName: '' - contactName: '' - emailAddress: '' - defaultCurrency: GBP - phone: '' - addresses: - - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: GB - postalCode: '' - contacts: - - name: '' - email: '' - phone: [] - address: - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: GB - postalCode: '' - status: Active - taxNumber: '' - status: Active - modifiedDate: '2023-03-27T14:21:25Z' - sourceModifiedDate: '2021-06-03T08:48:36Z' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 42 - _links: - current: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=1&pageSize=2 - self: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers - next: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=2&pageSize=2 - Exact (Netherlands): - value: - results: - - id: 555f8251-c65a-433a-a813-5dbe04321d1e - customerName: Ab Netherlands - defaultCurrency: EUR - addresses: - - type: Billing - country: NL - contacts: [] - status: Active - modifiedDate: '2022-10-26T13:32:05Z' - sourceModifiedDate: '2021-06-14T15:26:37Z' - - id: 9fd1f78e-67aa-4af7-8a10-df1fc5fb5841 - customerName: anna test 2 - defaultCurrency: EUR - addresses: - - type: Billing - country: NL - contacts: [] - status: Active - modifiedDate: '2022-10-26T13:32:05Z' - sourceModifiedDate: '2022-05-24T11:53:21Z' - pageNumber: 1 - pageSize: 2 - totalResults: 71 - _links: - current: - href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=1&pageSize=2 - self: - href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers - next: - href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=2&pageSize=2 - Exact (UK): - value: - results: - - id: 5f20075a-a28e-434d-81a6-2db0dc170e87 - customerName: Abdi 99 - emailAddress: email@codat.io - defaultCurrency: GBP - addresses: - - type: Billing - line1: Ink Rooms - city: London - country: GB - postalCode: WC1X 0BE - contacts: [] - registrationNumber: '123456789' - taxNumber: GB339 0727 47 - status: Active - modifiedDate: '2022-10-26T13:33:08Z' - sourceModifiedDate: '2020-02-26T11:23:50Z' - - id: 1d9dc1a7-92d6-441b-93fd-42c9fb321b1c - customerName: Abdulbasit Al-haj - contactName: abeee - emailAddress: a.alhaj@codat.io - defaultCurrency: GBP - addresses: - - type: Billing - country: GB - contacts: - - name: abeee - phone: [] - address: - type: Unknown - line1: '' - country: 'GB ' - status: Active - modifiedDate: '2020-02-24T12:00:51.027Z' - status: Active - modifiedDate: '2022-10-26T13:33:08Z' - sourceModifiedDate: '2020-02-24T12:00:50Z' - pageNumber: 1 - pageSize: 2 - totalResults: 53 - _links: - current: - href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=1&pageSize=2 - self: - href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers - next: - href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=2&pageSize=2 - FreeAgent: - value: - results: - - id: '11526230' - customerName: '-' - contactName: Test 1 - addresses: - - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - contacts: - - name: Test 1 - phone: [] - address: - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - status: Unknown - status: Active - modifiedDate: '2023-04-25T14:19:12Z' - sourceModifiedDate: '2023-04-17T06:02:46Z' - metadata: - isDeleted: false - - id: '9677150' - customerName: '-' - contactName: Test 1 - addresses: - - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - contacts: - - name: Test 1 - phone: [] - address: - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - status: Unknown - status: Active - modifiedDate: '2023-04-25T14:19:12Z' - sourceModifiedDate: '2023-04-24T06:19:23Z' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 159 - _links: - current: - href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=1&pageSize=2 - self: - href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers - next: - href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=2&pageSize=2 - FreshBooks: - value: - results: - - id: '634509' - customerName: A test customer 14 (updated) - contactName: test person name - emailAddress: test14@example.com - defaultCurrency: GBP - phone: 01876 541245 - addresses: - - type: Billing - line1: Line 1 - line2: Line 2 - city: Some city - region: A region - country: Country 1 - postalCode: SW1 2JQ - contacts: - - name: test person1 - email: test14A@example.com - phone: - - number: '24681012' - type: Primary - - number: '121086420' - type: Unknown - status: Active - - name: test person2 - email: test14B@example.com - phone: - - number: 1234 56789 - type: Primary - - number: 9876 54321 - type: Unknown - status: Active - - name: test person name - email: test14@example.com - phone: - - number: 01876 541245 - type: Unknown - status: Active - status: Active - modifiedDate: '2023-03-24T16:07:23Z' - sourceModifiedDate: '2022-05-18T09:23:56' - metadata: - isDeleted: false - - id: '634486' - customerName: A test customer name 2 - contactName: test person name - emailAddress: test8@example.com - defaultCurrency: GBP - phone: 01876 541245 - addresses: - - type: Billing - line1: Line 1 - line2: Line 2 - city: Some city - region: A region - country: Country 1 - postalCode: SW1 2JQ - contacts: - - name: test person1 - email: test9@example.com - phone: - - number: '24681012' - type: Primary - - number: '121086420' - type: Unknown - status: Active - - name: test person2 - email: test10@example.com - phone: - - number: '123456789' - type: Primary - - number: '987654321' - type: Unknown - status: Active - - name: test person name - email: test8@example.com - phone: - - number: 01876 541245 - type: Unknown - status: Active - status: Active - modifiedDate: '2023-03-24T16:07:23Z' - sourceModifiedDate: '2022-05-11T11:39:58' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 39 - _links: - current: - href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=1&pageSize=2 - self: - href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers - next: - href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=2&pageSize=2 - KashFlow: - value: - results: - - id: '92227673' - customerName: Chekko Customer Test 01 - contactName: '' - emailAddress: '' - phone: '' - addresses: [] - contacts: - - name: '' - email: '' - phone: [] - status: Active - taxNumber: '' - status: Active - modifiedDate: '2022-09-30T10:29:15Z' - sourceModifiedDate: '0001-01-01T00:00:00' - - id: '88459410' - customerName: Diogo Sousa - contactName: Mr Diogo Sousa - emailAddress: diogomail@mail.com - phone: '123123123' - addresses: - - type: Billing - line1: Billing Address - line2: Billing line 2 Billing line 3 - city: Billing line 4 - country: United Kingdom - postalCode: '123321' - - type: Delivery - line1: Delivery Address - line2: Delivery line2 Delivery line3 - city: Delivery line4 - country: United Kingdom - postalCode: '123321' - contacts: - - name: Mr Diogo Sousa - email: diogomail@mail.com - phone: - - number: '123123123' - type: Landline - - number: '321321321' - type: Mobile - address: - type: Billing - line1: Billing Address - line2: Billing line 2 Billing line 3 - city: Billing line 4 - country: United Kingdom - postalCode: '123321' - status: Active - - name: Mr Diogo Sousa - phone: [] - address: - type: Delivery - line1: Delivery Address - line2: Delivery line2 Delivery line3 - city: Delivery line4 - country: United Kingdom - postalCode: '123321' - status: Active - taxNumber: '' - status: Active - modifiedDate: '2022-09-30T10:29:15Z' - sourceModifiedDate: '2021-05-04T13:22:19' - pageNumber: 1 - pageSize: 2 - totalResults: 10 - _links: - current: - href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=1&pageSize=2 - self: - href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers - next: - href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=2&pageSize=2 - Oracle NetSuite: - value: - results: - - id: '773' - customerName: 119 Test Customer - contactName: Mr Test Customer - defaultCurrency: GBP - addresses: [] - contacts: [] - status: Active - modifiedDate: '2023-01-30T14:48:02Z' - sourceModifiedDate: '2022-01-11T12:28:49' - - id: '172722' - customerName: 1248 European Company - contactName: European Company - defaultCurrency: GBP - addresses: [] - contacts: [] - status: Active - modifiedDate: '2023-01-30T14:48:02Z' - sourceModifiedDate: '2022-07-27T14:29:16' - pageNumber: 1 - pageSize: 2 - totalResults: 4 - _links: - current: - href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=1&pageSize=2 - self: - href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers - next: - href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=2&pageSize=2 - QuickBooks Desktop: - value: - results: - - id: 150000-933272658 - customerName: 'Abercrombie, Kristy' - contactName: Kristy Abercrombie - emailAddress: kristy@samplename.com - defaultCurrency: GBP - phone: 415-555-6579 - addresses: - - type: Delivery - line1: Kristy Abercrombie - line2: 5647 Cypress Hill Rd - city: Bayshore - region: CA - postalCode: '94326' - - type: Billing - line1: Kristy Abercrombie - line2: 5647 Cypress Hill Rd - city: Bayshore - region: CA - postalCode: '94326' - contacts: - - name: 'Abercrombie, Kristy' - email: kristy@samplename.com - phone: - - number: 415-555-6579 - type: Primary - status: Active - - name: Kristy Abercrombie - phone: [] - status: Active - - name: Steve Darcangelo - phone: [] - status: Active - status: Active - modifiedDate: '2023-04-26T09:07:55Z' - sourceModifiedDate: '2023-12-16T05:06:42' - metadata: - isDeleted: false - - id: 800000D0-1182061376 - customerName: 'Allard, Robert' - contactName: Amanda Roberts - emailAddress: rallard@myemail.com - defaultCurrency: GBP - phone: 650-555-3422 - addresses: - - type: Delivery - line1: Robert Allard - line2: 92834 Chandler St. - city: Millbrae - region: CA - postalCode: '94030' - - type: Billing - line1: Robert Allard - line2: 92834 Chandler St. - city: Millbrae - region: CA - postalCode: '94030' - contacts: - - name: 'Allard, Robert' - email: rallard@myemail.com - phone: - - number: 650-555-3422 - type: Primary - - number: 650-555-9804 - type: Fax - - number: 650-555-8349 - type: Unknown - status: Active - - name: Robert Allard - phone: [] - status: Active - - name: Rachel Fisher - phone: [] - status: Active - status: Active - modifiedDate: '2023-04-26T09:07:55Z' - sourceModifiedDate: '2023-12-16T05:06:42' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 64 - _links: - current: - href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=1&pageSize=2 - self: - href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers - next: - href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=2&pageSize=2 - QuickBooks Online: - value: - results: - - id: '9' - customerName: Abe - contactName: Abraham's Company - emailAddress: ab@email.com - defaultCurrency: GBP - addresses: [] - contacts: - - name: Abe - email: ab@email.com - phone: - - number: '01111111111' - type: Mobile - status: Active - registrationNumber: XXXX9900001 - taxNumber: XXXX9900001 - status: Active - modifiedDate: '2023-01-18T11:02:35Z' - sourceModifiedDate: '2022-12-08T15:42:59Z' - - id: '49' - customerName: adeel qbo child test - contactName: Adeel test - emailAddress: adeel@adeel.com - defaultCurrency: GBP - phone: '123456789' - addresses: - - type: Billing - line1: 4 Privet Drive - city: London - country: United Kingdom - postalCode: WD25 7LR - - type: Delivery - line1: 4 Privet Drive - city: London - country: United Kingdom - postalCode: WD25 7LR - contacts: - - name: Adeel test - email: adeel@adeel.com - phone: - - number: '123456789' - type: Primary - - number: '07546543216' - type: Mobile - address: - type: Billing - line1: 4 Privet Drive - city: London - country: United Kingdom - postalCode: WD25 7LR - status: Active - status: Active - modifiedDate: '2023-01-18T11:02:35Z' - sourceModifiedDate: '2022-08-22T09:21:09Z' - pageNumber: 1 - pageSize: 2 - totalResults: 40 - _links: - current: - href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=1&pageSize=2 - self: - href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers - next: - href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=2&pageSize=2 - QuickBooks Online Sandbox: - value: - results: - - id: '66' - customerName: Abercrombie International Group - contactName: Kristy Abercrombie - defaultCurrency: GBP - addresses: - - type: Billing - line1: 123 Main St - city: 'New York, NY' - contacts: - - name: Abercrombie International Group (deleted) - phone: [] - address: - type: Billing - line1: 123 Main St - city: 'New York, NY' - status: Archived - status: Archived - modifiedDate: '2023-04-26T09:35:56Z' - sourceModifiedDate: '2016-09-12T18:53:19Z' - metadata: - isDeleted: false - - id: '67' - customerName: Abercrombie International Group - contactName: Natalie Watts - emailAddress: n.watts@google.com - defaultCurrency: USD - addresses: - - type: Billing - - type: Delivery - contacts: - - name: Abercrombie International Group - email: n.watts@google.com - phone: [] - address: - type: Billing - status: Active - registrationNumber: XXXXVat123456 - taxNumber: XXXXVat123456 - status: Active - modifiedDate: '2023-04-26T09:35:56Z' - sourceModifiedDate: '2023-03-29T01:12:55Z' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 243 - _links: - current: - href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=1&pageSize=2 - self: - href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers - next: - href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=2&pageSize=2 - Sage 200cloud: - value: - results: - - id: A1D001 - customerName: A1 Design Services - contactName: Lee Dalkin - emailAddress: newbusinessadvice@sage.com - defaultCurrency: GBP - phone: 01742 876 234 - addresses: - - type: Delivery - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: '' - postalCode: BP12 7HT - - type: Delivery - line1: 23a Union Street - line2: '' - city: Manchester - region: '' - country: '' - postalCode: M2 6JK - - type: Billing - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: Great Britain - postalCode: BP12 7HT - contacts: - - name: Lee Dalkin - email: newbusinessadvice@sage.com - phone: - - number: 01742 876 234 - type: Landline - - number: 01742 876 235 - type: Landline - - number: 01742 876 236 - type: Fax - status: Active - - name: Malcolm Leverret - email: '' - phone: [] - status: Active - - name: Jim Thomas - email: Jim@a1designservices.co.uk - phone: - - number: 01742 876 234 - type: Landline - - number: 01742 876 235 - type: Fax - status: Active - - name: Jullian Plawsworth - email: Jullian@a1designservices.co.uk - phone: - - number: 0151 349 3939 - type: Landline - - number: 0151 349 3940 - type: Fax - status: Active - registrationNumber: '' - taxNumber: GB238 3839 38 - status: Active - modifiedDate: '2022-10-14T09:35:53Z' - sourceModifiedDate: '2022-04-27T15:17:36Z' - - id: A1D002 - customerName: A2 Design Services - contactName: Lee Dalkin - emailAddress: newbusinessadvice@sage.com - defaultCurrency: GBP - phone: 01742 876 234 - addresses: - - type: Billing - line1: 77a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: Great Britain - postalCode: BP12 7HT - contacts: - - name: Lee Dalkin - email: newbusinessadvice@sage.com - phone: - - number: 01742 876 234 - type: Landline - - number: 01742 876 235 - type: Landline - - number: 01742 876 236 - type: Fax - status: Active - - name: Malcolm Leverret - email: '' - phone: [] - status: Active - - name: Jim Thomas - email: Jim@a1designservices.co.uk - phone: - - number: 01742 876 234 - type: Landline - - number: 01742 876 235 - type: Fax - status: Active - - name: Jullian Plawsworth - email: Jullian@a1designservices.co.uk - phone: - - number: 0151 349 3939 - type: Landline - - number: 0151 349 3940 - type: Fax - status: Active - registrationNumber: '' - taxNumber: GB238 3839 40 - status: Active - modifiedDate: '2022-10-14T09:35:53Z' - sourceModifiedDate: '2020-09-23T10:28:58Z' - pageNumber: 1 - pageSize: 2 - totalResults: 43 - _links: - current: - href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=1&pageSize=2 - self: - href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers - next: - href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=2&pageSize=2 - Sage 50 (UK): - value: - results: - - id: A1D001 - customerName: A1 Design Services - contactName: Ian Cairns - emailAddress: newbusinessadvice@sage.com - defaultCurrency: GBP - phone: 01742 876 234 - addresses: - - type: Delivery - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: GB - postalCode: BP12 7HT - - type: Delivery - line1: 23a Union Street - line2: '' - city: Manchester - region: '' - country: GB - postalCode: M2 6JK - - type: Unknown - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: GB - postalCode: BP12 7HT - contacts: [] - taxNumber: GB238 3839 38 - status: Active - modifiedDate: '2023-03-30T14:42:41Z' - sourceModifiedDate: '2022-11-25T09:43:54Z' - metadata: - isDeleted: false - - id: ABS001 - customerName: ABS Garages Ltd - contactName: Mike Hall - emailAddress: newbusinessadvice@sage.com - defaultCurrency: GBP - phone: 0191 254 5909 - addresses: - - type: Delivery - line1: Swanson Industries - line2: Dukes Industrial Estate - city: Whitley Bay - region: North Tyneside - country: GB - postalCode: NE56 4ER - - type: Delivery - line1: Unit 34 - line2: Holystone Ind Estate - city: Hebburn - region: Tyne & Wear - country: GB - postalCode: NE31 1VB - - type: Unknown - line1: Unit 34 - line2: Holystone Ind Estate - city: Hebburn - region: Tyne & Wear - country: GB - postalCode: NE31 1VB - contacts: [] - taxNumber: GB745 4584 68 - status: Active - modifiedDate: '2023-03-30T14:42:41Z' - sourceModifiedDate: '2022-11-25T09:43:54Z' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 30 - _links: - current: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=1&pageSize=2 - self: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers - next: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=2&pageSize=2 - Sage Business Cloud Accounting: - value: - results: - - id: 260f6a3f94a243738f2d5e08496a41a8 - customerName: 100 test name - contactName: Main Contact - emailAddress: email@codat.io - defaultCurrency: GBP - phone: contact phone number - addresses: - - type: Billing - line1: Aruba Address line 1 - line2: Aruba Address line 2 - city: Aruba City - region: Aruba Province - country: Aruba (AW) - postalCode: Aruba Post - contacts: - - phone: - - number: contact mobile number - type: Mobile - - number: contact fax number - type: Fax - status: Unknown - status: Active - modifiedDate: '2022-10-24T14:52:54Z' - sourceModifiedDate: '2021-05-10T16:31:51Z' - - id: 44a5d9461d9e4f6d90a5ace251c5cf35 - customerName: 100 test name DS - contactName: Main Contact - emailAddress: DCemail@codat.io - defaultCurrency: GBP - phone: contact phone number - addresses: - - type: Billing - line1: POST - Aruba Address line 1 - line2: POST - Aruba Address line 2 - city: POST - Aruba City - region: Aruba Province - country: Aruba (AW) - postalCode: Aruba Post - contacts: [] - status: Active - modifiedDate: '2022-10-24T14:52:54Z' - sourceModifiedDate: '2021-06-10T14:22:46Z' - pageNumber: 1 - pageSize: 2 - totalResults: 168 - _links: - current: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=1&pageSize=2 - self: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers - next: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=2&pageSize=2 - Sage Intacct: - value: - results: - - id: '188' - customerName: 33Across - contactName: Yuna Conn - defaultCurrency: USD - phone: 520-393-4468 - addresses: - - type: Unknown - line1: 155 Westend Point - line2: '' - city: Albuquerque - region: NM - country: United States - postalCode: '87140' - contacts: - - name: 'Conn, Yuna' - phone: - - number: 520-393-4468 - type: Primary - address: - type: Unknown - line1: 155 Westend Point - line2: '' - city: Albuquerque - region: NM - country: United States - postalCode: '87140' - status: Unknown - taxNumber: '' - status: Active - modifiedDate: '2023-04-04T16:32:21Z' - sourceModifiedDate: '2022-09-06T12:58:27' - metadata: - isDeleted: false - - id: '324' - customerName: 3Way International Logistics - contactName: Lauri O'Heagertie - defaultCurrency: CAD - phone: 410-309-3976 - addresses: - - type: Unknown - line1: 7 Lerdahl Junction - line2: '' - city: Sparwood - region: British Columbia - country: Canada - postalCode: L4R - contacts: - - name: 'O''Heagertie, Lauri' - phone: - - number: 410-309-3976 - type: Primary - address: - type: Unknown - line1: 7 Lerdahl Junction - line2: '' - city: Sparwood - region: British Columbia - country: Canada - postalCode: L4R - status: Unknown - taxNumber: '' - status: Active - modifiedDate: '2023-04-04T16:32:21Z' - sourceModifiedDate: '2020-10-20T05:01:49' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 530 - _links: - current: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=1&pageSize=2 - self: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers - next: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=2&pageSize=2 - Wave: - value: - results: - - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 - customerName: ABC Textiles - contactName: '' - emailAddress: c.taylor@codat.io - defaultCurrency: USD - addresses: [] - contacts: [] - status: Active - modifiedDate: '2022-11-16T18:15:30Z' - sourceModifiedDate: '2019-10-17T07:59:04Z' - - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM3MTUzNDI2 - customerName: Coffee Cart - contactName: Coffee Carl - emailAddress: coffee.cart@example.com - defaultCurrency: GBP - phone: '0201111' - addresses: - - type: Billing - line1: 11 Coffee Lane - line2: Coffee Town - city: Coffee City - region: Hampshire - country: United Kingdom - postalCode: CC1 1CC - contacts: - - name: Coffee Carl - phone: - - number: '07733' - type: Mobile - status: Active - status: Active - modifiedDate: '2022-11-16T18:15:30Z' - sourceModifiedDate: '2020-03-17T19:12:39Z' - pageNumber: 1 - pageSize: 2 - totalResults: 10 - _links: - current: - href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=1&pageSize=2 - self: - href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers - next: - href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=2&pageSize=2 - Xero: - value: - results: - - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 - customerName: 24 Locks - emailAddress: '' - addresses: [] - contacts: [] - status: Active - modifiedDate: '2023-03-15T20:35:10Z' - sourceModifiedDate: '2023-02-17T18:03:42' - metadata: - isDeleted: false - - id: bab779bc-c5fb-42cb-a888-953e8309711c - customerName: 7-Eleven - emailAddress: '' - addresses: [] - contacts: [] - status: Active - modifiedDate: '2023-03-15T20:35:10Z' - sourceModifiedDate: '2023-02-17T18:03:42' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 48 - _links: - current: - href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=1&pageSize=2 - self: - href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers - next: - href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=2&pageSize=2 - Zoho Books: - value: - results: - - id: '104957000000032105' - customerName: A B - contactName: Contact (First Name) Contact (Last Name) - emailAddress: contactperson@whateveryouwantidontcare12345.com - defaultCurrency: GBP - phone: Work Phone - addresses: [] - contacts: - - name: Contact (First Name) Contact (Last Name) - email: contactperson@whateveryouwantidontcare12345.com - phone: - - number: Work Phone - type: Landline - - number: Mobile - type: Mobile - status: Active - status: Active - modifiedDate: '2022-10-03T08:40:37Z' - sourceModifiedDate: '2022-06-09T14:36:47' - - id: '104957000000054050' - customerName: 'Doe, John' - contactName: John Doe - emailAddress: '' - defaultCurrency: GBP - addresses: [] - contacts: - - name: John Doe - email: '' - phone: [] - status: Active - status: Active - modifiedDate: '2022-10-03T08:40:37Z' - sourceModifiedDate: '2022-09-28T15:09:22' - pageNumber: 1 - pageSize: 2 - totalResults: 14 - _links: - current: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=1&pageSize=2 - self: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers - next: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=2&pageSize=2 - '400': - $ref: '#/components/responses/Malformed-Query' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '409': - $ref: '#/components/responses/Conflict' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - description: "The *List customers* endpoint returns a list of [customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data).\n " - operationId: list-customers - '/companies/{companyId}/data/customers/{customerId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/customerId' - get: - tags: - - Customers - summary: Get customer - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/Customer' - examples: - Clear Books: - value: - id: c8180244-74ac-40cf-a5df-6d83661c44d7 - customerName: Arjun Kuvalis - contactName: Werner Langworth - emailAddress: Arjun34@hotmail.com - defaultCurrency: GBP - phone: 014605 64820 - addresses: - - type: Delivery - line1: Suite 214 - line2: 8439 Lueilwitz Passage - city: Fernandohaven - region: Northern Ireland - country: United Kingdom - postalCode: JG04 7PV - - type: Delivery - line1: Suite 096 - line2: 864 Halie Course - city: Juliochester - region: England - country: United Kingdom - postalCode: DZ8 4BF - - type: Delivery - line1: Suite 001 - line2: 416 Stokes Fords - city: Naderborough - region: Wales - country: United Kingdom - postalCode: XG25 0XX - contacts: - - name: Werner Langworth - email: Werner_Langworth@hotmail.com - phone: [] - address: - type: Delivery - line1: Apt. 145 - line2: 317 Williamson Freeway - city: Hortenseville - region: Scotland - country: United Kingdom - postalCode: CV4 2HR - status: Active - - name: Belle Glover - email: Belle51@yahoo.com - phone: [] - address: - type: Delivery - line1: Suite 075 - line2: 9921 Dickens Walk - city: South Ali - region: Scotland - country: United Kingdom - postalCode: TI04 4OO - status: Active - registrationNumber: NI7JEJVM - taxNumber: '7505220209.583549' - status: Active - modifiedDate: '2023-04-26T12:38:16Z' - sourceModifiedDate: '2022-07-03T01:27:00' - metadata: - isDeleted: false - Dynamics 365 Business Central: - value: - id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 - customerName: '' - contactName: '' - emailAddress: '' - defaultCurrency: GBP - phone: '' - addresses: - - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: '' - postalCode: '' - contacts: - - name: '' - email: '' - phone: [] - address: - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: '' - postalCode: '' - status: Active - taxNumber: '' - status: Active - modifiedDate: '2023-03-27T14:21:25Z' - sourceModifiedDate: '2023-01-17T14:50:54Z' - metadata: - isDeleted: false - Exact (Netherlands): - value: - id: 555f8251-c65a-433a-a813-5dbe04321d1e - customerName: Ab Netherlands - defaultCurrency: EUR - addresses: - - type: Billing - country: NL - contacts: [] - status: Active - modifiedDate: '2022-10-26T13:32:05Z' - sourceModifiedDate: '2021-06-14T15:26:37Z' - Exact (UK): - value: - id: 5f20075a-a28e-434d-81a6-2db0dc170e87 - customerName: Abdi 99 - emailAddress: email@codat.io - defaultCurrency: GBP - addresses: - - type: Billing - line1: Ink Rooms - city: London - country: GB - postalCode: WC1X 0BE - contacts: [] - registrationNumber: '123456789' - taxNumber: GB339 0727 47 - status: Active - modifiedDate: '2022-10-26T13:33:08Z' - sourceModifiedDate: '2020-02-26T11:23:50Z' - FreeAgent: - value: - id: '11526230' - customerName: '-' - contactName: Test 1 - addresses: - - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - contacts: - - name: Test 1 - phone: [] - address: - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - status: Unknown - status: Active - modifiedDate: '2023-04-25T14:19:12Z' - sourceModifiedDate: '2023-04-17T06:02:46Z' - metadata: - isDeleted: false - FreshBooks: - value: - id: '634509' - customerName: A test customer 14 (updated) - contactName: test person name - emailAddress: test14@example.com - defaultCurrency: GBP - phone: 01876 541245 - addresses: - - type: Billing - line1: Line 1 - line2: Line 2 - city: Some city - region: A region - country: Country 1 - postalCode: SW1 2JQ - contacts: - - name: test person1 - email: test14A@example.com - phone: - - number: '24681012' - type: Primary - - number: '121086420' - type: Unknown - status: Active - - name: test person2 - email: test14B@example.com - phone: - - number: '123456789' - type: Primary - - number: '987654321' - type: Unknown - status: Active - - name: test person name - email: test14@example.com - phone: - - number: 01876 541245 - type: Unknown - status: Active - status: Active - modifiedDate: '2023-03-24T16:07:23Z' - sourceModifiedDate: '2022-05-18T09:23:56' - metadata: - isDeleted: false - KashFlow: - value: - id: '92227673' - customerName: Chekko Customer Test 01 - contactName: '' - emailAddress: '' - phone: '' - addresses: [] - contacts: - - name: '' - email: '' - phone: [] - status: Active - taxNumber: '' - status: Active - modifiedDate: '2022-09-30T10:29:15Z' - sourceModifiedDate: '0001-01-01T00:00:00' - Oracle NetSuite: - value: - id: '773' - customerName: 119 Test Customer - contactName: Mr Test Customer - defaultCurrency: GBP - addresses: [] - contacts: [] - status: Active - modifiedDate: '2023-01-30T14:48:02Z' - sourceModifiedDate: '2022-01-11T12:28:49' - QuickBooks Desktop: - value: - id: 150000-933272658 - customerName: 'Abercrombie, Kristy' - contactName: Kristy Abercrombie - emailAddress: kristy@samplename.com - defaultCurrency: GBP - phone: 415-555-6579 - addresses: - - type: Delivery - line1: Kristy Abercrombie - line2: 5647 Cypress Hill Rd - city: Bayshore - region: CA - postalCode: '94326' - - type: Billing - line1: Kristy Abercrombie - line2: 5647 Cypress Hill Rd - city: Bayshore - region: CA - postalCode: '94326' - contacts: - - name: 'Abercrombie, Kristy' - email: kristy@samplename.com - phone: - - number: 415-555-6579 - type: Primary - status: Active - - name: Kristy Abercrombie - phone: [] - status: Active - - name: Steve Darcangelo - phone: [] - status: Active - status: Active - modifiedDate: '2023-04-26T09:07:55Z' - sourceModifiedDate: '2023-12-16T05:06:42' - metadata: - isDeleted: false - QuickBooks Online: - value: - id: '9' - customerName: Abe - contactName: Abraham's Company - emailAddress: ab@email.com - defaultCurrency: GBP - addresses: [] - contacts: - - name: Abe - email: ab@email.com - phone: - - number: '01111111111' - type: Mobile - status: Active - registrationNumber: XXXX9900001 - taxNumber: XXXX9900001 - status: Active - modifiedDate: '2023-01-18T11:02:35Z' - sourceModifiedDate: '2022-12-08T15:42:59Z' - QuickBooks Online Sandbox: - value: - id: '66' - customerName: Abercrombie International Group - contactName: Kristy Abercrombie - defaultCurrency: GBP - addresses: - - type: Billing - line1: 123 Main St - city: 'New York, NY' - contacts: - - name: Abercrombie International Group (deleted) - phone: [] - address: - type: Billing - line1: 123 Main St - city: 'New York, NY' - status: Archived - status: Archived - modifiedDate: '2023-04-26T09:35:56Z' - sourceModifiedDate: '2016-09-12T18:53:19Z' - metadata: - isDeleted: false - Sage 200cloud: - value: - id: A1D001 - customerName: A1 Design Services - contactName: Lee Dalkin - emailAddress: newbusinessadvice@sage.com - defaultCurrency: GBP - phone: 01742 876 234 - addresses: - - type: Delivery - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: '' - postalCode: BP12 7HT - - type: Delivery - line1: 23a Union Street - line2: '' - city: Manchester - region: '' - country: '' - postalCode: M2 6JK - - type: Billing - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: Great Britain - postalCode: BP12 7HT - contacts: - - name: Lee Dalkin - email: newbusinessadvice@sage.com - phone: - - number: 01742 876 234 - type: Landline - - number: 01742 876 235 - type: Landline - - number: 01742 876 236 - type: Fax - status: Active - - name: Malcolm Leverret - email: '' - phone: [] - status: Active - - name: Jim Thomas - email: Jim@a1designservices.co.uk - phone: - - number: 01742 876 234 - type: Landline - - number: 01742 876 235 - type: Fax - status: Active - - name: Jullian Plawsworth - email: Jullian@a1designservices.co.uk - phone: - - number: 0151 349 3939 - type: Landline - - number: 0151 349 3940 - type: Fax - status: Active - registrationNumber: '' - taxNumber: GB238 3839 38 - status: Active - modifiedDate: '2022-10-14T09:35:53Z' - sourceModifiedDate: '2022-04-27T15:17:36Z' - Sage 50 (UK): - value: - id: A1D001 - customerName: A1 Design Services - contactName: Ian Cairns - emailAddress: newbusinessadvice@sage.com - defaultCurrency: GBP - phone: 01742 876 234 - addresses: - - type: Delivery - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: GB - postalCode: BP12 7HT - - type: Delivery - line1: 23a Union Street - line2: '' - city: Manchester - region: '' - country: GB - postalCode: M2 6JK - - type: Unknown - line1: 67a Station Road - line2: '' - city: Blackpool - region: Lancashire - country: GB - postalCode: BP12 7HT - contacts: [] - taxNumber: GB238 3839 38 - status: Active - modifiedDate: '2023-03-30T14:42:41Z' - sourceModifiedDate: '2022-11-25T09:43:54Z' - metadata: - isDeleted: false - Sage Business Cloud Accounting: - value: - id: 260f6a3f94a243738f2d5e08496a41a8 - customerName: 100 test name - contactName: Main Contact - emailAddress: email@codat.io - defaultCurrency: GBP - phone: contact phone number - addresses: - - type: Billing - line1: Aruba Address line 1 - line2: Aruba Address line 2 - city: Aruba City - region: Aruba Province - country: Aruba (AW) - postalCode: Aruba Post - contacts: - - phone: - - number: contact mobile number - type: Mobile - - number: contact fax number - type: Fax - status: Unknown - status: Active - modifiedDate: '2022-10-24T14:52:54Z' - sourceModifiedDate: '2021-05-10T16:31:51Z' - Sage Intacct: - value: - id: '188' - customerName: 33Across - contactName: Yuna Conn - defaultCurrency: USD - phone: 520-393-4468 - addresses: - - type: Unknown - line1: 155 Westend Point - line2: '' - city: Albuquerque - region: NM - country: United States - postalCode: '87140' - contacts: - - name: 'Conn, Yuna' - phone: - - number: 520-393-4468 - type: Primary - address: - type: Unknown - line1: 155 Westend Point - line2: '' - city: Albuquerque - region: NM - country: United States - postalCode: '87140' - status: Unknown - taxNumber: '' - status: Active - modifiedDate: '2023-04-04T16:32:21Z' - sourceModifiedDate: '2022-09-06T12:58:27' - metadata: - isDeleted: false - Wave: - value: - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 - customerName: ABC Textiles - contactName: '' - emailAddress: c.taylor@codat.io - defaultCurrency: USD - addresses: [] - contacts: [] - status: Active - modifiedDate: '2022-11-16T18:15:30Z' - sourceModifiedDate: '2019-10-17T07:59:04Z' - Xero: - value: - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 - customerName: 24 Locks - emailAddress: '' - addresses: [] - contacts: [] - status: Active - modifiedDate: '2023-03-15T20:35:10Z' - sourceModifiedDate: '2023-02-17T18:03:42' - metadata: - isDeleted: false - Zoho Books: - value: - id: '104957000000032105' - customerName: A B - contactName: Contact (First Name) Contact (Last Name) - emailAddress: contactperson@whateveryouwantidontcare12345.com - defaultCurrency: GBP - phone: Work Phone - addresses: [] - contacts: - - name: Contact (First Name) Contact (Last Name) - email: contactperson@whateveryouwantidontcare12345.com - phone: - - number: Work Phone - type: Landline - - number: Mobile - type: Mobile - status: Active - status: Active - modifiedDate: '2022-10-03T08:40:37Z' - sourceModifiedDate: '2022-06-09T14:36:47' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '409': - $ref: '#/components/responses/Conflict' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - description: | - The *Get customer* endpoint returns a single customer for a given customerId. - - [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. - - Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). - operationId: get-customer - '/companies/{companyId}/connections/{connectionId}/push/customers': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - post: - tags: - - Customers - summary: Create customer - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - - $ref: '#/components/parameters/allowSyncOnPushComplete' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Customer' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateCustomerResponse' - examples: {} - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - operationId: create-customer - description: |- - The *Create customer* endpoint creates a new [customer](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) for a given company's connection. - - [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. - - **Integration-specific behaviour** - - Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). - '/companies/{companyId}/connections/{connectionId}/push/customers/{customerId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/customerId' - put: - tags: - - Customers - summary: Update customer - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - - $ref: '#/components/parameters/allowSyncOnPushComplete' - - $ref: '#/components/parameters/forceUpdate' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Customer' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateCustomerResponse' - examples: {} - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - description: |- - The *Update customer* endpoint updates an existing [customer](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) for a given company's connection. - - [Customers](https://docs.codat.io/sync-for-expenses-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. - - **Integration-specific behaviour** - - Required data may vary by integration. To see what data to post, first call [Get create/update customer model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-customers-model). - operationId: update-customer - '/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-expenses-api#/schemas/Supplier) for a given company's connection.\n\n[Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data).\n " - operationId: list-suppliers - '/companies/{companyId}/data/suppliers/{supplierId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/supplierId' - get: - tags: - - Suppliers - summary: Get supplier - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/Supplier' - examples: - Clear Books: - value: - id: owQ2Gqgj9f - supplierName: Abshire - Kshlerin - contactName: Faye Hansen - emailAddress: hello@Abshire-Kshlerin.info - phone: 01338 858162 - addresses: - - type: Delivery - line1: Suite 431 - line2: 289 Giles Lake - city: Cesarmouth - region: Northern Ireland - country: United Kingdom - postalCode: BG40 9GP - registrationNumber: VYL1XZXR - taxNumber: '1396267523.0914588' - status: Active - modifiedDate: '2023-04-26T12:38:17Z' - sourceModifiedDate: '1660-11-28T23:18:00' - defaultCurrency: GBP - metadata: - isDeleted: false - Dynamics 365 Business Central: - value: - id: 78623f13-931e-eb11-bbf8-0022481b3585 - supplierName: '' - contactName: '' - emailAddress: '' - phone: '' - addresses: - - type: Billing - line1: '' - line2: '' - city: '' - region: '' - country: GB - postalCode: '' - taxNumber: '' - status: Active - modifiedDate: '2023-03-27T14:21:12Z' - sourceModifiedDate: '2020-11-04T11:44:22Z' - defaultCurrency: GBP - metadata: - isDeleted: false - Exact (Netherlands): - value: - id: 3150917c-1d92-4d77-9018-31b5c4758ca9 - supplierName: Abe - contactName: Kelly's Contact Name - emailAddress: sales@kellysupplies.com - phone: 07999 999999 - addresses: - - type: Billing - line1: Unit 51 - city: Bakersfield - region: California - country: US - postalCode: '933081' - registrationNumber: '8409314368' - status: Active - modifiedDate: '2022-10-26T13:32:05Z' - sourceModifiedDate: '2022-07-15T12:01:15Z' - defaultCurrency: EUR - Exact (UK): - value: - id: 0185fea2-0298-445b-909a-0db685118a9e - supplierName: a - addresses: - - type: Billing - country: GB - status: Active - modifiedDate: '2022-10-26T13:33:13Z' - sourceModifiedDate: '2017-08-02T10:58:54Z' - defaultCurrency: GBP - FreeAgent: - value: - id: '11526230' - supplierName: '-' - contactName: Test 1 - addresses: - - type: Billing - line1: 1 Place House - line2: '' - city: London - country: United Kingdom - postalCode: WC1X 1AH - status: Active - modifiedDate: '2023-04-25T14:19:08Z' - sourceModifiedDate: '2023-04-17T06:02:46' - metadata: - isDeleted: false - FreshBooks: - value: - id: api vendor - supplierName: api vendor - addresses: [] - status: Active - modifiedDate: '2023-03-24T16:07:25Z' - metadata: - isDeleted: false - KashFlow: - value: - id: '6202387' - supplierName: Dell - contactName: '' - emailAddress: '' - phone: '' - addresses: [] - taxNumber: '' - status: Unknown - modifiedDate: '2022-09-30T10:29:15Z' - sourceModifiedDate: '2017-05-09T00:00:00' - Oracle NetSuite: - value: - id: '779' - supplierName: Test Vendor - contactName: Test Vendor - emailAddress: '' - phone: '' - addresses: [] - status: Active - modifiedDate: '2023-01-30T14:47:02Z' - sourceModifiedDate: '2022-02-04T14:24:43' - defaultCurrency: GBP - QuickBooks Desktop: - value: - id: A60000-1197760912 - supplierName: A Cheung Limited - contactName: Angela Cheung - emailAddress: AC@CheungLimited.com - phone: 510 555 5723 - addresses: - - type: Billing - line1: 'A Cheung Limited, Angela Cheung' - line2: 3818 Bear Rd. West - city: Berkeley - region: CA - postalCode: '94688' - status: Active - modifiedDate: '2023-04-26T09:09:03Z' - sourceModifiedDate: '2023-12-16T05:06:44' - defaultCurrency: GBP - metadata: - isDeleted: false - QuickBooks Online: - value: - id: '41' - supplierName: AI Support - contactName: AI Support - addresses: - - type: Billing - line1: test - region: string - country: Djibouti - status: Active - modifiedDate: '2023-01-18T11:02:36Z' - sourceModifiedDate: '2022-12-07T10:48:18Z' - defaultCurrency: GBP - QuickBooks Online Sandbox: - value: - id: '129' - supplierName: Ally Johnson - contactName: Miss Smith - phone: 0728 38474 - addresses: - - type: Billing - line1: 100 London Road - line2: Angel - city: London - region: Greater London - country: England - postalCode: EC1M - status: Active - modifiedDate: '2023-04-26T09:35:55Z' - sourceModifiedDate: '2023-04-13T01:51:08Z' - defaultCurrency: GBP - metadata: - isDeleted: false - Sage 200cloud: - value: - id: '776' - supplierName: Aaren - contactName: '' - emailAddress: '' - phone: '' - addresses: - - type: Unknown - line1: '' - line2: '' - city: '' - region: '' - country: Great Britain - postalCode: '' - taxNumber: '' - status: Archived - modifiedDate: '2022-10-14T09:35:58Z' - defaultCurrency: GBP - metadata: - isDeleted: true - Sage 50 (UK): - value: - id: CON001 - supplierName: Concept Stationery Supplies - contactName: Mark Ramsay - emailAddress: newbusinessadvice@sage.com - phone: 0191 643 4343 - addresses: - - type: Delivery - line1: 66 New Street - line2: Ridgeway - city: Newcastle Upon Tyne - region: '' - country: GB - postalCode: NE1 4GF - - type: Unknown - line1: 66 New Street - line2: Ridgeway - city: Newcastle upon Tyne - region: '' - country: GB - postalCode: NE1 4GF - taxNumber: GB988 3453 23 - status: Active - modifiedDate: '2023-03-30T14:42:38Z' - sourceModifiedDate: '2022-11-25T09:43:54Z' - defaultCurrency: GBP - metadata: - isDeleted: false - Sage Business Cloud Accounting: - value: - id: 65179671e9ef424caff8b9006cd111c8 - supplierName: 5555 Abdul's Test Name - contactName: Main Contact - addresses: - - type: Billing - country: United Kingdom (GB) - status: Active - modifiedDate: '2022-10-24T14:52:54Z' - sourceModifiedDate: '2020-02-25T17:23:33Z' - defaultCurrency: GBP - Sage Intacct: - value: - id: '3' - supplierName: ADP - contactName: 'Jones, William' - phone: 214-760-9491 - addresses: - - type: Unknown - line1: 208 S Akard St - line2: '' - city: Dallas - region: TX - country: United States - postalCode: '75265' - registrationNumber: '' - taxNumber: 85-3678274 - status: Active - modifiedDate: '2023-04-04T16:32:20Z' - sourceModifiedDate: '2023-02-16T09:48:27' - defaultCurrency: USD - metadata: - isDeleted: false - Wave: - value: - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 - supplierName: Computer Shop - contactName: '' - emailAddress: '' - addresses: [] - status: Active - modifiedDate: '2022-11-16T18:15:24Z' - sourceModifiedDate: '2020-04-07T13:28:02Z' - defaultCurrency: GBP - Xero: - value: - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 - supplierName: 24 Locks - emailAddress: '' - addresses: [] - status: Active - modifiedDate: '2023-03-15T20:36:09Z' - sourceModifiedDate: '2023-02-17T18:03:42' - metadata: - isDeleted: false - Zoho Books: - value: - id: '104957000001494001' - supplierName: Acme Corporation - emailAddress: '' - addresses: [] - status: Active - modifiedDate: '2022-10-03T08:40:37Z' - sourceModifiedDate: '2022-09-16T13:09:56' - defaultCurrency: GBP - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '409': - $ref: '#/components/responses/Conflict' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - description: | - The *Get supplier* endpoint returns a single supplier for a given supplierId. - - [Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. - - Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-expenses-api#/operations/refresh-company-data). - operationId: get-supplier - '/companies/{companyId}/connections/{connectionId}/push/suppliers': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - post: - tags: - - Suppliers - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - - $ref: '#/components/parameters/allowSyncOnPushComplete' - 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-expenses-api#/schemas/Supplier) for a given company's connection.\r\n\r\n[Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n\r\n**Integration-specific behaviour**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model).\r\n" - operationId: create-supplier - '/companies/{companyId}/connections/{connectionId}/push/suppliers/{supplierId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/supplierId' - put: - tags: - - Suppliers - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - - $ref: '#/components/parameters/allowSyncOnPushComplete' - - $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-expenses-api#/schemas/Supplier) for a given company's connection.\r\n\r\n[Suppliers](https://docs.codat.io/sync-for-expenses-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\r\n\r\n**Integration-specific behaviour**\r\n\r\nRequired data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/sync-for-expenses-api#/operations/get-create-update-suppliers-model)." - operationId: update-supplier -webhooks: - expenses.sync.successful: - post: - description: Called when an expense sync successfully completes without any errors or warnings. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExpensesSyncWebhook' - examples: - Successful: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: expenses.sync.successful - generatedDate: '2024-09-01T00:00:00Z' - payload: - referenceCompany: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: Toft stores - description: Syncing expenses - syncId: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd - transactions: - - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 - status: Completed - errorMessage: null - - id: e7f8a3d5-0c3c-4c9b-b5d3-56b4a43b62e4 - status: Completed - errorMessage: null - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - expenses.sync.unsuccessful: - post: - description: 'Called when an expense sync fails to complete successfully, resulting in at least one error or warning.' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExpensesSyncWebhook' - examples: - Unsuccessful: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: expenses.sync.unsuccessful - generatedDate: '2024-09-01T00:00:00Z' - payload: - referenceCompany: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: Toft stores - description: Syncing expenses - syncId: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd - transactions: - - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 - status: Completed - errorMessage: null - - id: e7f8a3d5-0c3c-4c9b-b5d3-56b4a43b62e4 - status: Failed - errorMessage: Insufficient funds - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - SyncCompleted: - post: - deprecated: true - description: |- - Triggered anytime an expense sync completes. Used for Sync for Expenses only. - - > This event type is deprecated. Use the `expenses.sync.successful` to get notified when an expense sync completes successfully. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SyncCompleteWebhook' - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - SyncFailed: - post: - deprecated: true - description: |- - Indicates a failure occurred during an expense sync. Used for Sync for Expenses only. - - > This event type is deprecated. Use the `expenses.sync.unsuccessful` to get notified when an expense sync completes unsuccessfully. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SyncFailedWebhook' - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - 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. \n\n**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' + 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. components: schemas: - Account: - title: 'Accounting: Account' - description: "\uFEFF\x3E\x20\x2A\x2A\x4C\x61\x6E\x67\x75\x61\x67\x65\x20\x74\x69\x70\x3A\x2A\x2A\x20\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x72\x65\x20\x61\x6C\x73\x6F\x20\x72\x65\x66\x65\x72\x72\x65\x64\x20\x74\x6F\x20\x61\x73\x20\x2A\x2A\x63\x68\x61\x72\x74\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2A\x2A\x2C\x20\x2A\x2A\x6E\x6F\x6D\x69\x6E\x61\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2A\x2A\x2C\x20\x61\x6E\x64\x20\x2A\x2A\x67\x65\x6E\x65\x72\x61\x6C\x20\x6C\x65\x64\x67\x65\x72\x2A\x2A\x2E\n\n\x23\x23\x20\x4F\x76\x65\x72\x76\x69\x65\x77\n\n\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x72\x65\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x75\x73\x65\x73\x20\x74\x6F\x20\x72\x65\x63\x6F\x72\x64\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x2E\x20\x46\x72\x6F\x6D\x20\x74\x68\x65\x20\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x73\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x72\x65\x74\x72\x69\x65\x76\x65\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x6C\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x66\x6F\x72\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\n\n\x54\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x66\x6F\x72\x20\x61\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x63\x6C\x75\x64\x65\x3A\n\x2A\x20\x41\x73\x73\x65\x74\n\x2A\x20\x45\x78\x70\x65\x6E\x73\x65\n\x2A\x20\x49\x6E\x63\x6F\x6D\x65\n\x2A\x20\x4C\x69\x61\x62\x69\x6C\x69\x74\x79\n\x2A\x20\x45\x71\x75\x69\x74\x79\x2E\n\n\x54\x68\x65\x20\x73\x61\x6D\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x79\x20\x68\x61\x76\x65\x20\x61\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x20\x62\x61\x73\x65\x64\x20\x6F\x6E\x20\x74\x68\x65\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x69\x74\x20\x69\x73\x20\x75\x73\x65\x64\x20\x69\x6E\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x63\x75\x72\x72\x65\x6E\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x28\x6B\x6E\x6F\x77\x6E\x20\x61\x73\x20\x63\x68\x65\x63\x6B\x69\x6E\x67\x20\x69\x6E\x20\x74\x68\x65\x20\x55\x53\x29\x20\x73\x68\x6F\x75\x6C\x64\x20\x62\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x7A\x65\x64\x20\x61\x73\x20\x60\x41\x73\x73\x65\x74\x2E\x43\x75\x72\x72\x65\x6E\x74\x60\x20\x66\x6F\x72\x20\x58\x65\x72\x6F\x2C\x20\x61\x6E\x64\x20\x60\x41\x73\x73\x65\x74\x2E\x42\x61\x6E\x6B\x2E\x43\x68\x65\x63\x6B\x69\x6E\x67\x60\x20\x66\x6F\x72\x20\x51\x75\x69\x63\x6B\x42\x6F\x6F\x6B\x73\x20\x4F\x6E\x6C\x69\x6E\x65\x2E\n\n\x41\x74\x20\x74\x68\x65\x20\x73\x61\x6D\x65\x20\x74\x69\x6D\x65\x2C\x20\x65\x61\x63\x68\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x6D\x61\x79\x20\x68\x61\x76\x65\x20\x69\x74\x73\x20\x6F\x77\x6E\x20\x72\x65\x71\x75\x69\x72\x65\x6D\x65\x6E\x74\x73\x20\x74\x6F\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x50\x61\x79\x70\x61\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x20\x58\x65\x72\x6F\x20\x69\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x60\x41\x73\x73\x65\x74\x2E\x42\x61\x6E\x6B\x60\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x20\x61\x6E\x64\x20\x74\x68\x65\x72\x65\x66\x6F\x72\x65\x20\x72\x65\x71\x75\x69\x72\x65\x73\x20\x61\x64\x64\x69\x74\x69\x6F\x6E\x61\x6C\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x20\x74\x6F\x20\x62\x65\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x2E\n\n\x54\x6F\x20\x64\x65\x74\x65\x72\x6D\x69\x6E\x65\x20\x74\x68\x65\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x6C\x6C\x6F\x77\x65\x64\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x66\x6F\x72\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x3A\n\x2D\x20\x46\x6F\x6C\x6C\x6F\x77\x20\x6F\x75\x72\x20\x5B\x43\x72\x65\x61\x74\x65\x2C\x20\x75\x70\x64\x61\x74\x65\x2C\x20\x64\x65\x6C\x65\x74\x65\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x75\x73\x69\x6E\x67\x2D\x74\x68\x65\x2D\x61\x70\x69\x2F\x70\x75\x73\x68\x29\x20\x67\x75\x69\x64\x65\x20\x61\x6E\x64\x20\x75\x73\x65\x20\x74\x68\x65\x20\x5B\x47\x65\x74\x20\x63\x72\x65\x61\x74\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x6F\x64\x65\x6C\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x73\x2F\x67\x65\x74\x2D\x63\x72\x65\x61\x74\x65\x2D\x63\x68\x61\x72\x74\x4F\x66\x41\x63\x63\x6F\x75\x6E\x74\x73\x2D\x6D\x6F\x64\x65\x6C\x29\x2E\n\x2D\x20\x52\x65\x66\x65\x72\x20\x74\x6F\x20\x74\x68\x65\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x27\x73\x20\x6F\x77\x6E\x20\x64\x6F\x63\x75\x6D\x65\x6E\x74\x61\x74\x69\x6F\x6E\x2E\n\n\x3E\x20\x2A\x2A\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x77\x69\x74\x68\x20\x6E\x6F\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x2A\x2A\n\x3E\n\x3E\x20\x49\x66\x20\x61\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x73\x20\x70\x75\x6C\x6C\x65\x64\x20\x66\x72\x6F\x6D\x20\x74\x68\x65\x20\x63\x68\x61\x72\x74\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x69\x74\x73\x20\x6E\x6F\x6D\x69\x6E\x61\x6C\x20\x63\x6F\x64\x65\x20\x64\x6F\x65\x73\x20\x6E\x6F\x74\x20\x6C\x69\x65\x20\x77\x69\x74\x68\x69\x6E\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x20\x6C\x61\x79\x6F\x75\x74\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x74\x68\x65\x6E\x20\x74\x68\x65\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x69\x73\x20\x60\x55\x6E\x6B\x6E\x6F\x77\x6E\x60\x2E\x20\x54\x68\x65\x20\x2A\x2A\x66\x75\x6C\x6C\x79\x51\x75\x61\x6C\x69\x66\x69\x65\x64\x43\x61\x74\x65\x67\x6F\x72\x79\x2A\x2A\x20\x61\x6E\x64\x20\x2A\x2A\x66\x75\x6C\x6C\x79\x51\x75\x61\x6C\x69\x66\x69\x65\x64\x4E\x61\x6D\x65\x2A\x2A\x20\x66\x69\x65\x6C\x64\x73\x20\x72\x65\x74\x75\x72\x6E\x20\x60\x6E\x75\x6C\x6C\x60\x2E\n\x3E\n\x3E\x20\x54\x68\x69\x73\x20\x61\x70\x70\x72\x6F\x61\x63\x68\x20\x67\x69\x76\x65\x73\x20\x61\x20\x74\x72\x75\x65\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x77\x68\x69\x6C\x73\x74\x20\x70\x72\x65\x76\x65\x6E\x74\x69\x6E\x67\x20\x64\x69\x73\x74\x6F\x72\x74\x69\x6E\x67\x20\x66\x69\x6E\x61\x6E\x63\x69\x61\x6C\x73\x20\x73\x75\x63\x68\x20\x61\x73\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x70\x72\x6F\x66\x69\x74\x20\x61\x6E\x64\x20\x6C\x6F\x73\x73\x20\x61\x6E\x64\x20\x62\x61\x6C\x61\x6E\x63\x65\x20\x73\x68\x65\x65\x74\x20\x72\x65\x70\x6F\x72\x74\x73\x2E" + Address: + title: Address + x-internal: true + type: object + properties: + type: + $ref: '#/components/schemas/Address/definitions/addressType' + 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''s address. For NetSuite, use the 2-digit [ISO 3166](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code.' + postalCode: + type: string + nullable: true + description: Postal code or zip code. + definitions: + addressType: + description: The type of the address + type: string + enum: + - Unknown + - Billing + - Delivery + Attachment: + title: Attachment metadata + description: " The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes.\n\n > **Retrieving attachments**\n > \n > If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data.\n\n Unlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments.\n\n Note that different integrations have different requirements for file size and extension of attachments.\n\n | Integration | File size | File extension |\n |-------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n | Xero | 4 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP |\n | QuickBooks Online | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML |\n | NetSuite | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |\n | Dynamics 365 Business Central | 350 MB | Dynamics do not explicitly outline which file types are supported but they do state here that \"You can attach any type of file, such as text, image, or video files\". |" + type: object 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' + 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.' + sourceModifiedDate: + allOf: + - $ref: '#/components/schemas/Connection/properties/created' + - description: "The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. \n\nIt is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when:\n - Pulling attachments\n - The accounting software does not provide modification dates for a data type\n - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred\n - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." + definitions: + attachments: + title: Attachments + type: array + items: + $ref: '#/components/schemas/Attachment' + 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: Bank accounts + type: object + allOf: - properties: - 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 - - title: Modified dates + id: + type: string + description: 'Identifier for the bank account, unique for the company in the accounting software.' + nominalCode: + type: string + nullable: true + description: Code used to identify each nominal account for a business. + name: + type: string + nullable: true + description: Name of the bank account in the accounting software. + accountType: + $ref: '#/components/schemas/BankAccountType' + 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. + sortCode: + type: string + nullable: true + description: |- + Sort code for the bank account. This is relevant to UK bank accounts. + + 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. + currency: + $ref: '#/components/schemas/Bill/properties/currency' + description: Base currency of the bank account. + status: + $ref: '#/components/schemas/BankAccount/definitions/bankAccountStatus' + - title: Source Modified Date x-internal: true - allOf: - - title: ModifiedDate - x-internal: true - type: object - properties: - modifiedDate: - allOf: - - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - - description: "The date when the record was last fetched from the data source and updated in Codat’s data cache. \n\nUse it to identify and retrieve records that have changed since your last fetch. For example, filtering `modifiedDate` to today will provide new records updated in Codat today.\n\nThis date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports ([read more](https://docs.codat.io/using-the-api/modified-dates#modified-date)).\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." - - title: Source Modified Date - x-internal: true - type: object - nullable: true - properties: - sourceModifiedDate: - allOf: - - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - - description: "The date when a record was last modified in the source platform, usually by the business or a business process. For example, when payments are made against an invoice. \n\nIt is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when:\n - Pulling attachments\n - The integration platform does not provide modification dates for a data type\n - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred\n - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." + type: object + nullable: true + properties: + sourceModifiedDate: + allOf: + - $ref: '#/components/schemas/Connection/properties/created' + - description: "The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. \n\nIt is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when:\n - Pulling attachments\n - The accounting software does not provide modification dates for a data type\n - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred\n - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." definitions: - accountPrototype: - title: Account prototype + bankAccountStatus: + type: string + description: The current status of the bank account. + enum: + - Active + - Archived + bankAccountPrototype: + title: Bank 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' + $ref: '#/components/schemas/BankAccount/allOf/0/properties/nominalCode' 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 + $ref: '#/components/schemas/BankAccount/allOf/0/properties/name' + accountType: + $ref: '#/components/schemas/BankAccountType' + accountNumber: + $ref: '#/components/schemas/BankAccount/allOf/0/properties/accountNumber' + sortCode: + $ref: '#/components/schemas/BankAccount/allOf/0/properties/sortCode' currency: - title: Currency - x-internal: true - type: string - description: "The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.\n\n## Unknown currencies\n\nIn line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. \n\nThere are only a very small number of edge cases where this currency code is returned by the Codat system." - format: ISO4217 - examples: - - GBP - - USD - - EUR - 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-expenses-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.\n\nFor example, `validDatatypeLinks` might indicate the following references:\n\n- Which tax rates are valid to use on the line item of a bill.\n- Which items can be used when creating an invoice. \n\nYou can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example.\n\n## `validDatatypeLinks` example\n\nThe following example uses the `Accounting.Accounts` data type. It shows that, on the linked integration, this account is valid as the account on a payment or bill payment; and as the account referenced on the line item of a direct income or direct cost. Because there is no valid link to Invoices or Bills, using this account on those data types will result in an error.\n\n```json validDatatypeLinks for an account\n{\n \"id\": \"bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4\",\n \"nominalCode\": \"090\",\n \"name\": \"Business Bank Account\",\n #...\n \"validDatatypeLinks\": [\n {\n \"property\": \"Id\",\n \"links\": [\n \"Payment.AccountRef.Id\",\n \"BillPayment.AccountRef.Id\",\n \"DirectIncome.LineItems.AccountRef.Id\",\n \"DirectCost.LineItems.AccountRef.Id\"\n ]\n }\n ]\n }\n```\n\n\n\n## Support for `validDatatypeLinks`\n\nCodat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations. \n\nIf you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap." - type: object - properties: - property: - type: string - nullable: true - description: The property from the account that can be linked. - links: - type: array - nullable: true - description: Supported `dataTypes` that the record can be linked to. - items: - type: string - 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 - AccountMappingInfo: - title: Account mapping info + $ref: '#/components/schemas/BankAccount/allOf/0/properties/currency' + required: + - name + - accountType + - accountNumber + - currency + BankAccountType: + title: Bank Account Type x-internal: true + enum: + - Unknown + - Credit + - Debit + type: string + description: "The type of transactions and balances on the account. \nFor Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. \nFor Debit accounts, positive balances are assets, and positive transactions **increase** assets." + Bill: + title: Bill + description: "\uFEFF\x42\x69\x6C\x6C\x73\x20\x61\x72\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x73\x20\x74\x68\x61\x74\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x20\x74\x68\x65\x20\x53\x4D\x42\x27\x73\x20\x66\x69\x6E\x61\x6E\x63\x69\x61\x6C\x20\x6F\x62\x6C\x69\x67\x61\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x73\x75\x70\x70\x6C\x69\x65\x72\x20\x66\x6F\x72\x20\x61\x20\x70\x75\x72\x63\x68\x61\x73\x65\x20\x6F\x66\x20\x67\x6F\x6F\x64\x73\x20\x6F\x72\x20\x73\x65\x72\x76\x69\x63\x65\x73\x2E" type: object - additionalProperties: false - x-examples: - Example AccountInfo: - id: 313a4dbe-b3a4-42f0-a5f5-43e382e62db9 - nominalCode: '720' - name: Travel - currency: GBP - accountType: Expense - fullyQualifiedCategory: Expense.Overhead - isBankAccount: false - validTransactionTypes: - - Payment - - Refund - validFor: - - expense-transactions.Payment - - expense-transactions.Refund - - reimbursable-expense-transactions properties: id: type: string - description: Unique identifier of account. - example: 127f3b99-8dc2-4b7e-854c-91ef9bd2757b - nullable: false - nominalCode: + description: 'Identifier for the bill, unique for the company in the accounting software.' + reference: type: string - description: Code used to identify each nominal account in the accounting software. - example: '300' nullable: true - name: - type: string - description: Name of the account as it appears in the company's accounting software. - example: Purchases - nullable: false + description: User-friendly reference for the bill. + supplierRef: + $ref: '#/components/schemas/Supplier/definitions/supplierRef' + 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: + title: Currency + x-internal: true type: string - description: Currency of the account. - example: GBP - nullable: false - accountType: - type: string - description: Type of the account. - example: Expense - enum: - - Asset - - Liability - - Income - - Expense - - Equity - nullable: false - fullyQualifiedCategory: - type: string - description: Full account type and category of the account - example: Expense.DirectCosts - nullable: false - isBankAccount: - type: boolean - description: Confirms whether the account is a bank account or not. - validTransactionTypes: - $ref: '#/components/schemas/validTransactionTypes' - description: Supported transaction types for the account. - validFor: - $ref: '#/components/schemas/validFor' - description: Supported endpoints for the account. - AdjustmentTransactionLine: - x-internal: true - title: Adjustment transaction line - type: object - properties: - amount: + description: "The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.\n\n## Unknown currencies\n\nIn line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. \n\nThere are only a very small number of edge cases where this currency code is returned by the Codat system." + format: ISO4217 + examples: + - GBP + - USD + - EUR + currencyRate: + title: Currency rate type: number format: decimal - example: 50 - description: Amount of the line. A positive line represents a debit; a negative line represents a credit. - accountRef: - $ref: '#/components/schemas/RecordRef' - description: - type: string - description: 'Any private, company notes about the transaction.' - example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - trackingRefs: + nullable: true + description: "Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.\n\nCurrency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. \n\nIt is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.\n\nWhere the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places). \n\nFor accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.\n\n## Examples with base currency of GBP\n\n| Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (GBP) |\n| :--------------- | :------------- | :------------ | :------------------------- |\n| **USD** | $20 | 0.781 | £15.62 |\n| **EUR** | €20 | 0.885 | £17.70 |\n| **RUB** | ₽20 | 0.011 | £0.22 |\n\n## Examples with base currency of USD\n\n| Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (USD) |\n| :--------------- | :------------- | :------------ | :------------------------- |\n| **GBP** | £20 | 1.277 | $25.54 |\n| **EUR** | €20 | 1.134 | $22.68 |\n| **RUB** | ₽20 | 0.015 | $0.30 |\n\n\n### Integration-specific details\n\n| Integration | Scenario | System behavior |\n|-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. |" + lineItems: type: array - minItems: 1 - maxItems: 10 nullable: true + description: Array of Bill line items. items: - $ref: '#/components/schemas/TrackingRefAdjustmentTransaction' - invoiceTo: - $ref: '#/components/schemas/InvoiceTo' - required: - - amount - - accountRef - AdjustmentTransactionRequest: - title: Adjustment transaction - type: object - properties: - id: - type: string - format: uuid - description: Your unique identifier for the transaction. - date: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: Date of the transaction. - currency: - type: string - description: Currency the transaction was recorded in. - currencyRate: - $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' - reference: - type: string + $ref: '#/components/schemas/Bill/definitions/billLineItem' + status: + $ref: '#/components/schemas/Bill/definitions/billStatus' + totalAmount: + type: number + format: decimal + description: 'Amount of the bill, including tax.' + amountDue: + type: number + format: decimal nullable: true - description: User-friendly reference for the adjustment transaction. - lines: - type: array - description: Array of transaction lines. - minItems: 1 - maxItems: 100 - items: - $ref: '#/components/schemas/AdjustmentTransactionLine' - required: - - id - - date - - currency - - lines - AdjustmentTransactionResponse: - title: Adjustment response - x-internal: true - type: object - properties: - syncId: - type: string - example: cd937d46-8e41-43a9-9477-a79158ffd98a - format: uuid - description: Unique id of sync created - apAccountRef: - x-internal: true - type: object - title: Accounts Payable account reference - nullable: true - properties: - id: - type: string - example: 8000004C-1724173136 - description: Unique identifier for the Accounts Payable account associated with the transaction. The `apAccountRef` object is currently supported only for QuickBooks Desktop. - Attachment: - title: Attachment - type: object - x-examples: - Attachment Example: - companyId: bf1e0242-5b7a-418b-a307-9e09dbf9f39a - id: '1400000000122699154' - transactionId: f8f00edd-ddb0-4ca5-b36b-8f932e6b5160 - properties: - companyId: - type: string - format: uuid - description: Unique ID of company in Codat - id: - type: string - description: Unique identifier of attachment - transactionId: - type: string - description: Unique identifier of transaction - AttachmentUpload: - title: Attachment upload - type: object - x-internal: true + description: Amount outstanding on the bill. + sourceModifiedDate: + allOf: + - $ref: '#/components/schemas/Connection/properties/created' + - description: "The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. \n\nIt is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when:\n - Pulling attachments\n - The accounting software does not provide modification dates for a data type\n - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred\n - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." required: - - file - properties: - file: - $ref: '#/components/schemas/AttachmentUpload/definitions/codatFile' + - supplierRef + - issueDate + - dueDate + - currency + - status definitions: - codatFile: + billPrototype: + title: Bill prototype + type: object + properties: + reference: + $ref: '#/components/schemas/Bill/properties/reference' + supplierRef: + $ref: '#/components/schemas/Supplier/definitions/supplierRef' + issueDate: + $ref: '#/components/schemas/Bill/properties/issueDate' + dueDate: + $ref: '#/components/schemas/Bill/properties/dueDate' + currency: + $ref: '#/components/schemas/Bill/properties/currency' + currencyRate: + $ref: '#/components/schemas/Bill/properties/currencyRate' + lineItems: + $ref: '#/components/schemas/Bill/properties/lineItems' + status: + $ref: '#/components/schemas/Bill/definitions/billStatus' + required: + - supplierRef + - issueDate + - dueDate + - currency + - status + billStatus: + description: Current state of the bill. If creating a bill the status must be `Open`. 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**\n> \n> This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. \n> \n> To view bank account data through the Banking API, please refer to the new [Banking: Account](https://docs.codat.io/sync-for-expenses-api#/schemas/Account) data type.\n\n## Overview\n\nA list of bank accounts associated with a company and a specific data connection.\n\nBank accounts data includes:\n* The name and ID of the account in the accounting software.\n* The currency and balance of the account.\n* The sort code and account number." - type: object - allOf: - - properties: - id: - type: string - description: 'Identifier for the account, unique for the company in the accounting software.' - - $ref: '#/components/schemas/BankAccount/definitions/bankAccountPrototype' - - properties: - metadata: - $ref: '#/components/schemas/Account/allOf/2/properties/metadata' - supplementalData: - $ref: '#/components/schemas/SupplementalData' - - $ref: '#/components/schemas/Account/allOf/3' - definitions: - bankAccountPrototype: - title: Bank account prototype + enum: + - Unknown + - Open + - PartiallyPaid + - Paid + - Void + - Draft + example: Open + billLineItem: + title: Bill line item type: object properties: - accountName: - type: string - nullable: true - description: Name of the bank account in the accounting software. - accountType: - title: Bank Account Type - x-internal: true - enum: - - Unknown - - Credit - - Debit - type: string - description: "The type of transactions and balances on the account. \nFor Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. \nFor Debit accounts, positive balances are assets, and positive transactions **increase** assets." - nominalCode: - type: string - nullable: true - description: Code used to identify each nominal account for a business. - sortCode: - type: string - nullable: true - description: |- - Sort code for the bank account. - - 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: + description: 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: + description: Friendly name of the goods or services received. + unitAmount: 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: + description: Unit price of the goods or service. + quantity: 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: + description: Number of units of goods or services received. + taxAmount: + type: number + format: decimal + description: Amount of tax applied to the line item. + accountRef: + $ref: '#/components/schemas/Bill/definitions/billAccountRef' + totalAmount: 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 + description: 'Total amount of the line, including tax.' + taxRateRef: + $ref: '#/components/schemas/Bill/definitions/billTaxRateRef' + trackingRefs: + type: array + nullable: true + items: + $ref: '#/components/schemas/Bill/definitions/trackingRef' + billAccountRef: + title: Account reference type: object + description: Reference to the account to which the line item is linked. properties: id: type: string - description: Bank account 'id' for the account transaction. - name: + description: '''id'' from the Accounts data type.' + billTaxRateRef: + title: Tax rate reference + type: object + description: Reference to the tax rate to which the line item is linked. + properties: + id: 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 - ClientRateLimitReachedWebhook: - title: Client rate limit reached webhook + description: Unique identifier for the tax rate in the accounting software. + bills: + title: Bills + type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Bill' + pagination: + $ref: '#/components/schemas/Pagination' + trackingRef: + type: object + title: Tracking reference + properties: + id: + type: string + example: e9a1b63d-9ff0-40e7-8038-016354b987e6 + description: Unique identifier of the linked tracking category or the unique identifier of the linked customer. + dataType: + type: string + example: trackingCategories + description: The type of the linked reference. + enum: + - trackingCategories + - customers + isBillable: + type: boolean + description: If a customer has been set as the trackingRefs.id then this boolean can be used to set whether the line item is billable to the customer or not. + BillEventWebhook: x-internal: true - description: Webhook request body for a client that has reached their rate limit. + title: Bill event webhook type: object properties: - ClientId: - $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientId' - ClientName: - $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientName' - RuleId: - $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleId' - RuleType: - $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleType' - AlertId: - $ref: '#/components/schemas/SyncFailedWebhook/properties/AlertId' - Message: - $ref: '#/components/schemas/SyncFailedWebhook/properties/Message' - Data: - $ref: '#/components/schemas/ClientRateLimitReachedWebhook/definitions/ClientRateLimitReachedWebhookData' + id: + type: string + format: uuid + description: Unique identifier of the bill event. + type: + type: string + description: Type of webhook event. + example: payables.bill.created + createdDate: + type: string + description: The datetime in UTC of when the webhook event was produced by Codat. + examples: + - '2022-10-23T11:03:35Z' + payload: + $ref: '#/components/schemas/BillEventWebhook/definitions/billEventPayload' definitions: - ClientRateLimitReachedWebhookData: + billEventPayload: + title: Bill event payload 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/TransferTransactionRequest/properties/date/allOf/1' - 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 + companyId: + $ref: '#/components/parameters/companyId/schema' + connectionId: + $ref: '#/components/parameters/connectionId/schema' + pushOperationKey: + type: string + format: uuid + example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + description: Unique identifier for the push operation. + bill: + $ref: '#/components/schemas/Bill' + BillMappingOptions: x-internal: true - description: Webhook request body for a client that has had their rate limit reset. + title: Mapping options bills + description: The bill mapping options for a company's accounting software. + type: object + properties: + accounts: + type: array + items: + $ref: '#/components/schemas/BillMappingOptions/definitions/accountMappingOption' + taxRates: + type: array + items: + $ref: '#/components/schemas/BillMappingOptions/definitions/taxRateMappingOption' + pagination: + $ref: '#/components/schemas/Pagination' + definitions: + accountMappingOption: + title: Account mapping option + type: object + allOf: + - properties: + id: + type: string + description: 'Identifier for the account, unique for the company.' + example: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + 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 Payable + type: + type: string + nullable: true + description: Type of account. + example: Liability + currency: + $ref: '#/components/schemas/Bill/properties/currency' + status: + $ref: '#/components/schemas/BillMappingOptions/definitions/accountStatus' + - $ref: '#/components/schemas/BankAccount/allOf/1' + taxRateMappingOption: + title: Tax rate mapping option + type: object + allOf: + - properties: + id: + type: string + description: 'Identifier for the tax rate, unique for the company in the accounting software.' + example: d2939064-dd3a-4c0f-9865-a238c2193515 + 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. + 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. + status: + title: Tax rate status + type: string + enum: + - Active + - Archived + description: "Status of the tax rate in the accounting software. \n- `Active` - An active tax rate in use by a company. \n- `Archived` - A tax rate that has been archived or is inactive in the accounting software. " + accountStatus: + type: string + description: The current status of the account. + enum: + - Active + - Archived + example: Active + BillPayment: + title: Bill payment type: object + description: '' properties: - ClientId: - $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientId' - ClientName: - $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientName' - RuleId: - $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleId' - RuleType: - $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleType' - AlertId: - $ref: '#/components/schemas/SyncFailedWebhook/properties/AlertId' - Message: - $ref: '#/components/schemas/SyncFailedWebhook/properties/Message' - Data: - $ref: '#/components/schemas/ClientRateLimitResetWebhook/definitions/ClientRateLimitResetWebhookData' + id: + type: string + description: 'Identifier for the bill payment, unique for the company in the accounting software.' + amount: + type: number + format: decimal + description: Amount of the payment in the bill currency. + example: 1329.54 + date: + allOf: + - $ref: '#/components/schemas/Connection/properties/created' + - description: Date the bill payment was recorded in the accounting software. + reference: + type: string + nullable: true + description: Additional information associated with the payment. + example: Bill Payment against bill c13e37b6-dfaa-4894-b3be-9fe97bda9f44 + accountRef: + $ref: '#/components/schemas/BillPayment/definitions/billPaymentAccountRef' + currencyRate: + $ref: '#/components/schemas/Bill/properties/currencyRate' definitions: - ClientRateLimitResetWebhookData: + billPaymentPrototype: + title: Bill payment prototype 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: + amount: + $ref: '#/components/schemas/BillPayment/properties/amount' + date: + $ref: '#/components/schemas/BillPayment/properties/date' + reference: + $ref: '#/components/schemas/BillPayment/properties/reference' + accountRef: + $ref: '#/components/schemas/BillPayment/definitions/billPaymentAccountRef' + currencyRate: + $ref: '#/components/schemas/Bill/properties/currencyRate' + required: + - amount + - date + - accountRef + billPaymentAccountRef: + description: Reference to the bank account / credit card which you are using to pay the bill. + type: object + properties: + id: 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' + description: Unique ID of the bank account / credit card + required: + - id + example: + amount: 22 + date: '2022-10-23T00:00:00.000Z' + reference: Bill Payment against bill c13e37b6 dfaa-4894-b3be-9fe97bda9f44 + accountRef: + id: 9e32cbf8-e7d5-4d4d-a593-08d550682aab + currencyRate: 1 ClientRateLimitWebhook: title: Client rate limit webhook type: object @@ -10507,7 +2337,7 @@ components: - client.rateLimit.reset - client.rateLimit.reached generatedDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $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' @@ -10523,7 +2353,7 @@ components: type: integer description: Total number of requests remaining for your client. expiryDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' description: The date time in UTC when your daily quota is reset. Companies: title: Companies @@ -10538,7 +2368,7 @@ components: - $ref: '#/components/schemas/PagingInfo' Company: title: Company - description: "\uFEFF\x49\x6E\x20\x43\x6F\x64\x61\x74\x2C\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\x20\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5B\x58\x65\x72\x6F\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2F\x78\x65\x72\x6F\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2D\x78\x65\x72\x6F\x29\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x5B\x50\x6C\x61\x69\x64\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2F\x70\x6C\x61\x69\x64\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2D\x70\x6C\x61\x69\x64\x29\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5B\x5A\x65\x74\x74\x6C\x65\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2F\x7A\x65\x74\x74\x6C\x65\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2D\x7A\x65\x74\x74\x6C\x65\x29\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n\n\x54\x79\x70\x69\x63\x61\x6C\x6C\x79\x20\x65\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x69\x73\x20\x6F\x6E\x65\x20\x6F\x66\x20\x79\x6F\x75\x72\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x73\x2E\n\n\x57\x68\x65\x6E\x20\x79\x6F\x75\x20\x63\x72\x65\x61\x74\x65\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x73\x70\x65\x63\x69\x66\x79\x20\x61\x20\x60\x6E\x61\x6D\x65\x60\x20\x61\x6E\x64\x20\x77\x65\x20\x77\x69\x6C\x6C\x20\x61\x75\x74\x6F\x6D\x61\x74\x69\x63\x61\x6C\x6C\x79\x20\x67\x65\x6E\x65\x72\x61\x74\x65\x20\x61\x20\x75\x6E\x69\x71\x75\x65\x20\x60\x69\x64\x60\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\x59\x6F\x75\x20\x63\x61\x6E\x20\x61\x6C\x73\x6F\x20\x61\x64\x64\x20\x61\x20\x60\x64\x65\x73\x63\x72\x69\x70\x74\x69\x6F\x6E\x60\x20\x74\x6F\x20\x73\x74\x6F\x72\x65\x20\x61\x6E\x79\x20\x61\x64\x64\x69\x74\x69\x6F\x6E\x61\x6C\x20\x69\x6E\x66\x6F\x72\x6D\x61\x74\x69\x6F\x6E\x20\x61\x62\x6F\x75\x74\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E" + description: "\uFEFF\x49\x6E\x20\x43\x6F\x64\x61\x74\x2C\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x73\x68\x61\x72\x69\x6E\x67\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x64\x61\x74\x61\x2E\x20\x45\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x5B\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x29\x20\x74\x6F\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x20\x73\x75\x63\x68\x20\x61\x73\x20\x6F\x6E\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5B\x58\x65\x72\x6F\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2F\x78\x65\x72\x6F\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2D\x78\x65\x72\x6F\x29\x20\x66\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x2C\x20\x74\x77\x6F\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x74\x6F\x20\x5B\x50\x6C\x61\x69\x64\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2F\x70\x6C\x61\x69\x64\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2D\x70\x6C\x61\x69\x64\x29\x20\x66\x6F\x72\x20\x74\x77\x6F\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x5B\x5A\x65\x74\x74\x6C\x65\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2F\x7A\x65\x74\x74\x6C\x65\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2D\x7A\x65\x74\x74\x6C\x65\x29\x20\x66\x6F\x72\x20\x50\x4F\x53\x20\x64\x61\x74\x61\x2E\n\n\x54\x79\x70\x69\x63\x61\x6C\x6C\x79\x20\x65\x61\x63\x68\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x69\x73\x20\x6F\x6E\x65\x20\x6F\x66\x20\x79\x6F\x75\x72\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x73\x2E\n\n\x57\x68\x65\x6E\x20\x79\x6F\x75\x20\x63\x72\x65\x61\x74\x65\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x73\x70\x65\x63\x69\x66\x79\x20\x61\x20\x60\x6E\x61\x6D\x65\x60\x20\x61\x6E\x64\x20\x77\x65\x20\x77\x69\x6C\x6C\x20\x61\x75\x74\x6F\x6D\x61\x74\x69\x63\x61\x6C\x6C\x79\x20\x67\x65\x6E\x65\x72\x61\x74\x65\x20\x61\x20\x75\x6E\x69\x71\x75\x65\x20\x60\x69\x64\x60\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\x59\x6F\x75\x20\x63\x61\x6E\x20\x61\x6C\x73\x6F\x20\x61\x64\x64\x20\x61\x20\x60\x64\x65\x73\x63\x72\x69\x70\x74\x69\x6F\x6E\x60\x20\x74\x6F\x20\x73\x74\x6F\x72\x65\x20\x61\x6E\x79\x20\x61\x64\x64\x69\x74\x69\x6F\x6E\x61\x6C\x20\x69\x6E\x66\x6F\x72\x6D\x61\x74\x69\x6F\x6E\x20\x61\x62\x6F\x75\x74\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E" type: object allOf: - $ref: '#/components/schemas/Company/definitions/companyDetails' @@ -10568,10 +2398,10 @@ components: 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/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' nullable: true created: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' createdByUserName: type: string description: Name of user that created the company in Codat. @@ -10647,232 +2477,22 @@ components: lastSync: '2022-10-27T10:22:43.6464237Z' created: '2022-10-27T09:53:29Z' sourceType: Banking - CompanyConfiguration: - required: - - bankAccount - - supplier - - customer - title: Company configuration - type: object - x-examples: - Config Example: - bankAccount: - id: '89' - supplier: - id: '124' - customer: - id: '140' - properties: - bankAccount: - $ref: '#/components/schemas/CompanyConfiguration/definitions/BankAccountDetails' - supplier: - $ref: '#/components/schemas/CompanyConfiguration/definitions/SupplierDetails' - customer: - $ref: '#/components/schemas/CompanyConfiguration/definitions/CustomerDetails' - definitions: - BankAccountDetails: - title: Bank account details - type: object - properties: - id: - type: string - description: The id of the account from which purchases are made - example: '32' - SupplierDetails: - title: Supplier details - type: object - properties: - id: - $ref: '#/components/schemas/Supplier/allOf/0/properties/id' - CustomerDetails: - title: Customer details - type: object - properties: - id: - $ref: '#/components/schemas/Customer/allOf/0/properties/id' + products: + - spend-insights + - lending CompanyInformation: - title: 'Accounting: Company information' - description: "Company info provides standard details about a linked company such as their address, phone number, and company registration.\n\n> **Company information or companies?**\n> \n> Company information 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." + title: Company information type: object + description: Gets the latest basic info for a company. properties: companyName: type: string nullable: true description: Name of the linked company. - accountingPlatformRef: - type: string - nullable: true - description: Identifier or reference for the company in the accounting software. - companyLegalName: - type: string - nullable: true - description: Registered legal name of the linked company. - addresses: - type: array - nullable: true - description: An array of Addresses. - items: - title: 'Accounting: Address' - x-internal: true - type: object - properties: - type: - $ref: '#/components/schemas/CompanyInformation/properties/addresses/items/definitions/accountingAddressType' - line1: - type: string - nullable: true - description: Line 1 of the customer address. - line2: - type: string - nullable: true - description: Line 2 of the customer address. - city: - type: string - nullable: true - description: City of the customer address. - region: - type: string - nullable: true - description: Region of the customer address. - country: - type: string - nullable: true - description: Country of the customer address. - postalCode: - type: string - nullable: true - description: Postal code or zip code. - required: - - type - definitions: - accountingAddressType: - description: The type of the address - type: string - enum: - - Unknown - - Billing - - Delivery - phoneNumbers: - type: array - nullable: true - description: An array of phone numbers. - items: - title: Phone - type: object - x-internal: true - properties: - number: - type: string - nullable: true - examples: - - +44 25691 154789 - - (877) 492-8687 - - 01224 658 999 - description: A phone number. - type: - $ref: '#/components/schemas/CompanyInformation/properties/phoneNumbers/items/definitions/phoneNumberType' - required: - - type - definitions: - phoneNumberType: - description: The type of phone number - type: string - enum: - - Primary - - Landline - - Mobile - - Fax - - Unknown - webLinks: - type: array - nullable: true - description: An array of weblinks. - items: - title: Weblink - description: Weblink associated with the company. - type: object - properties: - type: - description: The type of the weblink. - type: string - enum: - - Website - - Social - - Unknown - url: - description: The full URL for the weblink. - type: string - format: url - example: - type: Website - url: 'https://codat.io' - ledgerLockDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - 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/TransferTransactionRequest/properties/date/allOf/1' - 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/TransferTransactionRequest/properties/date/allOf/1' - 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' + baseCurrency: + type: string + nullable: true + description: Currency set in the accounting software of the linked company. Used by the currency rate. CompanyRequestBody: title: Create company request x-internal: true @@ -10892,73 +2512,24 @@ components: $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' required: - name - CompanySyncStatus: - title: Company sync status + CompanyUpdateRequest: + title: Update company request + x-internal: true type: object - additionalProperties: false - x-examples: - Success Data Pushed: - companyId: 20803807-4e9a-4cb7-b67b-9f889a3916e1 - syncId: aa4c9dfd-e945-4424-9628-9e724f14c267 - syncStatusCode: 2000 - syncStatus: Complete - errorMessage: '' - syncExceptionMessage: '' - syncUtc: '2023-01-24T14:15:22Z' - dataPushed: true - Success No Data Pushed: - companyId: 20803807-4e9a-4cb7-b67b-9f889a3916e1 - syncId: aa4c9dfd-e945-4424-9628-9e724f14c267 - syncStatusCode: 2040 - syncStatus: Complete - errorMessage: '' - syncExceptionMessage: '' - syncUtc: '2023-01-24T14:15:22Z' - dataPushed: false properties: - companyId: - type: string - description: Unique identifier for your SMB in Codat. - example: d4d73051-ed31-42b6-99f6-d288cd940992 - nullable: true - syncId: - type: string - description: Unique identifier of the sync. - example: a6a22aff-a43a-411d-a910-2dae73217cce - nullable: true - syncStatusCode: - type: integer - format: int32 - description: Status code of the sync. - example: 2000 - syncStatus: - type: string - description: Text status of the sync. - examples: - - Complete - - PushError - - Started - - NotStarted - - Pushing - nullable: true - errorMessage: - type: string - description: Error message of the sync. - nullable: true - syncExceptionMessage: + name: type: string - description: Exception message of the sync. - nullable: true - syncUtc: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: Datetime of the sync. - nullable: true - dataPushed: - type: boolean - description: Boolean of whether the sync resulted in data being pushed. + description: Name of company being connected. + pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' + minLength: 1 + example: Bank of Dave + description: + $ref: '#/components/schemas/CompanyRequestBody/properties/description' + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' Connection: title: Connection - description: "\uFEFF\x41\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x65\x78\x70\x65\x6E\x73\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x61\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x6E\x64\x20\x61\x6C\x6C\x6F\x77\x73\x20\x79\x6F\x75\x20\x74\x6F\x20\x73\x79\x6E\x63\x68\x72\x6F\x6E\x69\x7A\x65\x20\x64\x61\x74\x61\x20\x28\x70\x75\x6C\x6C\x20\x61\x6E\x64\x2F\x6F\x72\x20\x70\x75\x73\x68\x29\x20\x77\x69\x74\x68\x20\x74\x68\x61\x74\x20\x73\x6F\x75\x72\x63\x65\x2E\n\n\x41\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x64\x65\x70\x65\x6E\x64\x69\x6E\x67\x20\x6F\x6E\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x20\x69\x74\x20\x69\x73\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6E\x67\x20\x74\x6F\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x6C\x69\x6E\x6B\x20\x74\x6F\x3A\n\n\x2D\x20\x5B\x41\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2D\x61\x70\x69\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x20\x2D\x20\x31\x20\x61\x63\x74\x69\x76\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x2E\n\x2D\x20\x5B\x42\x61\x6E\x6B\x69\x6E\x67\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2D\x61\x70\x69\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x20\x2D\x20\x4D\x75\x6C\x74\x69\x70\x6C\x65\x20\x61\x63\x74\x69\x76\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x2E\n\x2D\x20\x5B\x43\x6F\x6D\x6D\x65\x72\x63\x65\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2D\x61\x70\x69\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x20\x2D\x20\x4D\x75\x6C\x74\x69\x70\x6C\x65\x20\x61\x63\x74\x69\x76\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x2E\n\x41\x6E\x79\x20\x63\x6F\x6D\x62\x69\x6E\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2C\x20\x62\x61\x6E\x6B\x69\x6E\x67\x2C\x20\x61\x6E\x64\x20\x63\x6F\x6D\x6D\x65\x72\x63\x65\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x69\x73\x20\x61\x6C\x6C\x6F\x77\x65\x64\x2E\n\n\x42\x65\x66\x6F\x72\x65\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x75\x73\x65\x20\x61\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x70\x75\x6C\x6C\x20\x6F\x72\x20\x70\x75\x73\x68\x20\x64\x61\x74\x61\x2C\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x6D\x75\x73\x74\x20\x67\x72\x61\x6E\x74\x20\x79\x6F\x75\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x64\x61\x74\x61\x20\x62\x79\x20\x5B\x6C\x69\x6E\x6B\x69\x6E\x67\x20\x74\x68\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x61\x75\x74\x68\x2D\x66\x6C\x6F\x77\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x2E" + description: "\uFEFF\x41\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x6F\x6D\x70\x61\x6E\x79\x29\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x61\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x6E\x64\x20\x61\x6C\x6C\x6F\x77\x73\x20\x79\x6F\x75\x20\x74\x6F\x20\x73\x79\x6E\x63\x68\x72\x6F\x6E\x69\x7A\x65\x20\x64\x61\x74\x61\x20\x28\x70\x75\x6C\x6C\x20\x61\x6E\x64\x2F\x6F\x72\x20\x70\x75\x73\x68\x29\x20\x77\x69\x74\x68\x20\x74\x68\x61\x74\x20\x73\x6F\x75\x72\x63\x65\x2E\n\n\x41\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x68\x61\x76\x65\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x64\x65\x70\x65\x6E\x64\x69\x6E\x67\x20\x6F\x6E\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x20\x69\x74\x20\x69\x73\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6E\x67\x20\x74\x6F\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x63\x61\x6E\x20\x6C\x69\x6E\x6B\x20\x74\x6F\x3A\n\n\x2D\x20\x5B\x41\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2D\x61\x70\x69\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x20\x2D\x20\x31\x20\x61\x63\x74\x69\x76\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x2E\n\x2D\x20\x5B\x42\x61\x6E\x6B\x69\x6E\x67\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x62\x61\x6E\x6B\x69\x6E\x67\x2D\x61\x70\x69\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x20\x2D\x20\x4D\x75\x6C\x74\x69\x70\x6C\x65\x20\x61\x63\x74\x69\x76\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x2E\n\x2D\x20\x5B\x43\x6F\x6D\x6D\x65\x72\x63\x65\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x63\x6F\x6D\x6D\x65\x72\x63\x65\x2D\x61\x70\x69\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x20\x2D\x20\x4D\x75\x6C\x74\x69\x70\x6C\x65\x20\x61\x63\x74\x69\x76\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x2E\n\x41\x6E\x79\x20\x63\x6F\x6D\x62\x69\x6E\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x2C\x20\x62\x61\x6E\x6B\x69\x6E\x67\x2C\x20\x61\x6E\x64\x20\x63\x6F\x6D\x6D\x65\x72\x63\x65\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x69\x73\x20\x61\x6C\x6C\x6F\x77\x65\x64\x2E\n\n\x42\x65\x66\x6F\x72\x65\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x75\x73\x65\x20\x61\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x74\x6F\x20\x70\x75\x6C\x6C\x20\x6F\x72\x20\x70\x75\x73\x68\x20\x64\x61\x74\x61\x2C\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x6D\x75\x73\x74\x20\x67\x72\x61\x6E\x74\x20\x79\x6F\x75\x20\x61\x63\x63\x65\x73\x73\x20\x74\x6F\x20\x74\x68\x65\x69\x72\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x64\x61\x74\x61\x20\x62\x79\x20\x5B\x6C\x69\x6E\x6B\x69\x6E\x67\x20\x74\x68\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x61\x75\x74\x68\x2D\x66\x6C\x6F\x77\x2F\x6F\x76\x65\x72\x76\x69\x65\x77\x29\x2E" type: object properties: id: @@ -11000,10 +2571,15 @@ components: status: $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' lastSync: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' nullable: true created: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + title: Date time + type: string + examples: + - '2022-10-23T00:00:00Z' + - '2022-10-23' + description: "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced." dataConnectionErrors: type: array nullable: true @@ -11012,8 +2588,7 @@ components: connectionInfo: type: object nullable: true - additionalProperties: - type: string + additionalProperties: true additionalProperties: false required: - id @@ -11049,7 +2624,7 @@ components: type: string description: A message about a error returned by Codat. erroredOnUtc: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $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. @@ -11061,7 +2636,7 @@ components: resolvedOnUtc: description: The datetime in Utc that the error was resolved. nullable: true - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' dataConnectionSourceType: title: Source Type description: The type of platform of the connection. @@ -11097,215 +2672,12 @@ components: items: $ref: '#/components/schemas/Connection' - $ref: '#/components/schemas/PagingInfo' - CreateAccountResponse: - title: Create account response - x-internal: true - allOf: - - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/Account' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - CreateAdjustmentRequest: - title: Create adjustment request - x-internal: true - type: array - minItems: 1 - maxItems: 50 - items: - $ref: '#/components/schemas/AdjustmentTransactionRequest' - CreateBankAccountResponse: - title: Create bank account response - x-internal: true - allOf: - - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/BankAccount' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - CreateCustomerResponse: - title: Create customer response - x-internal: true - allOf: - - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/Customer' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - CreateExpenseRequest: - title: Create expense request - x-internal: true - type: array - minItems: 1 - maxItems: 50 - items: - $ref: '#/components/schemas/ExpenseTransaction' - CreateExpenseResponse: - title: Create expense response - x-internal: true - type: object - properties: - syncId: - type: string - example: cd937d46-8e41-43a9-9477-a79158ffd98a - format: uuid - description: Unique id of sync created - CreateReimbursableExpenseResponse: - title: Create reimbursable expense response - x-internal: true - type: object - properties: - syncId: - type: string - example: cd937d46-8e41-43a9-9477-a79158ffd98a - format: uuid - description: Unique id of sync created - CreateSupplierResponse: - title: Create supplier response - x-internal: true - allOf: - - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/Supplier' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - Customer: - title: 'Accounting: Customer' - description: | - ## Overview - - A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). - - Customers' data links to accounts receivable [invoices](https://docs.codat.io/sync-for-expenses-api#/schemas/Invoice). - type: object - allOf: - - type: object - properties: - id: - type: string - description: 'Identifier for the customer, unique to the company in the accounting software.' - customerName: - type: string - nullable: true - description: 'Name of the customer as recorded in the accounting system, typically the company name.' - contactName: - type: string - nullable: true - description: Name of the main contact for the identified customer. - emailAddress: - type: string - nullable: true - description: Email address the customer can be contacted by. - defaultCurrency: - $ref: '#/components/schemas/Account/definitions/accountPrototype/properties/currency' - description: Default currency the transactional data of the customer is recorded in. - phone: - type: string - nullable: true - description: Phone number the customer can be contacted by. - addresses: - type: array - nullable: true - description: An array of Addresses. - items: - $ref: '#/components/schemas/CompanyInformation/properties/addresses/items' - contacts: - type: array - nullable: true - description: An array of Contacts. - items: - $ref: '#/components/schemas/Customer/definitions/contact' - registrationNumber: - type: string - nullable: true - description: 'Company number. In the UK, this is typically the Companies House company registration number.' - taxNumber: - type: string - nullable: true - description: Company tax number. - status: - $ref: '#/components/schemas/Customer/definitions/customerStatus' - description: Current state of the customer. - metadata: - $ref: '#/components/schemas/Account/allOf/2/properties/metadata' - supplementalData: - $ref: '#/components/schemas/SupplementalData' - - $ref: '#/components/schemas/Account/allOf/3' - required: - - status - definitions: - accountingCustomerRef: - type: object - properties: - id: - minLength: 1 - type: string - description: '`id` from the Customers data type' - companyName: - type: string - nullable: true - description: '`customerName` from the Customer data type' - required: - - id - customerStatus: - description: Status of customer. - type: string - enum: - - Unknown - - Active - - Archived - contact: - type: object - properties: - name: - type: string - nullable: true - description: Name of a contact for a customer. - email: - type: string - nullable: true - description: Email of a contact for a customer. - phone: - type: array - nullable: true - description: An array of Phone numbers. - items: - $ref: '#/components/schemas/CompanyInformation/properties/phoneNumbers/items' - address: - $ref: '#/components/schemas/CompanyInformation/properties/addresses/items' - description: An object of Address information. - status: - $ref: '#/components/schemas/Customer/definitions/customerStatus' - modifiedDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - required: - - status - Customers: - title: Customers - x-internal: true - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/Customer' - - $ref: '#/components/schemas/PagingInfo' 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: @@ -11359,7 +2731,7 @@ components: - commerce-transactions example: invoices lastSuccessfulSync: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' currentStatus: $ref: '#/components/schemas/PullOperation/properties/status' latestSyncId: @@ -11378,12 +2750,6 @@ components: 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' @@ -11445,287 +2811,14 @@ components: type: string nullable: true description: Name of validator. - ExpenseContactRef: - type: object - title: Supplier/customer reference - x-internal: true - properties: - id: - type: string - example: 40e3e57c-2322-4898-966c-ca41adfd23fd - description: Identifier of supplier or customer. - type: - type: string - description: The type of contact. - example: Supplier - default: Supplier - enum: - - Supplier - required: - - id - ExpensesSyncWebhook: - title: Expenses sync webhook - type: object - properties: - id: - type: string - format: uuid - example: ba29118f-5406-4e59-b05c-ba307ca38d01 - description: Unique identifier of the event. - eventType: - type: string - description: The type of event. - examples: - - expenses.sync.successful - - expenses.sync.unsuccessful - generatedDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/ExpensesSyncWebhook/definitions/expensesSyncWebhookPayload' - definitions: - transaction: - title: Transaction - type: object - properties: - id: - type: string - description: Unique identifier of the transaction. - status: - type: string - enum: - - Unknown - - PushError - - Completed - - Failed - - Pending - description: Status of transaction. - errorMessage: - type: string - nullable: true - description: Error message for failed transaction. - expensesSyncWebhookPayload: - title: Expenses sync webhook payload - type: object - properties: - referenceCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - syncId: - type: string - description: Unique identifier of the sync. - transactions: - type: array - items: - $ref: '#/components/schemas/ExpensesSyncWebhook/definitions/transaction' - ExpenseTransaction: - title: Expense transaction - type: object - properties: - id: - type: string - example: 4d7c6929-7770-412b-91bb-44d3bc71d111 - format: uuid - description: Your unique identifier for the transaction. - type: - type: string - example: Payment - description: The type of transaction. - enum: - - Payment - - Refund - - Reward - - Chargeback - issueDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: Date of the transaction was recorded. - currency: - type: string - example: GBP - description: Currency the transaction was recorded in. - currencyRate: - title: Currency rate - type: number - format: decimal - nullable: true - description: "Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.\n\nCurrency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. \n\nIt is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.\n\nWhere the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places). \n\nFor accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.\n\n## Examples with base currency of GBP\n\n| Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (GBP) |\n| :--------------- | :------------- | :------------ | :------------------------- |\n| **USD** | $20 | 0.781 | £15.62 |\n| **EUR** | €20 | 0.885 | £17.70 |\n| **RUB** | ₽20 | 0.011 | £0.22 |\n\n## Examples with base currency of USD\n\n| Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (USD) |\n| :--------------- | :------------- | :------------ | :------------------------- |\n| **GBP** | £20 | 1.277 | $25.54 |\n| **EUR** | €20 | 1.134 | $22.68 |\n| **RUB** | ₽20 | 0.015 | $0.30 |\n\n\n### Integration-specific details\n\n| Integration | Scenario | System behavior |\n|-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. |" - contactRef: - description: Supplier or customer for the purchase to be associated to. - $ref: '#/components/schemas/ExpenseContactRef' - bankAccountRef: - type: object - title: Bank account reference - properties: - id: - type: string - example: 787dfb37-5707-4dc0-8a86-8d74e4cc78ea - description: Identifier of the bank account. - reference: - type: string - nullable: true - description: User-friendly reference for the expense transaction. - merchantName: - type: string - example: Amazon UK - description: Name of the merchant where the purchase took place - lines: - type: array - description: Array of transaction lines. - minItems: 1 - maxItems: 100 - items: - $ref: '#/components/schemas/ExpenseTransactionLine' - notes: - type: string - description: 'Any private, company notes about the transaction.' - example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - postAsDraft: - type: boolean - nullable: true - description: 'This optional property, when set to true, posts the transaction to a drafted state. Note that postAsDraft is only supported in Microsoft Dynamics 365 Business Central.' - required: - - id - - type - - issueDate - - currency - examples: - - id: a44135b0-6882-489a-83fe-a0c57a4afb19 - type: Payment - issueDate: '2024-05-21T00:00:00+00:00' - currency: GBP - currencyRate: 1 - contactRef: - id: '430' - type: Supplier - bankAccountRef: - id: '97' - merchantName: Amazon UK - notes: amazon purchase - lines: - - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 23_Bills - accountRef: - id: '35' - trackingRefs: - - id: DEPARTMENT_3 - - dataType: trackingCategories - invoiceTo: - id: '504' - type: customer - ExpenseTransactionLine: - x-internal: true - title: Expense transaction line - type: object - x-examples: - ExpenseTransactionLine: - netAmount: 100 - taxAmount: 20 - taxRateRef: - id: 08d37c46-8d5d-441b-8bad-76286c43047e - accountRef: - id: 16989b16-96d4-401a-9054-f5c620c655a6 - trackingRefs: - - id: e9a1b63d-9ff0-40e7-8038-016354b987e6 - invoiceTo: - id: 80000002-1674552702 - type: customer - properties: - netAmount: - type: number - format: decimal - example: 100 - description: 'Amount of the line, exclusive of tax.' - taxAmount: - type: number - format: decimal - example: 20 - description: Amount of tax for the line. - taxRateRef: - $ref: '#/components/schemas/RecordRef' - accountRef: - description: The `accountRef` contains the `id` of the account the transaction is against. The `accountRef` object is required for all integrations except QBD which currently supports either itemRef or accountRef. - $ref: '#/components/schemas/RecordRef' - itemRef: - $ref: '#/components/schemas/ItemRef' - trackingRefs: - type: array - minItems: 1 - maxItems: 10 - nullable: true - items: - $ref: '#/components/schemas/TrackingRef' - invoiceTo: - $ref: '#/components/schemas/InvoiceTo' - required: - - netAmount - IntegrationType: - title: Integration type - x-internal: true - type: string - description: Type of transaction that has been processed e.g. Expense or Bank Feed. - enum: - - expenses - - bankfeeds - default: expenses - example: expenses - nullable: true - InvoiceTo: - title: Billable customer reference - x-internal: true - type: object - nullable: true - description: Unique identifier for the customer billed for the transaction. The `invoiceTo` object is currently supported only for QuickBooks Online and QuickBooks Desktop. - properties: - id: - type: string - example: 80000002-1674552702 - description: identifier of customer. - type: - type: string - example: customer - description: The type of contact. - enum: - - customer - ItemRef: + Pagination: + title: Pagination metadata x-internal: true type: object - title: Item reference - nullable: true - properties: - id: - type: string - example: 80000002-1675158984 - description: 'Unique identifier for the item associated with the transaction. The `itemRef` object is currently supported only for QuickBooks Desktop. You can specify either `itemRef` or `accountRef`, but not both.' - MappingOptions: - title: Mapping options - type: object - additionalProperties: false - x-examples: {} properties: - expenseProvider: + continuationToken: type: string - description: Name of the expense integration. - example: Partner Expense - nullable: true - accounts: - type: array - description: Array of available accounts for mapping. - nullable: true - items: - $ref: '#/components/schemas/AccountMappingInfo' - trackingCategories: - type: array - description: Array of available tracking categories for mapping. - nullable: true - items: - $ref: '#/components/schemas/TrackingCategoryMappingInfo' - taxRates: - type: array - description: Array of available tax rates for mapping. - nullable: true - items: - $ref: '#/components/schemas/TaxRateMappingInfo' + description: 'A continuation token indicating there are more results to be fetched. Supply this value in the `continuationToken` query parameter in the next request to fetch the next set of results. Once no more results are available, the continuation token will not be present in the response.' PagingInfo: type: object title: Pagination information @@ -11786,6 +2879,69 @@ components: href: '/companies/{id}/data/{dataType}' current: href: '/companies/{id}/data/{dataType}?page=1&pageSize=10' + PaymentMappingOptions: + x-internal: true + title: Mapping Options Payments + description: Gets the bill payments mapping options for a company's accounting software + type: object + properties: + bankAccounts: + type: array + items: + $ref: '#/components/schemas/PaymentMappingOptions/definitions/bankAccountMappingOption' + pagination: + $ref: '#/components/schemas/Pagination' + definitions: + bankAccountMappingOption: + title: Bank account mapping option + type: object + allOf: + - properties: + id: + type: string + description: 'Identifier for the account, unique for the company in the accounting software.' + example: 3d5a8e00-d108-4045-8823-7f342676cffa + name: + type: string + nullable: true + description: Name of the bank account in the accounting software. + example: Bank of Dave current account + 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. + 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. + currency: + type: string + nullable: true + description: The bank account's base currency. + status: + $ref: '#/components/schemas/PaymentMappingOptions/definitions/bankAccountStatus' + accountType: + $ref: '#/components/schemas/BankAccountType' + - $ref: '#/components/schemas/BankAccount/allOf/1' + bankAccountStatus: + type: string + description: The current status of the bank account. + enum: + - Active + - Archived + example: Active PullOperation: title: Pull operation description: |- @@ -11849,9 +3005,9 @@ components: nullable: true description: A message about a transient or persistent error returned by Codat or the source platform. requested: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' completed: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' progress: type: integer description: An integer signifying the progress of the pull operation. @@ -11916,10 +3072,10 @@ components: dataConnectionKey: $ref: '#/components/parameters/connectionId/schema' requestedOnUtc: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' description: The datetime when the push was requested. completedOnUtc: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' + $ref: '#/components/schemas/Connection/properties/created' description: 'The datetime when the push was completed, null if Pending.' timeoutInMinutes: type: integer @@ -12018,946 +3174,156 @@ components: 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' - RecordRef: - x-internal: true - type: object - title: Record reference - properties: - id: - type: string - example: 40e3e57c-2322-4898-966c-ca41adfd23fd - description: Identifier of linked reference from mapping options. - ReimbursableExpenseTransactionLine: - x-internal: true - title: Reimbursable expense transaction line - type: object - properties: - description: - type: string - example: 2-night hotel stay - description: line description - netAmount: - type: number - format: decimal - example: 100 - description: 'Amount of the line, exclusive of tax.' - taxAmount: - type: number - format: decimal - example: 20 - description: Amount of tax for the line. - taxRateRef: - $ref: '#/components/schemas/RecordRef' - accountRef: - description: The `accountRef` contains the `id` of the account the transaction is against. The `accountRef` object is required for all integrations except QBD which currently supports either itemRef or accountRef. - $ref: '#/components/schemas/RecordRef' - itemRef: - $ref: '#/components/schemas/ItemRef' - trackingRefs: - type: array - minItems: 1 - maxItems: 10 - nullable: true - items: - $ref: '#/components/schemas/TrackingRef' - invoiceTo: - $ref: '#/components/schemas/InvoiceTo' - required: - - netAmount - ReimbursableExpenseTransactionRequest: - title: Reimbursable expense transaction request - type: array - minItems: 1 - maxItems: 50 - items: - $ref: '#/components/schemas/ReimbursableExpenseTransactionRequest/definitions/reimbursableExpenseTransaction' - definitions: - reimbursableExpenseTransaction: - title: Reimbursable expense transaction - type: object - properties: - id: - type: string - example: 4d7c6929-7770-412b-91bb-44d3bc71d111 - format: uuid - description: Your unique identifier for the transaction. - reference: - type: string - nullable: true - description: User-friendly reference for the reimbursable expense. - contactRef: - $ref: '#/components/schemas/ReimbursementContactRef' - apAccountRef: - $ref: '#/components/schemas/apAccountRef' - issueDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: Date of the transaction was recorded. - dueDate: - description: Date the supplier is due to be paid. - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - currency: - type: string - example: GBP - description: Currency the transaction was recorded in. - currencyRate: - $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' - notes: - type: string - description: 'Any private, company notes about the transaction.' - example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - type: array - description: Array of transaction lines. - minItems: 1 - maxItems: 100 - items: - $ref: '#/components/schemas/ReimbursableExpenseTransactionLine' - required: - - id - - contactRef - - issueDate - - dueDate - - currency - ReimbursementContactRef: - type: object - title: Contact reference - x-internal: true - properties: - id: - type: string - example: 40e3e57c-2322-4898-966c-ca41adfd23fd - description: Identifier of contact. - required: - - id - SupplementalData: - title: Supplemental data - type: object - x-internal: true - description: "Supplemental data is additional data you can include in our standard data types. \n\nIt is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data." - properties: - content: - type: object - additionalProperties: - type: object - additionalProperties: true - nullable: true - Supplier: - title: 'Accounting: Supplier' - description: |- - ## Overview - - From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/sync-for-expenses-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for-expenses-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/CompanyInformation/properties/addresses/items' - registrationNumber: - type: string - nullable: true - description: 'Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House.' - taxNumber: - type: string - nullable: true - description: Supplier's company tax number. - status: - $ref: '#/components/schemas/Supplier/definitions/supplierStatus' - defaultCurrency: - type: string - nullable: true - description: Default currency the supplier's transactional data is recorded in. - metadata: - $ref: '#/components/schemas/Account/allOf/2/properties/metadata' - supplementalData: - $ref: '#/components/schemas/SupplementalData' - - $ref: '#/components/schemas/Account/allOf/3' - 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' - SyncCompleteWebhook: - title: Sync complete webhook - x-internal: true - description: Webhook request body used to notify that a sync has completed. - type: object - properties: - ClientId: - $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientId' - ClientName: - $ref: '#/components/schemas/SyncFailedWebhook/properties/ClientName' - CompanyId: - $ref: '#/components/parameters/companyId/schema' - RuleId: - $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleId' - RuleType: - $ref: '#/components/schemas/SyncFailedWebhook/properties/RuleType' - AlertId: - $ref: '#/components/schemas/SyncFailedWebhook/properties/AlertId' - Message: - $ref: '#/components/schemas/SyncFailedWebhook/properties/Message' - Data: - $ref: '#/components/schemas/SyncCompleteWebhook/definitions/SyncCompleteWebhookData' - definitions: - SyncCompleteWebhookData: - type: object - title: Sync complete webhook data - properties: - syncId: - $ref: '#/components/schemas/SyncFailedWebhook/definitions/SyncFailedWebhookData/properties/syncId' - syncType: - $ref: '#/components/schemas/SyncFailedWebhook/definitions/SyncFailedWebhookData/properties/syncType' - examples: - - ClientId: 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e - ClientName: Expense Sync - CompanyId: 1f9559e7-8368-48c9-bdf4-f158e16b8b85 - AlertId: 33a4f8e9-09ae-4334-9b00-7bbe83024672 - RuleId: 5c27631d-3b63-4b50-8228-ee502fd113eb - RuleType: Sync Completed - Message: Sync 321363b4-efa9-4fbc-b71c-0b58d62f3248 for company 1f9559e7-8368-48c9-bdf4-f158e16b8b85 of type Expense completed successfully. - Data: - syncId: 321363b4-efa9-4fbc-b71c-0b58d62f3248 - syncType: Expense - SyncFailedWebhook: - title: Sync failed webhook - x-internal: true - description: Webhook request body used to notify that a sync has failed. - 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. - CompanyId: - $ref: '#/components/parameters/companyId/schema' - 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/SyncFailedWebhook/definitions/SyncFailedWebhookData' - definitions: - SyncFailedWebhookData: - type: object - title: Sync failed webhook data - properties: - syncId: - type: string - format: uuid - example: a9367074-b5c3-42c4-9be4-be129f43577e - description: Unique identifier for the failed sync. - syncType: - type: string - description: The type of sync being performed. - FailureStage: + $ref: '#/components/schemas/PushOperation/definitions/pushChangeType' + recordRef: + $ref: '#/components/schemas/PushOperation/definitions/pushOperationRef' + attachmentId: type: string - description: The stage of the job the sync failed. - examples: - - ClientId: 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e - ClientName: Expense Sync - CompanyId: 1f9559e7-8368-48c9-bdf4-f158e16b8b85 - RuleId: 289c80dc-2aee-4b71-afff-9acd8d051080 - RuleType: Sync Failed - AlertId: 72c1103b-7f17-4a3a-8db5-67c2d360a516 - Message: Sync 3bead2a1-1b3d-4d90-8077-cddc5ca68b01 for company 1f9559e7-8368-48c9-bdf4-f158e16b8b85 of type Expense has failed at step Pushing. - Data: - syncId: 3bead2a1-1b3d-4d90-8077-cddc5ca68b01 - syncType: Expense - FailureStage: Pushing - SyncInitiated: - title: Sync initiated - type: object - properties: - syncId: - type: string - format: uuid - description: Unique identifier for the sync initiated. - additionalProperties: false - TaxRateMappingInfo: - title: Tax rate mapping info + 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' + Supplier: + title: Supplier + description: "\uFEFF\x53\x75\x70\x70\x6C\x69\x65\x72\x73\x20\x61\x72\x65\x20\x70\x65\x6F\x70\x6C\x65\x20\x6F\x72\x20\x6F\x72\x67\x61\x6E\x69\x7A\x61\x74\x69\x6F\x6E\x73\x20\x74\x68\x61\x74\x20\x70\x72\x6F\x76\x69\x64\x65\x20\x73\x6F\x6D\x65\x74\x68\x69\x6E\x67\x2C\x20\x73\x75\x63\x68\x20\x61\x73\x20\x61\x20\x70\x72\x6F\x64\x75\x63\x74\x20\x6F\x72\x20\x73\x65\x72\x76\x69\x63\x65\x2E\x20\x55\x73\x65\x20\x74\x68\x65\x20\x5B\x4C\x69\x73\x74\x20\x73\x75\x70\x70\x6C\x69\x65\x72\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x76\x32\x2D\x61\x70\x69\x23\x2F\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x73\x2F\x6C\x69\x73\x74\x2D\x73\x75\x70\x70\x6C\x69\x65\x72\x73\x29\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x72\x65\x74\x72\x69\x65\x76\x65\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x6C\x6C\x20\x73\x75\x70\x70\x6C\x69\x65\x72\x73\x20\x66\x6F\x72\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\n\n\x53\x75\x70\x70\x6C\x69\x65\x72\x73\x27\x20\x64\x61\x74\x61\x20\x6C\x69\x6E\x6B\x73\x20\x74\x6F\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x70\x61\x79\x61\x62\x6C\x65\x20\x5B\x62\x69\x6C\x6C\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x79\x6E\x63\x2D\x66\x6F\x72\x2D\x70\x61\x79\x61\x62\x6C\x65\x73\x2D\x76\x32\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x42\x69\x6C\x6C\x29\x2E\n\x20" type: object - additionalProperties: false - x-examples: - UK Tax Rate: - id: 23_Bills - name: 20% Bill tax Bills - code: 20% Bill tax - effectiveTaxRate: 20 - totalTaxRate: 20 - validTransactionTypes: - - Payment - - Reward properties: id: type: string - description: Unique identifier of tax rate. - example: 23_Bills - nullable: false - name: + description: 'Identifier for the supplier, unique to the company in the accounting software.' + supplierName: type: string - description: Name of the tax rate in the accounting software. - example: 20% Bill tax Bills - nullable: false - code: + description: 'Name of the supplier as recorded in the accounting system, typically the company name.' + contactName: type: string - description: Code for the tax rate from the accounting software. - example: 20% Bill tax nullable: true - effectiveTaxRate: - type: number - format: decimal - description: Effective tax rate. - example: 20 - totalTaxRate: - type: number - format: decimal - description: Total (not compounded) sum of the components of a tax rate. - example: 20 - validTransactionTypes: - $ref: '#/components/schemas/validTransactionTypes' - description: Supported transaction types for the tax rate. - TrackingCategoryMappingInfo: - title: Tracking category mapping info - x-internal: true - type: object - additionalProperties: false - x-examples: - Tracking Category with parentId: - id: DEPARTMENT_1 - name: TestLocation - hasChildren: false - parentId: DEPARTMENTS - Parent Tracking Category: - id: DEPARTMENTS - name: Departments - hasChildren: true - properties: - id: - type: string - description: Unique identifier of the tracking category. - example: DEPARTMENT_2 - nullable: false - name: + description: Name of the main contact for the supplier. + emailAddress: type: string - description: Name of the tracking category as it appears in the accounting software. - example: New York - nullable: false - hasChildren: - type: boolean - description: Boolean of whether the tracking category has child categories. - parentId: - type: string - description: ID of the parent tracking category - example: DEPARTMENTS nullable: true - TrackingRef: - type: object - title: Tracking reference - x-internal: true - properties: - id: - type: string - example: e9a1b63d-9ff0-40e7-8038-016354b987e6 - description: Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer. - dataType: - type: string - example: trackingCategories - default: trackingCategories - description: The type of the linked reference - enum: - - trackingCategories - - customers - TrackingRefAdjustmentTransaction: - type: object - title: Tracking reference - x-internal: true - properties: - id: - type: string - example: e9a1b63d-9ff0-40e7-8038-016354b987e6 - description: Unique identifier of the linked reference from mapping options or the unique identifier of the linked customer or supplier. - dataType: - type: string - example: trackingCategories - default: trackingCategories - description: The type of the linked reference - enum: - - trackingCategories - - customers - - suppliers - Transaction: - title: Transaction - type: object - additionalProperties: false - properties: - transactionId: + description: Email address that the supplier may be contacted on. + phone: type: string - description: Your unique idenfier of the transaction. - example: aa02271d-ed5f-47f5-be76-778d5905225a 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' status: - $ref: '#/components/schemas/TransactionStatus' - message: - type: string - description: Metadata such as validation errors or the resulting record created in the accounting software. + $ref: '#/components/schemas/Supplier/definitions/supplierStatus' + balance: + type: number + format: decimal nullable: true - integrationType: - $ref: '#/components/schemas/IntegrationType' - x-examples: - Successful Transaction: - transactionId: 8fdba4ed-e327-4925-be1a-b7a2b04627f7 - status: Completed - integrationType: expense - Unsuccessful Transaction: - transactionId: 3d694cd1-4cd9-4136-91db-32408195c6fc - status: ValidationError - message: The line item total -208.10((-195.01 + -1.09) + (-10.01 + -1.99)) must equal the transaction total -1.1 - integrationType: string - TransactionResponse: - title: Transaction response - x-internal: true - type: array - items: - $ref: '#/components/schemas/Transaction' - Transactions: - title: Transactions - x-internal: true - additionalProperties: false - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/Transaction' - - $ref: '#/components/schemas/PagingInfo' - x-examples: - Example 1: - results: - - transactionId: aa02271d-ed5f-47f5-be76-778d5905225a - status: Completed - integrationType: expenses - - transactionId: 730177a2-8505-410a-9ebc-c2dd52e4bea9 - status: Completed - integrationType: expenses - pageNumber: 1 - pageSize: 100 - totalResults: 2 - links: - self: - href: string - current: - href: string - TransactionStatus: - title: Transaction status - x-internal: true - type: string - description: Status of the transaction. - enum: - - Unknown - - Pending - - ValidationError - - Completed - - PushError - example: Completed - nullable: true - TransferTransactionRequest: - title: Transfer - type: object - properties: - description: + description: Amount outstanding against the supplier. + defaultCurrency: type: string - description: 'Any private, company notes about the transaction.' - example: Transfer from bank account Y to bank account Z - date: + nullable: true + description: Default currency the supplier's transactional data is recorded in. + sourceModifiedDate: allOf: - - description: Date of the transfer transaction as recorded in the accounting software. - - title: Date time - type: string - examples: - - 2022-10-23T00:00:00.000Z - - 2022-10-23T00:00:00.000Z - description: "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced." - from: + - $ref: '#/components/schemas/Connection/properties/created' + - description: "The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. \n\nIt is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when:\n - Pulling attachments\n - The accounting software does not provide modification dates for a data type\n - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred\n - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records\n\nIn Codat's data model, dates and times are represented using the ISO 8601 standard." + definitions: + supplierPrototype: + title: Supplier prototype type: object properties: - accountRef: - type: object - title: Account reference - description: Reference of the account you are transferring money from. - properties: - id: - type: string - description: '''id'' from the Accounts data type.' - required: - - id - amount: - type: number - format: decimal - description: Amount that has been transferred from the account in the native currency of the account. + supplierName: + $ref: '#/components/schemas/Supplier/properties/supplierName' + contactName: + $ref: '#/components/schemas/Supplier/properties/contactName' + emailAddress: + $ref: '#/components/schemas/Supplier/properties/emailAddress' + phone: + $ref: '#/components/schemas/Supplier/properties/phone' + addresses: + $ref: '#/components/schemas/Supplier/properties/addresses' + status: + $ref: '#/components/schemas/Supplier/definitions/supplierStatus' + balance: + $ref: '#/components/schemas/Supplier/properties/balance' + defaultCurrency: + $ref: '#/components/schemas/Supplier/properties/defaultCurrency' required: - - accountRef - - amount - to: + - supplierName + - status + supplierRef: + title: Supplier reference + description: Reference to the supplier the record relates to. type: object properties: - accountRef: - type: object - title: Account reference - description: Reference of the account you are transferring money to. - properties: - id: - type: string - description: '''id'' from the Accounts data type.' - required: - - id - amount: - type: number - format: decimal - description: Amount that has been transferred to the account in the native currency of the account. + id: + minLength: 1 + type: string + description: The supplier's unique ID + supplierName: + type: string + nullable: true + description: The supplier's name required: - - accountRef - - amount - required: - - date - - from - - to - TransferTransactionResponse: - title: Create transfer response - x-internal: true - type: object - properties: - syncId: - type: string - example: cd937d46-8e41-43a9-9477-a79158ffd98a - format: uuid - description: Unique id of sync created - UpdateCustomerResponse: - title: Update customer response - x-internal: true - allOf: - - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/Customer' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - UpdateExpenseRequest: - title: Updating expense transaction request - type: object - properties: - type: + - id + supplierStatus: + description: Status of the supplier. type: string - example: Payment - description: The type of transaction. enum: - - Payment - - Refund - - Reward - - Chargeback - issueDate: - type: string - description: Date the transaction was recorded. - example: '2022-06-28T00:00:00.000Z' - currency: - type: string - example: GBP - description: Currency the transaction was recorded in. - currencyRate: - $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' - contactRef: - description: Supplier or Customer for the purchase to be associated to. - $ref: '#/components/schemas/ExpenseContactRef' - bankAccountRef: + - Unknown + - Active + - Archived + suppliers: + title: Suppliers type: object - title: Bank account reference properties: - id: - type: string - example: 787dfb37-5707-4dc0-8a86-8d74e4cc78ea - description: Identifier of the bank account. - merchantName: - type: string - description: Name of the merchant where the purchase took place - example: Amazon UK - lines: - type: array - description: Array of transaction lines. - items: - $ref: '#/components/schemas/ExpenseTransactionLine' - notes: - type: string - description: 'Any private, company notes about the transaction.' - example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - required: - - type - - issueDate - - currency - UpdateExpenseResponse: - title: Update expense response - x-internal: true - type: object - properties: - syncId: - type: string - description: Unique identifier for the update expense sync. + results: + type: array + items: + $ref: '#/components/schemas/Supplier' + pagination: + $ref: '#/components/schemas/Pagination' examples: - Example 1: - syncId: 1ad0695c-4566-4715-918c-adbb03eac81e - UpdateReimbursableExpenseTransactionRequest: - title: Updating reimbursable expense transaction request - type: object - properties: - reference: - type: string - nullable: true - description: User-friendly reference for the reimbursable expense. - contactRef: - $ref: '#/components/schemas/ReimbursementContactRef' - apAccountRef: - $ref: '#/components/schemas/apAccountRef' - issueDate: - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - description: Date of the transaction was recorded. - dueDate: - description: Date the supplier is due to be paid. - $ref: '#/components/schemas/TransferTransactionRequest/properties/date/allOf/1' - currency: - type: string - example: GBP - description: Currency the transaction was recorded in. - currencyRate: - $ref: '#/components/schemas/ExpenseTransaction/properties/currencyRate' - notes: - type: string - description: 'Any private, company notes about the transaction.' - example: 'APPLE.COM/BILL - 09001077498 - Card Ending: 4590' - lines: - type: array - description: Array of transaction lines. - minItems: 1 - maxItems: 100 - items: - $ref: '#/components/schemas/ReimbursableExpenseTransactionLine' - required: - - contactRef - - issueDate - - dueDate - - currency - UpdateSupplierResponse: - title: Update supplier response - x-internal: true - allOf: - - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/Supplier' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - validFor: - title: Valid endpoints - x-internal: true - type: array - description: Supported endpoints for the account. - nullable: false - items: - type: string - enum: - - expense-transactions.Payment - - expense-transactions.Refund - - expense-transactions.Reward - - expense-transactions.Chargeback - - reimbursable-expense-transactions - - transfer-transactions - - adjustment-transactions - example: expense-transactions.Payment - validTransactionTypes: - title: Valid transaction types - x-internal: true - type: array - description: Supported transaction types for the account. - nullable: false - items: - type: string - enum: - - Payment - - Refund - - Reward - - Chargeback - example: Payment + - id: C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F + supplierName: Kelly's Industrial Supplies + contactName: Kelly Ipsum + 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' + status: Active + amount: 100 + defaultCurrency: GBP + sourceModifiedDate: '2022-10-23T00:00:00Z' parameters: - syncId: - name: syncId + attachmentId: + name: attachmentId in: path required: true schema: type: string format: uuid - example: 6fb40d5e-b13e-11ed-afa1-0242ac120002 - description: Unique identifier for a sync. - transactionId: - name: transactionId - in: path - required: true - schema: - type: string - format: uuid - example: 336694d8-2dca-4cb5-a28d-3ccb83e55eee - description: The unique identifier for your SMB's transaction. + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + description: Unique identifier for an attachment. page: name: page in: query @@ -12995,6 +3361,18 @@ components: type: string example: '-modifiedDate' description: 'Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).' + 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. companyId: name: companyId in: path @@ -13015,58 +3393,22 @@ components: 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' - supplierId: - name: supplierId - in: path - required: true - schema: - type: string - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - 7110701885 - - EILBDVJVNUAGVKRQ - description: Unique identifier for a supplier. - customerId: - name: customerId - in: path - required: true - schema: - type: string - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - 7110701885 - - EILBDVJVNUAGVKRQ - description: Unique identifier for a customer. - timeoutInMinutes: - name: timeoutInMinutes - in: query - schema: - type: integer - format: int32 - description: Time limit for the push operation to complete before it is timed out. - allowSyncOnPushComplete: - name: allowSyncOnPushComplete + continuationToken: + name: continuationToken in: query + required: false schema: - type: boolean - default: true - description: Allow a sync upon push completion. - forceUpdate: - name: forceUpdate + type: string + example: continuationToken=eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ== + description: Retrieve the next page of results using the continuation token from the previous response. + statusQuery: + name: statusQuery in: query + required: false 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.' + type: string + example: status=Archived + description: 'Codat query string allows you to filter by `status` (`status=Active||status=Archived`). [Learn more](https://docs.codat.io/using-the-api/querying) about Codat''s query string.' responses: BadRequest: description: The request made is not valid. @@ -13204,8 +3546,8 @@ components: correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 - Unprocessable-Content: - description: The requests made can't be processed. This may be due to differences in platform support. + Idempotency-Conflict: + description: A request is in progress with the same idempotency key. content: application/json: schema: @@ -13213,10 +3555,10 @@ components: examples: Conflict: value: - statusCode: 422 - service: ExpenseSyncApi - error: Expense transaction updates are not supported for platforms other than Xero. - correlationId: 7c8e23841d211c87f49f30b248f70c93 + statusCode: 409 + service: PublicApi + error: The data set has not been requested. + correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 Too-Many-Requests: diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 676805216..e1b42cf6c 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.750.0 +speakeasyVersion: 1.759.1 sources: bank-feeds-source: sourceNamespace: bank-feeds-source @@ -41,11 +41,10 @@ sources: - prealpha sync-for-payables-source: sourceNamespace: sync-for-payables-source - sourceRevisionDigest: sha256:9bd9e36fdb60e3d73fe7cc209c24ce0325919a523acec3edd84ee2f26420bedc - sourceBlobDigest: sha256:59b5c9d3aa1a43fa4186c6ae1bf1108bf40d44d22f65ed6118b763574e0cf669 + sourceRevisionDigest: sha256:ee10928721af392894e08438793212efd7a6b75bbdee31aed74521b3b8c94140 + sourceBlobDigest: sha256:1b409571a17993221df3a8ee7fff2170733baceb19a51740c47ffcc1ee7a31fd tags: - latest - - speakeasy-sdk-regen-1770645512 - 3.0.0 sync-for-payables-version-1-source: sourceNamespace: sync-for-payables-version-1-source @@ -101,10 +100,10 @@ targets: sync-for-payables-library: source: sync-for-payables-source sourceNamespace: sync-for-payables-source - sourceRevisionDigest: sha256:9bd9e36fdb60e3d73fe7cc209c24ce0325919a523acec3edd84ee2f26420bedc - sourceBlobDigest: sha256:59b5c9d3aa1a43fa4186c6ae1bf1108bf40d44d22f65ed6118b763574e0cf669 + sourceRevisionDigest: sha256:ee10928721af392894e08438793212efd7a6b75bbdee31aed74521b3b8c94140 + sourceBlobDigest: sha256:1b409571a17993221df3a8ee7fff2170733baceb19a51740c47ffcc1ee7a31fd codeSamplesNamespace: sync-for-payables-source-typescript-code-samples - codeSamplesRevisionDigest: sha256:5f88c2c6b5a989b240bab7291806e7cfa89761bf865becebb0412b83bbe74909 + codeSamplesRevisionDigest: sha256:00c5303aaa6fd9d4c5e7753483fea69105949a7444ac7c1e806f061913eb15bb sync-for-payables-version-1-library: source: sync-for-payables-version-1-source sourceNamespace: sync-for-payables-version-1-source diff --git a/sync-for-payables/.npmignore b/sync-for-payables/.npmignore index cf98a6bf0..670ac0a62 100644 --- a/sync-for-payables/.npmignore +++ b/sync-for-payables/.npmignore @@ -5,10 +5,14 @@ !/**/*.ts !/**/*.js !/**/*.mjs -!/**/*.json +!/package.json +!/jsr.json +!/dist/**/*.json +!/esm/**/*.json !/**/*.map /eslint.config.mjs +/.oxlintrc.json /cjs /.tshy /.tshy-* diff --git a/sync-for-payables/.speakeasy/gen.lock b/sync-for-payables/.speakeasy/gen.lock index bd1310bd3..8fdaa31d2 100644 --- a/sync-for-payables/.speakeasy/gen.lock +++ b/sync-for-payables/.speakeasy/gen.lock @@ -1,43 +1,43 @@ lockVersion: 2.0.0 id: fc401bb0-cd17-4863-8f85-003111be4b43 management: - docChecksum: 2c97e4172eda0b5a31c6dc31f428235d + docChecksum: 66b675d1d723d12ccffb437a1e3793aa docVersion: 3.0.0 - speakeasyVersion: 1.709.1 - generationVersion: 2.812.2 - releaseVersion: 9.3.0 - configChecksum: eb76039957333544a749c3c7cdb088ba + speakeasyVersion: 1.759.1 + generationVersion: 2.869.10 + releaseVersion: 9.3.1 + configChecksum: b2545e201431d6621510fbedf53c00c0 repoURL: https://github.com/codatio/client-sdk-typescript.git repoSubDirectory: sync-for-payables - installationURL: https://gitpkg.now.sh/codatio/client-sdk-typescript/sync-for-payables + installationURL: https://github.com/codatio/client-sdk-typescript published: true persistentEdits: - generation_id: acead2d8-1254-45eb-9a4a-ded52846926f - pristine_commit_hash: 4b1a31628b26572f81563bf5589a981b1fd80984 - pristine_tree_hash: c417f50ecda0802d3fbe751c1aeef66becba5173 + generation_id: 35a36825-074a-4d84-bbb0-671cec0d2a2e + pristine_commit_hash: d96bd81e4e27c89764df8bf535d48086a64c8a77 + pristine_tree_hash: b79bf62063a50be18e173075b8ee01090d44d217 features: typescript: additionalDependencies: 0.1.0 - constsAndDefaults: 0.1.13 - core: 3.26.27 + constsAndDefaults: 0.1.14 + core: 3.26.43 decimal: 0.1.2 defaultEnabledRetries: 0.1.0 downloadStreams: 0.1.1 enumUnions: 0.1.0 envVarSecurityUsage: 0.1.2 - examples: 2.82.4 + examples: 2.82.5 globalSecurity: 2.82.15 globalSecurityCallbacks: 0.1.0 - globalSecurityFlattening: 0.1.0 - globalServerURLs: 2.83.0 + globalSecurityFlattening: 0.1.1 + globalServerURLs: 2.83.1 methodArguments: 0.1.2 - nameOverrides: 2.81.2 + nameOverrides: 2.81.4 nullables: 0.1.1 responseFormat: 0.3.0 retries: 2.83.0 sdkHooks: 0.4.0 serverEventsSentinels: 0.1.0 - uploadStreams: 0.1.0 + uploadStreams: 0.1.1 webhooks: 1.5.1 trackedFiles: .gitattributes: @@ -46,8 +46,8 @@ trackedFiles: pristine_git_object: 113eead5093c17d43a46159132885318f281a68a .npmignore: id: aa70c1f807c3 - last_write_checksum: sha1:3d5eb92f81539175db1ff0280e0aefbdd701f200 - pristine_git_object: cf98a6bf092538eb10ff0edc915102682ce9a6e6 + last_write_checksum: sha1:6572da81f2e7a978ec29c22c2210bf461c5897b2 + pristine_git_object: 670ac0a62d7e568c9d44a14f5deafb8442a255d8 FUNCTIONS.md: id: 21b9df02aaeb last_write_checksum: sha1:0a0d27bba669518df770ad78b4e2efe9989661a0 @@ -164,6 +164,10 @@ trackedFiles: id: 6501e66b32d2 last_write_checksum: sha1:dca465bcbdfdbbbcd5768b034d226b32430ef0a3 pristine_git_object: 144ed6cd0ab3894091b385527fd93617248e9214 + docs/sdk/models/operations/updatesupplierrequest.md: + id: 1f70a198fbdf + last_write_checksum: sha1:ebf40a57c203a1488361a3b395bd469fd3f9a0cd + pristine_git_object: ae033594d29a20d0fdfa24e4fa8af02808bea0d1 docs/sdk/models/operations/uploadbillattachmentrequest.md: id: 4d0fc508b57c last_write_checksum: sha1:1b6833d55c20ff5022b26e198c1d10a9a8d2da55 @@ -178,8 +182,8 @@ trackedFiles: pristine_git_object: 9d08accad524560be3829f26f40a2dcfbadd46d0 docs/sdk/models/shared/address.md: id: c7a5d3edfbbf - last_write_checksum: sha1:e03c907fdcac6cf9267f96a1bb8c45d6f11d6897 - pristine_git_object: 7055ed058f4ffd806eb0cb6ff2e882cfaed8a9e5 + last_write_checksum: sha1:897e5d811efbfb839b6506779059ba7c607e01ea + pristine_git_object: 0484dced3fd37514b369a03814aa12e57924d147 docs/sdk/models/shared/addresstype.md: id: 05429d1d4896 last_write_checksum: sha1:a6c9f0abb0125e232f5528b78326b9d6cff713eb @@ -354,8 +358,8 @@ trackedFiles: pristine_git_object: f0a72e771acb7f304ce0ddfcab254c0dff5c6e0a docs/sdk/models/shared/supplier.md: id: 18b82dd2f554 - last_write_checksum: sha1:edfaa31f05d418469b81ce8ae8ccf3c452cf8197 - pristine_git_object: 5081b9b67f7294f928896e8f7329e8dab9cd0868 + last_write_checksum: sha1:55473cd8c50a0885ce35dd6aad9ae044a4397ddd + pristine_git_object: 4eac748f59ced787572fc32d62325b9aecbdde75 docs/sdk/models/shared/supplierprototype.md: id: a27221eee44d last_write_checksum: sha1:ddba8dad1749525662b8584769a81031984966e4 @@ -366,8 +370,8 @@ trackedFiles: pristine_git_object: c08bc8af699c692baec90a5d13dc6a3135dabd5e docs/sdk/models/shared/suppliers.md: id: 09016bddb305 - last_write_checksum: sha1:42ec2a4d1f9f4195ec8e1d8057b5713368ef19ed - pristine_git_object: fe9207d440aadfe4135b435198cf7a5219f765d3 + last_write_checksum: sha1:3eff0a8f68d1570c89d96f1799062d1520c7ee8a + pristine_git_object: d2581385bb9f823ed5fde53583e801ea3c937937 docs/sdk/models/shared/supplierstatus.md: id: 51c838d3b574 last_write_checksum: sha1:7544360314ae26a33bbf7b9208071dd2bbe3f774 @@ -386,8 +390,8 @@ trackedFiles: pristine_git_object: ca27b21833be5f0fdf1d881925f1ff78ad069828 docs/sdks/bankaccounts/README.md: id: 510ffee224ea - last_write_checksum: sha1:9c7c1463ccd19d91cce4534e7b25ed02ebcec2bc - pristine_git_object: db9df7c371199f7b719a7cee753f8d65abfb503d + last_write_checksum: sha1:35cdd88fcbf66d90e885dee71068e338ab4637ad + pristine_git_object: 432e19e5a357e41b8ee7d934f089cbc61b8caab5 docs/sdks/billpayments/README.md: id: 9436cf9c44bd last_write_checksum: sha1:ef4376c2d72147a0f042f0f53a56f99afc45f3b4 @@ -410,8 +414,8 @@ trackedFiles: pristine_git_object: 452a258b593b694757e26817c56f6fe1a51fc3d9 docs/sdks/suppliers/README.md: id: 85867190cd79 - last_write_checksum: sha1:39cbdf19ec3edd6615a9aa57250e36a3987b0f9e - pristine_git_object: dfc03ec5304835b004c45b9a6e6e611c09861740 + last_write_checksum: sha1:13aab7180271a534e9db0c6a7f0ba52b5f1dd529 + pristine_git_object: 059dfa32c662ed67966d472fa81f30d129399c4c eslint.config.mjs: id: 461c8d07f6da last_write_checksum: sha1:9398f326377fe47f67af2df6eb6370750c0790b4 @@ -434,112 +438,116 @@ trackedFiles: pristine_git_object: 978c98ebda9a2b1f9ea0961b7a06643f604d1d24 jsr.json: id: 7f6ab7767282 - last_write_checksum: sha1:c6b3f0829d9e0c044498adbd9a6f5a4b79beeb06 - pristine_git_object: 0cb5b5775a7680695fc5d2c1ee7a137c8274980d + last_write_checksum: sha1:a40d242c2f6aefda2209fdd94bf91e149440135a + pristine_git_object: afcc356c8c6e6325c403d4e1eeb5c867a845e6d5 package.json: id: 7030d0b2f71b - last_write_checksum: sha1:aaeff6d243afdfa522559b767dec7ff92fcfe163 - pristine_git_object: 7b0eb141c13e8964955e10403880be3c51d78101 + last_write_checksum: sha1:87a1a2c8c76fec940b602cccb5803dbc24994b14 + pristine_git_object: 7ece72f1df47eb720adbbe73552b6d5a783150b6 src/core.ts: id: f431fdbcd144 last_write_checksum: sha1:8ac194d8a86c95d66ff881034c874004f103d6e8 pristine_git_object: 3ef31d3371427926066c0f46d57f38b6872442b6 src/funcs/bankAccountsCreate.ts: id: c61c77ddef33 - last_write_checksum: sha1:c93a1a2c74ad4990f21d45132c82b50a584ef173 - pristine_git_object: fe656e7dee0d91cb642227ffb405fd95bf931770 + last_write_checksum: sha1:4aedeefdc7b65646737c872cf01f44cab047cc74 + pristine_git_object: c3ff3ed109d1a57047bd8d1acaae3615a083b2a3 src/funcs/billPaymentsCreate.ts: id: 4a7573a8ef1f - last_write_checksum: sha1:01d1a9d56aa947bfe9fe487bf7ce46442daa89d7 - pristine_git_object: eedfe8bc9e32f7f83413a14f907d519cc8859d7a + last_write_checksum: sha1:444a08cc613e0535033d9d12c3f3ce96be420acd + pristine_git_object: 882a67539ce45987211a8cf0d2cb64c1f92f7112 src/funcs/billPaymentsGetPaymentOptions.ts: id: 3dcdf22bd7f2 - last_write_checksum: sha1:c8eda6776285be2f42eccb221dcd63a98d55d524 - pristine_git_object: 25d0eebc4664a60e26fa36f143d6c469e3ab17c7 + last_write_checksum: sha1:74781e3bb9398c22cc93304b16e71597f3ad0684 + pristine_git_object: f042d24e98a600704d907399ab7b725eb36c528b src/funcs/billsCreate.ts: id: 75c376a468d4 - last_write_checksum: sha1:2632148f69966b72a0e910e9917ee1a1681a5929 - pristine_git_object: f9dfea6479db28cce0046f4d8fc15bfd00a9d55f + last_write_checksum: sha1:0eba28f6a888557b9f6f0d8c05a4ed638d538453 + pristine_git_object: c84752311dd168a460e19d7cec9d22542071fe9c src/funcs/billsDownloadAttachment.ts: id: 2e4c12e9ceeb - last_write_checksum: sha1:13150629f6e9894f18357b024728ee853344a054 - pristine_git_object: db77db9c68c6c7b71375c6e205c969d1cd47bdcf + last_write_checksum: sha1:3bb0b9e40bdd46ad8d7824b2e9982d4d1d755276 + pristine_git_object: 475a3bbcd85c2bb1eafb54a50fedb76b55caecf3 src/funcs/billsGetBillOptions.ts: id: 5872e47fa14f - last_write_checksum: sha1:8f8b18f4b04546fc429d2730cdb9f404cdd56f91 - pristine_git_object: a7adecc0138f125a4e10650d090e464c06977d04 + last_write_checksum: sha1:cfbf410d40fbf30aba5a69d7018a330c2463acf8 + pristine_git_object: cfe0b76555f8a6d5bfb665ebdf30986c53925e64 src/funcs/billsList.ts: id: 7cc1b84a3584 - last_write_checksum: sha1:b70e56ef264691a393a19310f2312df37441c73c - pristine_git_object: 99bb285579ee252a9afe1ec6a25dc30ff6622065 + last_write_checksum: sha1:1759fa2e093755e46fc824173544372bee599ac8 + pristine_git_object: e776abb6ac82ea1ab1c65e53d56929d3b3bb212d src/funcs/billsListAttachments.ts: id: 116a7b452f5c - last_write_checksum: sha1:daa08113502a895da2c9034fb34c7fa1991029c3 - pristine_git_object: 2a8fd61dd7fa0be4aeb7b9db027f785da97888f0 + last_write_checksum: sha1:b99359be56e4aad9b5e8342d28398bf1af2e5163 + pristine_git_object: 7d43c85a42461ec524986ab1ea8e76a4bc0e5377 src/funcs/billsUpdate.ts: id: a652cf860449 - last_write_checksum: sha1:d1481a9aa3b0e23e19f567047d88318d8ee4ab3b - pristine_git_object: bcf5448414a1dbb1e3081803c0bec87405f6a9be + last_write_checksum: sha1:7a0d43c9bdc5c9a4a8b503d1b321e2a77e715562 + pristine_git_object: ffdf57fed871c050db4b166e8535696e9c239bad src/funcs/billsUploadAttachment.ts: id: d7311d53bc2f - last_write_checksum: sha1:1fb8e84e689008f91f420ba5cf7b6f3792980e25 - pristine_git_object: c7cbf43de1026d5ab605161cab5a9cc0d435798a + last_write_checksum: sha1:35d0c574fea1dbb5e99fc1150642b68572d0c0d6 + pristine_git_object: 80ce15bd9cfbcfc02ef7f7a8c35a099cdfcb7596 src/funcs/companiesCreate.ts: id: becfb79b6222 last_write_checksum: sha1:498233a67b41aac2f783e6a69cc9fbc4ffafa76b pristine_git_object: 3088009cb98e3f7f31aeb9e9b8257301d2b30e15 src/funcs/companiesDelete.ts: id: d4b8d3c15935 - last_write_checksum: sha1:3a8cb186b7e28f222f7c90a0c0eb1f45f99863de - pristine_git_object: 23698d50d44454a11de7b12d2546b92114337af6 + last_write_checksum: sha1:2ab2ecd1f5389be634b35c71f73613e921df8595 + pristine_git_object: 150318df2b0f9e83654f1091b776a48a78d66adf src/funcs/companiesGet.ts: id: 497c5e9320c2 - last_write_checksum: sha1:feb6f9520bd230594c517b4a72549bae841213d0 - pristine_git_object: 4aa95221177994b306ef29ea5707588e744b28e2 + last_write_checksum: sha1:1e0ae2ab01b3d3c8893d93383460939a03c119a6 + pristine_git_object: a951fc7338a735009a8c7caab4268541f9c4afcb src/funcs/companiesList.ts: id: c57fb769a99c last_write_checksum: sha1:765673601ed79ee2d140cf250fffb0300506a242 pristine_git_object: 647b990e9de66a329ff27230177f6a79428833c3 src/funcs/companiesReplace.ts: id: c141cb91cc73 - last_write_checksum: sha1:4a52e307199aec90ed0f912648426e1e75c51abb - pristine_git_object: 3acad3d8f9e56572c9f498a79efefaa19c986446 + last_write_checksum: sha1:e55f386706b4c18d77788d78962b75d2949d349a + pristine_git_object: 5e270df4085f5c2563aa0fd7ccb2dc492d2ec9a4 src/funcs/companiesUpdate.ts: id: e3d7bd676c21 - last_write_checksum: sha1:2ba58cebbc4076061896990a8bf1f2a69c4702b7 - pristine_git_object: 725ab14763731f3c5c62cb7a725d7ab023ffe11c + last_write_checksum: sha1:c5ce9a8ee2af326b660f9e82c5ff67c67123fd45 + pristine_git_object: 6d55577b2445e39679da050791d8a2788e2c61e8 src/funcs/companyInformationGet.ts: id: d77e867a25e9 - last_write_checksum: sha1:f409c19096e7986dd8c53272078b2599ee141c0d - pristine_git_object: c3a59e1123db03a1e86d45a442a3438278ca4425 + last_write_checksum: sha1:9bb712f11b3e43a6dd71ea05230c7a80ab57d892 + pristine_git_object: 7b50da07c79e05ebdf75a2bc32deb87d24e1923c src/funcs/connectionsCreate.ts: id: 0423cc2d060b - last_write_checksum: sha1:61cd6d74c9838c3f5d265a1ebb9644b87c1a1aae - pristine_git_object: 8f5d134f1a6d919e8dbcce4d52c1d142cce8967f + last_write_checksum: sha1:5244c61027af98a5484581d682d1e8b6e83d90e3 + pristine_git_object: f49a47f9c82d8caaaa19e342e3496c7b952c2e82 src/funcs/connectionsDelete.ts: id: f33b14b4a39d - last_write_checksum: sha1:d73d6dd4f8e3f96eb7ed05f4d0d4a5b6e2155bfc - pristine_git_object: debe3fb4c025730076939c8380c7cbb84564881b + last_write_checksum: sha1:f1162764c5d4f3048d6165edf75a4a823b8bee75 + pristine_git_object: 55d0f7f67e5218a0fab6bba8fa444afe54d5a142 src/funcs/connectionsGet.ts: id: 6a1b6227b285 - last_write_checksum: sha1:5fa6564bf8e9dd18d9d4946f6d2839930bca3a0b - pristine_git_object: 1e813fe5d7fae31f4ceb4aa64f41126c9c98da42 + last_write_checksum: sha1:bf8d34ac015f5843555325c2c37d87c9864e55ec + pristine_git_object: 972e332896faaf8b8d1b138bf0cb946ecc5b9e7c src/funcs/connectionsList.ts: id: ca36cb8b50d3 - last_write_checksum: sha1:998a5edd3129f7cea73bcedd3c48066ce1d04dc5 - pristine_git_object: 4ab0abc7550cae02f01282f4d4b2a339b08b9c4a + last_write_checksum: sha1:f475d8b0bfce9d2bb666aa8a3ccb1c4cc071090b + pristine_git_object: 1e7d60812118969ca583aaea55ac257bb5403042 src/funcs/connectionsUnlink.ts: id: 0ff9d29a8016 - last_write_checksum: sha1:45598db37d1bcf450229bd1ec4b436039bb9dc27 - pristine_git_object: 3e0a90b6c0d263a49943535133343d5b7ce1a251 + last_write_checksum: sha1:98ced888e700c29268a0d866e8e31d1e4ac78e5c + pristine_git_object: 0dc33eb10046e9171d85f290f82d8458f2412dae src/funcs/suppliersCreate.ts: id: ff2ee5ff481f - last_write_checksum: sha1:9717ea5f864184ec8989ae15abaa94c0f4e3a2d5 - pristine_git_object: 5e3dad5c51ceec40bf3347bb90560293dcb355f2 + last_write_checksum: sha1:8ccbfdf9e6e6e1f9cefe3754d2965d78f5fa067c + pristine_git_object: 0d8100cb62e95b2fa0f1072b8a7b23e082edf836 src/funcs/suppliersList.ts: id: ae0c2ccb6871 - last_write_checksum: sha1:f80380a734779e9b27fc35ce6dcb1edca5d2de8a - pristine_git_object: 8133e20e38a550a2e3d8a0509374c9515b9de812 + last_write_checksum: sha1:e0636f0f82c31b7cf7065084b14456ab3433338d + pristine_git_object: df736ae4457f77779dd389046d05178d00615d5f + src/funcs/suppliersUpdate.ts: + id: c36b960e49de + last_write_checksum: sha1:50e5ac4b0db30f159e2cda4615a9af9a9510264a + pristine_git_object: 129cccdaeffc23f6d96ebb11f4d9b96b3678ecbc src/funcs/validateWebhook.ts: id: f3ebc1bebb84 last_write_checksum: sha1:1e69504955d7b8a8b9f0f25f7760f18dcbe7f2f9 @@ -566,8 +574,8 @@ trackedFiles: pristine_git_object: 0aebd8b0a4867e35cb3348fc52921c3c0b4725b7 src/lib/config.ts: id: 320761608fb3 - last_write_checksum: sha1:390a98b7d59665baee40b7eeb5276a8b9ed11761 - pristine_git_object: fd701a606a0cdedc02bcc0bacf3e0fcb1cfe8b20 + last_write_checksum: sha1:4cf318816880eddd1b9dd4bda474ae9dcc25c05d + pristine_git_object: 4ca670297e656274d0bc6f6a1a552ab363332117 src/lib/dlv.ts: id: b1988214835a last_write_checksum: sha1:1dd3e3fbb4550c4bf31f5ef997faff355d6f3250 @@ -578,8 +586,8 @@ trackedFiles: pristine_git_object: 31cd3733907afbee3641b9ab680ed417247a7d33 src/lib/files.ts: id: e5efa54fcb95 - last_write_checksum: sha1:d0f325f445b8d22e7d73baf052c585ec2dd24841 - pristine_git_object: 0344cd046d033f9e8a55de02f7935c5cec5dc30b + last_write_checksum: sha1:795c14026405d547bfc47012f7ad9666e530fa7f + pristine_git_object: 6ca6b37d35a12448da176ee2517cc036db12c81c src/lib/http.ts: id: 63a80782d37e last_write_checksum: sha1:797cbf16d3c7c4d62d3ba0eedb08617524938457 @@ -594,8 +602,8 @@ trackedFiles: pristine_git_object: d181f2937d4128afbe9b0327e0f81d1fa9c877b7 src/lib/matchers.ts: id: d54b2253b719 - last_write_checksum: sha1:80ff3dfb638ef4b45a55dcb63de0c0e834016829 - pristine_git_object: 41b6095f00172c59b69e9862644563edca5e2fc6 + last_write_checksum: sha1:4775ae173392e86f356bb1ffd0d16f3c2d7b0d54 + pristine_git_object: b096d6f201a8f1b24dea405dc0cb1c75efdf4c97 src/lib/primitives.ts: id: 74859f750b28 last_write_checksum: sha1:987869fc54790b9c22e9182099103d6aa7c67016 @@ -610,16 +618,16 @@ trackedFiles: pristine_git_object: dc2510e330727b01894e4d3954ea92a62c962e5d src/lib/sdks.ts: id: 8a6d91f1218d - last_write_checksum: sha1:18da4753f916af929ae4a2445b13b09c23e1cc6f - pristine_git_object: 126029ae98e4c0ceb16ccfa40f8dd82890dd3193 + last_write_checksum: sha1:66d56bfdbd12a17c58ca2b03f6b10b1c34380dbe + pristine_git_object: 43fcf336ef4986ed91de77f38e0cc8b3d9c4ed76 src/lib/security.ts: id: 0502afa7922e - last_write_checksum: sha1:c04a467e412cdd09a03239de17aa7d6a9afc246e - pristine_git_object: c87ebc333707850c74a6800b73d7e1bb26c27367 + last_write_checksum: sha1:3d00348fcb3784d76766bd94dc1da51f67bdaaa4 + pristine_git_object: 5d93cd4a14174e63dea219d284ce12764a9c6c2b src/lib/url.ts: id: b0057e24ed76 - last_write_checksum: sha1:d124050c7e755c0cce233b9e029afb584ff65201 - pristine_git_object: f3a8de6c021de59c991707946cd294596cae954d + last_write_checksum: sha1:3bceadd74bf0b31adf13eb06b7531077c3e07d65 + pristine_git_object: 79e7ce660b3732053e3adcbb5a4cdeb51496e8aa src/sdk/bankaccounts.ts: id: 0f1139473f13 last_write_checksum: sha1:3295d6179393edad7b55a050008dddbf12e51420 @@ -730,8 +738,8 @@ trackedFiles: pristine_git_object: e3abe91dc20b75266936498daa6a04e90f407226 src/sdk/models/operations/index.ts: id: b2864d0519d7 - last_write_checksum: sha1:4934cad9df052a399535eac591d0bc05d118d013 - pristine_git_object: 12cda2c10abda85b69ff014ab7541de1c155eb2b + last_write_checksum: sha1:505fcd8ef9c4021c8f11e4f52ba6a26d89708c63 + pristine_git_object: 278d9d3bd729e5277ccc305c15ed1a51567a9567 src/sdk/models/operations/listbillattachments.ts: id: 4c9488a771ad last_write_checksum: sha1:4ce52025b4b566e46e0a3a1795becd64d7c094c3 @@ -768,6 +776,10 @@ trackedFiles: id: dbafb9e0f8d9 last_write_checksum: sha1:937aaa5e965aae942c6550456dbe3c37b5d2b280 pristine_git_object: 37ead4428659b0b2409ad7f6cf54515e544e23ec + src/sdk/models/operations/updatesupplier.ts: + id: 4c259e646cb1 + last_write_checksum: sha1:f7d37623859257edb9c452c9bf05304f4b624ef6 + pristine_git_object: 69cdde755d3f6e1f106524bb138115c4cdafa604 src/sdk/models/operations/uploadbillattachment.ts: id: db82a18c5aa9 last_write_checksum: sha1:ed1546769f4039b3e5b351a6013e924a437a3f2e @@ -782,8 +794,8 @@ trackedFiles: pristine_git_object: 8f89f1c6fc0a40ed9a5440d98a70b49ce86b1e4c src/sdk/models/shared/address.ts: id: 123dc664e6b6 - last_write_checksum: sha1:a570c829903b69bc114de0f5027ee7f0dce0329e - pristine_git_object: 25111ed9c84f2619fd0012d07ca6411ca5d5b70c + last_write_checksum: sha1:6bc0bae915301145ca09163fd65e12ffca447061 + pristine_git_object: d40d6e69a20e6a68ca3550a3f31edfc159ec6765 src/sdk/models/shared/addresstype.ts: id: 8f46715578d6 last_write_checksum: sha1:2a3313224e8bededfc7da6294878909847d1ba05 @@ -978,8 +990,8 @@ trackedFiles: pristine_git_object: 2da7d5fa26cf928d1e02acb3582f573f276d1fe4 src/sdk/suppliers.ts: id: 68b234e74022 - last_write_checksum: sha1:4a4af579d918d24a331e295aefc4f22703ebba27 - pristine_git_object: 7de8009b57e7eecd506d69efec2343ac2d9bb73d + last_write_checksum: sha1:f3d5cb6caebe97f3e980c7292271713ee41aaf24 + pristine_git_object: 0ad27777da8c0a83c50f81d5a5061610dbf4be79 src/sdk/types/async.ts: id: 966026768b05 last_write_checksum: sha1:3ff07b3feaf390ec1aeb18ff938e139c6c4a9585 @@ -1030,8 +1042,8 @@ trackedFiles: pristine_git_object: 9510d20c09d8dd689f6e37254030de22e997f3cc tsconfig.json: id: 61ebb9fd6e8c - last_write_checksum: sha1:c3ec7996536cdb9a54319e7d1eb3b199b733d34c - pristine_git_object: 0ccdbe286a8780e06a469a9eb7e2fb95322fd507 + last_write_checksum: sha1:79dc1550d921fefec69f8632ed3b24dad41ca2f6 + pristine_git_object: 76110f883cac40bb04fb2f376cd69ea8c8d6d215 examples: list-companies: speakeasy-default-list-companies: @@ -1871,7 +1883,7 @@ examples: continuationToken: "continuationToken=eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ==" responses: "200": - application/json: {"results": [{"id": "c523e12f-8b74-4d3a-bbd8-32d7a2f598b4", "supplierName": "City Limousines", "contactName": "Martin Dale", "emailAddress": "martyd@citylim.co", "phone": "07999 999999", "addresses": [{"type": "Billing", "line1": "Unit 51", "line2": "Bakersfield Industrial Estate", "city": "Bakersfield", "region": "California", "country": "USA"}], "status": "Active", "balance": 100, "defaultCurrency": "GBP", "sourceModifiedDate": "2022-10-23T00:00:00Z"}, {"id": "41", "supplierName": "AI Support", "contactName": "AI Support", "addresses": [{"type": "Billing", "line1": "test", "region": "string", "country": "Djibouti"}], "status": "Active", "defaultCurrency": "GBP", "sourceModifiedDate": "2022-12-07T10:48:18Z"}], "pagination": {"continuationToken": "eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ=="}} + application/json: {"results": [{"id": "c523e12f-8b74-4d3a-bbd8-32d7a2f598b4", "supplierName": "City Limousines", "contactName": "Martin Dale", "emailAddress": "martyd@citylim.co", "phone": "07999 999999", "addresses": [{"type": "Billing", "line1": "Unit 51", "line2": "Bakersfield Industrial Estate", "city": "Bakersfield", "region": "California", "country": "USA", "postalCode": "93308"}], "status": "Active", "balance": 100, "defaultCurrency": "GBP", "sourceModifiedDate": "2022-10-23T00:00:00Z"}, {"id": "41", "supplierName": "AI Support", "contactName": "AI Support", "addresses": [{"type": "Billing", "line1": "test", "region": "string", "country": "Djibouti"}], "status": "Active", "defaultCurrency": "GBP", "sourceModifiedDate": "2022-12-07T10:48:18Z"}], "pagination": {"continuationToken": "eyJwYWdlIjoyLCJwYWdlU2l6ZSI6MTAwLCJwYWdlQ291bnQiOjExfQ=="}} Malformed query: parameters: path: @@ -1903,10 +1915,10 @@ examples: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" requestBody: - application/json: {"supplierName": "Greggs", "contactName": "Greg Greggs", "emailAddress": "greg@greggs.com", "phone": "+44 (0)1223 322410", "addresses": [{"type": "Billing", "line1": "Flat 1", "line2": "2 Dennis Avenue", "city": "London", "region": "Camden", "country": "GBR", "postalCode": "EC1N 7TE"}], "status": "Active", "defaultCurrency": "GBP"} + application/json: {"supplierName": "Northridge Office Supplies", "contactName": "Sarah Johnson", "emailAddress": "sarah.johnson@northridgesupplies.co.uk", "phone": "+44 (0)1223 322410", "addresses": [{"type": "Billing", "line1": "Flat 1", "line2": "2 Dennis Avenue", "city": "London", "region": "Camden", "country": "GB", "postalCode": "EC1N 7TE"}], "status": "Active", "defaultCurrency": "GBP"} responses: "201": - application/json: {"id": "sup-10933920", "supplierName": "Greggs", "contactName": "Greg Greggs", "emailAddress": "greg@greggs.com", "phone": "+44 (0)1223 322410", "status": "Active", "defaultCurrency": "GBP"} + application/json: {"id": "sup-10933920", "supplierName": "Northridge Office Supplies", "contactName": "Sarah Johnson", "emailAddress": "sarah.johnson@northridgesupplies.co.uk", "phone": "+44 (0)1223 322410", "addresses": [{"type": "Billing", "line1": "Flat 1", "line2": "2 Dennis Avenue", "city": "London", "region": "Camden", "country": "GB", "postalCode": "EC1N 7TE"}], "status": "Active", "balance": 0, "defaultCurrency": "GBP", "sourceModifiedDate": "2026-03-18T10:30:00Z"} Malformed query: parameters: path: @@ -1960,6 +1972,16 @@ examples: application/json: {} "500": application/json: {} + Created bank account: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + requestBody: + application/json: {"name": "", "accountType": "Debit", "accountNumber": "", "currency": "GBP"} + responses: + "201": + application/json: {"id": "fb623ab2-f6ff-4b22-b7d3-b7cc2a4aa0ea", "nominalCode": "22", "name": "Plutus - Payables - Bank Account 12", "accountType": "Debit", "accountNumber": "0120 0440", "sortCode": "50-50-50", "currency": "GBP", "status": "Active", "sourceModifiedDate": "2024-02-22T14:46:43.99Z"} update-bill: Update bill: parameters: @@ -2000,11 +2022,51 @@ examples: application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} "500": application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + update-supplier: + Update supplier: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" + requestBody: + application/json: {"supplierName": "Northridge Office Supplies", "contactName": "Sarah Johnson", "emailAddress": "sarah.johnson@northridgesupplies.co.uk", "phone": "+44 (0)1223 322410", "addresses": [{"type": "Billing", "line1": "Flat 1", "line2": "2 Dennis Avenue", "city": "London", "region": "Camden", "country": "GB", "postalCode": "EC1N 7TE"}], "status": "Active", "defaultCurrency": "GBP"} + responses: + "200": + application/json: {"id": "sup-10933920", "supplierName": "Northridge Office Supplies", "contactName": "Sarah Johnson", "emailAddress": "sarah.johnson@northridgesupplies.co.uk", "phone": "+44 (0)1223 322410", "addresses": [{"type": "Billing", "line1": "Flat 1", "line2": "2 Dennis Avenue", "city": "London", "region": "Camden", "country": "GB", "postalCode": "EC1N 7TE"}], "status": "Active", "balance": 0, "defaultCurrency": "GBP", "sourceModifiedDate": "2026-03-18T10:30:00Z"} + "400": + application/json: {} + "500": + application/json: {} + Updated supplier: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" + requestBody: + application/json: {"supplierName": "", "phone": "+44 25691 154789", "status": "Active"} + responses: + "200": + application/json: {"id": "sup-10933920", "supplierName": "Northridge Office Supplies", "contactName": "Sarah Johnson", "emailAddress": "sarah.johnson@northridgesupplies.co.uk", "phone": "+44 (0)1223 322410", "addresses": [{"type": "Billing", "line1": "Flat 1", "line2": "2 Dennis Avenue", "city": "London", "region": "Camden", "country": "GB", "postalCode": "EC1N 7TE"}], "status": "Active", "balance": 0, "defaultCurrency": "GBP", "sourceModifiedDate": "2026-03-18T10:30:00Z"} + Malformed query: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab" + requestBody: + application/json: {"supplierName": "", "phone": "+44 25691 154789", "status": "Active"} + responses: + "400": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} + "500": + application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0} examplesVersion: 1.0.2 generatedTests: {} releaseNotes: | ## Typescript SDK Changes: - * `codatsyncpayables.bills.update()`: **Added** + * `codatsyncpayables.suppliers.update()`: **Added** generatedFiles: - .gitattributes - .npmignore diff --git a/sync-for-payables/.speakeasy/gen.yaml b/sync-for-payables/.speakeasy/gen.yaml index 7b2a5b6f6..710f4bfe3 100644 --- a/sync-for-payables/.speakeasy/gen.yaml +++ b/sync-for-payables/.speakeasy/gen.yaml @@ -14,6 +14,7 @@ generation: securityFeb2025: false sharedErrorComponentsApr2025: false sharedNestedComponentsJan2026: false + nameOverrideFeb2026: false auth: oAuth2ClientCredentialsEnabled: false oAuth2PasswordEnabled: false @@ -29,7 +30,7 @@ generation: skipResponseBodyAssertions: false telemetryEnabled: true typescript: - version: 9.3.0 + version: 9.3.1 acceptHeaderEnum: true additionalDependencies: dependencies: {} @@ -84,4 +85,6 @@ typescript: unionStrategy: left-to-right usageSDKInitImports: [] useIndexModules: true + useOxlint: false + useTsgo: false zodVersion: v3 diff --git a/sync-for-payables/README.md b/sync-for-payables/README.md index d271e8094..e3150b693 100644 --- a/sync-for-payables/README.md +++ b/sync-for-payables/README.md @@ -112,6 +112,7 @@ run(); * [list](docs/sdks/suppliers/README.md#list) - List suppliers * [create](docs/sdks/suppliers/README.md#create) - Create supplier +* [update](docs/sdks/suppliers/README.md#update) - Update supplier @@ -220,6 +221,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). - [`connectionsUnlink`](docs/sdks/connections/README.md#unlink) - Unlink connection - [`suppliersCreate`](docs/sdks/suppliers/README.md#create) - Create supplier - [`suppliersList`](docs/sdks/suppliers/README.md#list) - List suppliers +- [`suppliersUpdate`](docs/sdks/suppliers/README.md#update) - Update supplier @@ -452,19 +454,23 @@ The `HTTPClient` constructor takes an optional `fetcher` argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures. -The following example shows how to use the `"beforeRequest"` hook to to add a -custom header and a timeout to requests and how to use the `"requestError"` hook -to log errors: +The following example shows how to: +- route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent +- use the `"beforeRequest"` hook to add a custom header and a timeout to requests +- use the `"requestError"` hook to log errors ```typescript import { CodatSyncPayables } from "@codat/sync-for-payables"; +import { ProxyAgent } from "undici"; import { HTTPClient } from "@codat/sync-for-payables/lib/http"; +const dispatcher = new ProxyAgent("http://proxy.example.com:8080"); + const httpClient = new HTTPClient({ - // fetcher takes a function that has the same signature as native `fetch`. - fetcher: (request) => { - return fetch(request); - } + // 'fetcher' takes a function that has the same signature as native 'fetch'. + fetcher: (input, init) => + // 'dispatcher' is specific to undici and not part of the standard Fetch API. + fetch(input, { ...init, dispatcher } as RequestInit), }); httpClient.addHook("beforeRequest", (request) => { diff --git a/sync-for-payables/RELEASES.md b/sync-for-payables/RELEASES.md index af724b7b4..70ec654f5 100644 --- a/sync-for-payables/RELEASES.md +++ b/sync-for-payables/RELEASES.md @@ -98,4 +98,14 @@ Based on: ### Generated - [typescript v9.3.0] sync-for-payables ### Releases -- [NPM v9.3.0] https://www.npmjs.com/package/@codat/sync-for-payables/v/9.3.0 - sync-for-payables \ No newline at end of file +- [NPM v9.3.0] https://www.npmjs.com/package/@codat/sync-for-payables/v/9.3.0 - sync-for-payables + +## 2026-03-23 11:36:03 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.759.1 (2.869.10) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v9.3.1] sync-for-payables +### Releases +- [NPM v9.3.1] https://www.npmjs.com/package/@codat/sync-for-payables/v/9.3.1 - sync-for-payables \ No newline at end of file diff --git a/sync-for-payables/docs/sdk/models/operations/updatesupplierrequest.md b/sync-for-payables/docs/sdk/models/operations/updatesupplierrequest.md new file mode 100644 index 000000000..ae033594d --- /dev/null +++ b/sync-for-payables/docs/sdk/models/operations/updatesupplierrequest.md @@ -0,0 +1,22 @@ +# UpdateSupplierRequest + +## Example Usage + +```typescript +import { UpdateSupplierRequest } from "@codat/sync-for-payables/sdk/models/operations"; + +let value: UpdateSupplierRequest = { + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `supplierId` | *string* | :heavy_check_mark: | Unique identifier for a supplier. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `supplierPrototype` | [shared.SupplierPrototype](../../../sdk/models/shared/supplierprototype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/sync-for-payables/docs/sdk/models/shared/address.md b/sync-for-payables/docs/sdk/models/shared/address.md index 7055ed058..0484dced3 100644 --- a/sync-for-payables/docs/sdk/models/shared/address.md +++ b/sync-for-payables/docs/sdk/models/shared/address.md @@ -10,12 +10,12 @@ let value: Address = {}; ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | [shared.AddressType](../../../sdk/models/shared/addresstype.md) | :heavy_minus_sign: | The type of the address | -| `line1` | *string* | :heavy_minus_sign: | Line 1 of the customer address. | -| `line2` | *string* | :heavy_minus_sign: | Line 2 of the customer address. | -| `city` | *string* | :heavy_minus_sign: | City of the customer address. | -| `region` | *string* | :heavy_minus_sign: | Region of the customer address. | -| `country` | *string* | :heavy_minus_sign: | Country of the customer's address. For NetSuite, use the 2-digit [ISO 3166](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. | -| `postalCode` | *string* | :heavy_minus_sign: | Postal code or zip code. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | [shared.AddressType](../../../sdk/models/shared/addresstype.md) | :heavy_minus_sign: | The type of the address | +| `line1` | *string* | :heavy_minus_sign: | Line 1 of the customer address. | +| `line2` | *string* | :heavy_minus_sign: | Line 2 of the customer address. | +| `city` | *string* | :heavy_minus_sign: | City of the customer address. | +| `region` | *string* | :heavy_minus_sign: | Region of the customer address. | +| `country` | *string* | :heavy_minus_sign: | Country of the address. We recommend using the 2-digit ISO 3166 country code (e.g. `GB`, `US`, `FR`) as this is accepted by all supported platforms. | +| `postalCode` | *string* | :heavy_minus_sign: | Postal code or zip code. | \ No newline at end of file diff --git a/sync-for-payables/docs/sdk/models/shared/supplier.md b/sync-for-payables/docs/sdk/models/shared/supplier.md index 5081b9b67..4eac748f5 100644 --- a/sync-for-payables/docs/sdk/models/shared/supplier.md +++ b/sync-for-payables/docs/sdk/models/shared/supplier.md @@ -9,26 +9,29 @@ Suppliers' data links to accounts payable [bills](https://docs.codat.io/sync-for ```typescript import { Supplier } from "@codat/sync-for-payables/sdk/models/shared"; +import { Decimal } from "@codat/sync-for-payables/sdk/types"; let value: Supplier = { - id: "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F", - supplierName: "Kelly's Industrial Supplies", - contactName: "Kelly Ipsum", - emailAddress: "sales@kellysupplies.com", - phone: "07999 999999", + id: "sup-10933920", + supplierName: "Northridge Office Supplies", + contactName: "Sarah Johnson", + emailAddress: "sarah.johnson@northridgesupplies.co.uk", + phone: "+44 (0)1223 322410", addresses: [ { type: "Billing", - line1: "Unit 51", - line2: "Bakersfield Industrial Estate", - city: "Bakersfield", - region: "California", - country: "USA", + line1: "Flat 1", + line2: "2 Dennis Avenue", + city: "London", + region: "Camden", + country: "GB", + postalCode: "EC1N 7TE", }, ], status: "Active", + balance: new Decimal("0"), defaultCurrency: "GBP", - sourceModifiedDate: "2022-10-23T00:00:00Z", + sourceModifiedDate: "2026-03-18T10:30:00Z", }; ``` diff --git a/sync-for-payables/docs/sdk/models/shared/suppliers.md b/sync-for-payables/docs/sdk/models/shared/suppliers.md index fe9207d44..d2581385b 100644 --- a/sync-for-payables/docs/sdk/models/shared/suppliers.md +++ b/sync-for-payables/docs/sdk/models/shared/suppliers.md @@ -4,28 +4,31 @@ ```typescript import { Suppliers } from "@codat/sync-for-payables/sdk/models/shared"; +import { Decimal } from "@codat/sync-for-payables/sdk/types"; let value: Suppliers = { results: [ { - id: "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F", - supplierName: "Kelly's Industrial Supplies", - contactName: "Kelly Ipsum", - emailAddress: "sales@kellysupplies.com", - phone: "07999 999999", + id: "sup-10933920", + supplierName: "Northridge Office Supplies", + contactName: "Sarah Johnson", + emailAddress: "sarah.johnson@northridgesupplies.co.uk", + phone: "+44 (0)1223 322410", addresses: [ { type: "Billing", - line1: "Unit 51", - line2: "Bakersfield Industrial Estate", - city: "Bakersfield", - region: "California", - country: "USA", + line1: "Flat 1", + line2: "2 Dennis Avenue", + city: "London", + region: "Camden", + country: "GB", + postalCode: "EC1N 7TE", }, ], status: "Active", + balance: new Decimal("0"), defaultCurrency: "GBP", - sourceModifiedDate: "2022-10-23T00:00:00Z", + sourceModifiedDate: "2026-03-18T10:30:00Z", }, ], }; diff --git a/sync-for-payables/docs/sdks/bankaccounts/README.md b/sync-for-payables/docs/sdks/bankaccounts/README.md index db9df7c37..432e19e5a 100644 --- a/sync-for-payables/docs/sdks/bankaccounts/README.md +++ b/sync-for-payables/docs/sdks/bankaccounts/README.md @@ -79,6 +79,69 @@ async function run() { } } +run(); +``` +### Example Usage: Created bank account + + +```typescript +import { CodatSyncPayables } from "@codat/sync-for-payables"; + +const codatSyncPayables = new CodatSyncPayables({ + authHeader: "Basic BASE_64_ENCODED(API_KEY)", +}); + +async function run() { + const result = await codatSyncPayables.bankAccounts.create({ + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", + bankAccountPrototype: { + name: "", + accountType: "Debit", + accountNumber: "", + currency: "GBP", + }, + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { CodatSyncPayablesCore } from "@codat/sync-for-payables/core.js"; +import { bankAccountsCreate } from "@codat/sync-for-payables/funcs/bankAccountsCreate.js"; + +// Use `CodatSyncPayablesCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const codatSyncPayables = new CodatSyncPayablesCore({ + authHeader: "Basic BASE_64_ENCODED(API_KEY)", +}); + +async function run() { + const res = await bankAccountsCreate(codatSyncPayables, { + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", + bankAccountPrototype: { + name: "", + accountType: "Debit", + accountNumber: "", + currency: "GBP", + }, + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("bankAccountsCreate failed:", res.error); + } +} + run(); ``` ### Example Usage: Malformed query diff --git a/sync-for-payables/docs/sdks/suppliers/README.md b/sync-for-payables/docs/sdks/suppliers/README.md index dfc03ec53..059dfa32c 100644 --- a/sync-for-payables/docs/sdks/suppliers/README.md +++ b/sync-for-payables/docs/sdks/suppliers/README.md @@ -8,6 +8,7 @@ Get, create, and update Suppliers. * [list](#list) - List suppliers * [create](#create) - Create supplier +* [update](#update) - Update supplier ## list @@ -19,6 +20,17 @@ By default, this endpoint returns a list of active and archived suppliers. You c For example, to retrieve only active suppliers (i.e. `status=Active`) or suppliers created within the specified number of days (e.g. `sourceModifiedDate>2023-12-15T00:00:00.000Z`), query the endpoint as follows: `/payables/suppliers?query=sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Active`.For example, to retrieve active suppliers modified after a particular date use `query=sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Active`. +### Supported Integrations + +| Integration | Supported | +|-------------------------------|-----------| +| FreeAgent | Yes | +| QuickBooks Online | Yes | +| Xero | Yes | +| Oracle NetSuite | Yes | +| Sage Intacct | Yes | +| Zoho Books | Yes | + ### Example Usage: Source modified date @@ -375,6 +387,17 @@ The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/sy [Suppliers](https://docs.codat.io/sync-for-payables-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. +### Supported Integrations + +| Integration | Supported | +|-------------------------------|-----------| +| FreeAgent | Yes | +| QuickBooks Online | Yes | +| Xero | Yes | +| Oracle NetSuite | Yes | +| Sage Intacct | Yes | +| Zoho Books | Yes | + ### Example Usage: Malformed query @@ -452,9 +475,9 @@ async function run() { companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", supplierPrototype: { - supplierName: "Greggs", - contactName: "Greg Greggs", - emailAddress: "greg@greggs.com", + supplierName: "Northridge Office Supplies", + contactName: "Sarah Johnson", + emailAddress: "sarah.johnson@northridgesupplies.co.uk", phone: "+44 (0)1223 322410", addresses: [ { @@ -463,7 +486,7 @@ async function run() { line2: "2 Dennis Avenue", city: "London", region: "Camden", - country: "GBR", + country: "GB", postalCode: "EC1N 7TE", }, ], @@ -497,9 +520,9 @@ async function run() { companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", supplierPrototype: { - supplierName: "Greggs", - contactName: "Greg Greggs", - emailAddress: "greg@greggs.com", + supplierName: "Northridge Office Supplies", + contactName: "Sarah Johnson", + emailAddress: "sarah.johnson@northridgesupplies.co.uk", phone: "+44 (0)1223 322410", addresses: [ { @@ -508,7 +531,7 @@ async function run() { line2: "2 Dennis Avenue", city: "London", region: "Camden", - country: "GBR", + country: "GB", postalCode: "EC1N 7TE", }, ], @@ -542,6 +565,270 @@ run(); ### Errors +| Error Type | Status Code | Content Type | +| ---------------------------- | ---------------------------- | ---------------------------- | +| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | +| errors.ErrorMessage | 500, 503 | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | + +## update + +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. + +This is a full-replace PUT endpoint. Any fields not included in the request body will be cleared on the supplier record. + +### Supported Integrations + +| Integration | Supported | +|-------------------------------|-----------| +| FreeAgent | Yes | +| QuickBooks Online | Yes | +| Xero | Yes | +| Oracle NetSuite | No | +| Sage Intacct | No | +| Zoho Books | No | + +### Platform-specific behavior + +- **Xero**: Archived suppliers cannot be updated (returns `400`). Suppliers must be unarchived manually in the Xero UI before updating. +- **QuickBooks Online**: Currency can only be set when creating a supplier, and cannot be changed via update. + + +### Example Usage: Malformed query + + +```typescript +import { CodatSyncPayables } from "@codat/sync-for-payables"; + +const codatSyncPayables = new CodatSyncPayables({ + authHeader: "Basic BASE_64_ENCODED(API_KEY)", +}); + +async function run() { + const result = await codatSyncPayables.suppliers.update({ + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab", + supplierPrototype: { + supplierName: "", + phone: "+44 25691 154789", + status: "Active", + }, + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { CodatSyncPayablesCore } from "@codat/sync-for-payables/core.js"; +import { suppliersUpdate } from "@codat/sync-for-payables/funcs/suppliersUpdate.js"; + +// Use `CodatSyncPayablesCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const codatSyncPayables = new CodatSyncPayablesCore({ + authHeader: "Basic BASE_64_ENCODED(API_KEY)", +}); + +async function run() { + const res = await suppliersUpdate(codatSyncPayables, { + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab", + supplierPrototype: { + supplierName: "", + phone: "+44 25691 154789", + status: "Active", + }, + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("suppliersUpdate failed:", res.error); + } +} + +run(); +``` +### Example Usage: Update supplier + + +```typescript +import { CodatSyncPayables } from "@codat/sync-for-payables"; + +const codatSyncPayables = new CodatSyncPayables({ + authHeader: "Basic BASE_64_ENCODED(API_KEY)", +}); + +async function run() { + const result = await codatSyncPayables.suppliers.update({ + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab", + supplierPrototype: { + supplierName: "Northridge Office Supplies", + contactName: "Sarah Johnson", + emailAddress: "sarah.johnson@northridgesupplies.co.uk", + phone: "+44 (0)1223 322410", + addresses: [ + { + type: "Billing", + line1: "Flat 1", + line2: "2 Dennis Avenue", + city: "London", + region: "Camden", + country: "GB", + postalCode: "EC1N 7TE", + }, + ], + status: "Active", + defaultCurrency: "GBP", + }, + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { CodatSyncPayablesCore } from "@codat/sync-for-payables/core.js"; +import { suppliersUpdate } from "@codat/sync-for-payables/funcs/suppliersUpdate.js"; + +// Use `CodatSyncPayablesCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const codatSyncPayables = new CodatSyncPayablesCore({ + authHeader: "Basic BASE_64_ENCODED(API_KEY)", +}); + +async function run() { + const res = await suppliersUpdate(codatSyncPayables, { + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab", + supplierPrototype: { + supplierName: "Northridge Office Supplies", + contactName: "Sarah Johnson", + emailAddress: "sarah.johnson@northridgesupplies.co.uk", + phone: "+44 (0)1223 322410", + addresses: [ + { + type: "Billing", + line1: "Flat 1", + line2: "2 Dennis Avenue", + city: "London", + region: "Camden", + country: "GB", + postalCode: "EC1N 7TE", + }, + ], + status: "Active", + defaultCurrency: "GBP", + }, + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("suppliersUpdate failed:", res.error); + } +} + +run(); +``` +### Example Usage: Updated supplier + + +```typescript +import { CodatSyncPayables } from "@codat/sync-for-payables"; + +const codatSyncPayables = new CodatSyncPayables({ + authHeader: "Basic BASE_64_ENCODED(API_KEY)", +}); + +async function run() { + const result = await codatSyncPayables.suppliers.update({ + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab", + supplierPrototype: { + supplierName: "", + phone: "+44 25691 154789", + status: "Active", + }, + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { CodatSyncPayablesCore } from "@codat/sync-for-payables/core.js"; +import { suppliersUpdate } from "@codat/sync-for-payables/funcs/suppliersUpdate.js"; + +// Use `CodatSyncPayablesCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const codatSyncPayables = new CodatSyncPayablesCore({ + authHeader: "Basic BASE_64_ENCODED(API_KEY)", +}); + +async function run() { + const res = await suppliersUpdate(codatSyncPayables, { + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002", + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171", + supplierId: "13d946f0-c5d5-42bc-b092-97ece17923ab", + supplierPrototype: { + supplierName: "", + phone: "+44 25691 154789", + status: "Active", + }, + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("suppliersUpdate failed:", res.error); + } +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.UpdateSupplierRequest](../../sdk/models/operations/updatesupplierrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[shared.Supplier](../../sdk/models/shared/supplier.md)\>** + +### Errors + | Error Type | Status Code | Content Type | | ---------------------------- | ---------------------------- | ---------------------------- | | errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json | diff --git a/sync-for-payables/examples/package-lock.json b/sync-for-payables/examples/package-lock.json index 4cc1a4543..e635405b3 100644 --- a/sync-for-payables/examples/package-lock.json +++ b/sync-for-payables/examples/package-lock.json @@ -18,7 +18,7 @@ }, "..": { "name": "@codat/sync-for-payables", - "version": "9.3.0", + "version": "9.3.1", "dependencies": { "decimal.js": "^10.4.3", "zod": "^3.25.0 || ^4.0.0" diff --git a/sync-for-payables/jsr.json b/sync-for-payables/jsr.json index 0cb5b5775..afcc356c8 100644 --- a/sync-for-payables/jsr.json +++ b/sync-for-payables/jsr.json @@ -2,7 +2,7 @@ { "name": "@codat/sync-for-payables", - "version": "9.3.0", + "version": "9.3.1", "exports": { ".": "./src/index.ts", "./sdk/models/errors": "./src/sdk/models/errors/index.ts", diff --git a/sync-for-payables/package-lock.json b/sync-for-payables/package-lock.json index c5f74611c..f9a6b5105 100644 --- a/sync-for-payables/package-lock.json +++ b/sync-for-payables/package-lock.json @@ -1,12 +1,12 @@ { "name": "@codat/sync-for-payables", - "version": "9.3.0", + "version": "9.3.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@codat/sync-for-payables", - "version": "9.3.0", + "version": "9.3.1", "dependencies": { "decimal.js": "^10.4.3", "zod": "^3.25.0 || ^4.0.0" diff --git a/sync-for-payables/package.json b/sync-for-payables/package.json index 7b0eb141c..7ece72f1d 100644 --- a/sync-for-payables/package.json +++ b/sync-for-payables/package.json @@ -1,6 +1,6 @@ { "name": "@codat/sync-for-payables", - "version": "9.3.0", + "version": "9.3.1", "author": "Codat", "main": "./index.js", "sideEffects": false, diff --git a/sync-for-payables/src/funcs/bankAccountsCreate.ts b/sync-for-payables/src/funcs/bankAccountsCreate.ts index fe656e7de..c3ff3ed10 100644 --- a/sync-for-payables/src/funcs/bankAccountsCreate.ts +++ b/sync-for-payables/src/funcs/bankAccountsCreate.ts @@ -103,7 +103,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/bankAccounts", )(pathParams); diff --git a/sync-for-payables/src/funcs/billPaymentsCreate.ts b/sync-for-payables/src/funcs/billPaymentsCreate.ts index eedfe8bc9..882a67539 100644 --- a/sync-for-payables/src/funcs/billPaymentsCreate.ts +++ b/sync-for-payables/src/funcs/billPaymentsCreate.ts @@ -107,7 +107,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/payment", )(pathParams); diff --git a/sync-for-payables/src/funcs/billPaymentsGetPaymentOptions.ts b/sync-for-payables/src/funcs/billPaymentsGetPaymentOptions.ts index 25d0eebc4..f042d24e9 100644 --- a/sync-for-payables/src/funcs/billPaymentsGetPaymentOptions.ts +++ b/sync-for-payables/src/funcs/billPaymentsGetPaymentOptions.ts @@ -104,7 +104,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/mappingOptions/payments", )(pathParams); diff --git a/sync-for-payables/src/funcs/billsCreate.ts b/sync-for-payables/src/funcs/billsCreate.ts index f9dfea647..c84752311 100644 --- a/sync-for-payables/src/funcs/billsCreate.ts +++ b/sync-for-payables/src/funcs/billsCreate.ts @@ -101,7 +101,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/bills", )(pathParams); diff --git a/sync-for-payables/src/funcs/billsDownloadAttachment.ts b/sync-for-payables/src/funcs/billsDownloadAttachment.ts index db77db9c6..475a3bbcd 100644 --- a/sync-for-payables/src/funcs/billsDownloadAttachment.ts +++ b/sync-for-payables/src/funcs/billsDownloadAttachment.ts @@ -112,7 +112,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/attachments/{attachmentId}/download", )(pathParams); diff --git a/sync-for-payables/src/funcs/billsGetBillOptions.ts b/sync-for-payables/src/funcs/billsGetBillOptions.ts index a7adecc01..cfe0b7655 100644 --- a/sync-for-payables/src/funcs/billsGetBillOptions.ts +++ b/sync-for-payables/src/funcs/billsGetBillOptions.ts @@ -104,7 +104,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/mappingOptions/bills", )(pathParams); diff --git a/sync-for-payables/src/funcs/billsList.ts b/sync-for-payables/src/funcs/billsList.ts index 99bb28557..e776abb6a 100644 --- a/sync-for-payables/src/funcs/billsList.ts +++ b/sync-for-payables/src/funcs/billsList.ts @@ -103,7 +103,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/bills", )(pathParams); diff --git a/sync-for-payables/src/funcs/billsListAttachments.ts b/sync-for-payables/src/funcs/billsListAttachments.ts index 2a8fd61dd..7d43c85a4 100644 --- a/sync-for-payables/src/funcs/billsListAttachments.ts +++ b/sync-for-payables/src/funcs/billsListAttachments.ts @@ -107,7 +107,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/attachments", )(pathParams); diff --git a/sync-for-payables/src/funcs/billsUpdate.ts b/sync-for-payables/src/funcs/billsUpdate.ts index bcf544841..ffdf57fed 100644 --- a/sync-for-payables/src/funcs/billsUpdate.ts +++ b/sync-for-payables/src/funcs/billsUpdate.ts @@ -116,7 +116,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}", )(pathParams); diff --git a/sync-for-payables/src/funcs/billsUploadAttachment.ts b/sync-for-payables/src/funcs/billsUploadAttachment.ts index c7cbf43de..80ce15bd9 100644 --- a/sync-for-payables/src/funcs/billsUploadAttachment.ts +++ b/sync-for-payables/src/funcs/billsUploadAttachment.ts @@ -5,6 +5,7 @@ import { CodatSyncPayablesCore } from "../core.js"; import { appendForm, encodeSimple } from "../lib/encodings.js"; import { + bytesToBlob, getContentTypeFromFileName, readableStreamToArrayBuffer, } from "../lib/files.js"; @@ -107,8 +108,12 @@ async function $do( const contentType = getContentTypeFromFileName(payload.AttachmentUpload.file.fileName) || "application/octet-stream"; - const blob = new Blob([buffer], { type: contentType }); - appendForm(body, "file", blob, payload.AttachmentUpload.file.fileName); + appendForm( + body, + "file", + bytesToBlob(buffer, contentType), + payload.AttachmentUpload.file.fileName, + ); } else { const contentType = getContentTypeFromFileName(payload.AttachmentUpload.file.fileName) @@ -116,9 +121,7 @@ async function $do( appendForm( body, "file", - new Blob([payload.AttachmentUpload.file.content], { - type: contentType, - }), + bytesToBlob(payload.AttachmentUpload.file.content, contentType), payload.AttachmentUpload.file.fileName, ); } @@ -138,7 +141,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/attachments", )(pathParams); diff --git a/sync-for-payables/src/funcs/companiesDelete.ts b/sync-for-payables/src/funcs/companiesDelete.ts index 23698d50d..150318df2 100644 --- a/sync-for-payables/src/funcs/companiesDelete.ts +++ b/sync-for-payables/src/funcs/companiesDelete.ts @@ -98,7 +98,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc("/companies/{companyId}")(pathParams); const headers = new Headers(compactMap({ diff --git a/sync-for-payables/src/funcs/companiesGet.ts b/sync-for-payables/src/funcs/companiesGet.ts index 4aa952211..a951fc733 100644 --- a/sync-for-payables/src/funcs/companiesGet.ts +++ b/sync-for-payables/src/funcs/companiesGet.ts @@ -98,7 +98,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc("/companies/{companyId}")(pathParams); const headers = new Headers(compactMap({ diff --git a/sync-for-payables/src/funcs/companiesReplace.ts b/sync-for-payables/src/funcs/companiesReplace.ts index 3acad3d8f..5e270df40 100644 --- a/sync-for-payables/src/funcs/companiesReplace.ts +++ b/sync-for-payables/src/funcs/companiesReplace.ts @@ -100,7 +100,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc("/companies/{companyId}")(pathParams); const headers = new Headers(compactMap({ diff --git a/sync-for-payables/src/funcs/companiesUpdate.ts b/sync-for-payables/src/funcs/companiesUpdate.ts index 725ab1476..6d55577b2 100644 --- a/sync-for-payables/src/funcs/companiesUpdate.ts +++ b/sync-for-payables/src/funcs/companiesUpdate.ts @@ -101,7 +101,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc("/companies/{companyId}")(pathParams); const headers = new Headers(compactMap({ diff --git a/sync-for-payables/src/funcs/companyInformationGet.ts b/sync-for-payables/src/funcs/companyInformationGet.ts index c3a59e112..7b50da07c 100644 --- a/sync-for-payables/src/funcs/companyInformationGet.ts +++ b/sync-for-payables/src/funcs/companyInformationGet.ts @@ -100,7 +100,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/info", )(pathParams); diff --git a/sync-for-payables/src/funcs/connectionsCreate.ts b/sync-for-payables/src/funcs/connectionsCreate.ts index 8f5d134f1..f49a47f9c 100644 --- a/sync-for-payables/src/funcs/connectionsCreate.ts +++ b/sync-for-payables/src/funcs/connectionsCreate.ts @@ -97,7 +97,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc("/companies/{companyId}/connections")(pathParams); const headers = new Headers(compactMap({ diff --git a/sync-for-payables/src/funcs/connectionsDelete.ts b/sync-for-payables/src/funcs/connectionsDelete.ts index debe3fb4c..55d0f7f67 100644 --- a/sync-for-payables/src/funcs/connectionsDelete.ts +++ b/sync-for-payables/src/funcs/connectionsDelete.ts @@ -100,7 +100,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc("/companies/{companyId}/connections/{connectionId}")( pathParams, ); diff --git a/sync-for-payables/src/funcs/connectionsGet.ts b/sync-for-payables/src/funcs/connectionsGet.ts index 1e813fe5d..972e33289 100644 --- a/sync-for-payables/src/funcs/connectionsGet.ts +++ b/sync-for-payables/src/funcs/connectionsGet.ts @@ -99,7 +99,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc("/companies/{companyId}/connections/{connectionId}")( pathParams, ); diff --git a/sync-for-payables/src/funcs/connectionsList.ts b/sync-for-payables/src/funcs/connectionsList.ts index 4ab0abc75..1e7d60812 100644 --- a/sync-for-payables/src/funcs/connectionsList.ts +++ b/sync-for-payables/src/funcs/connectionsList.ts @@ -95,7 +95,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc("/companies/{companyId}/connections")(pathParams); const query = encodeFormQuery({ diff --git a/sync-for-payables/src/funcs/connectionsUnlink.ts b/sync-for-payables/src/funcs/connectionsUnlink.ts index 3e0a90b6c..0dc33eb10 100644 --- a/sync-for-payables/src/funcs/connectionsUnlink.ts +++ b/sync-for-payables/src/funcs/connectionsUnlink.ts @@ -99,7 +99,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc("/companies/{companyId}/connections/{connectionId}")( pathParams, ); diff --git a/sync-for-payables/src/funcs/suppliersCreate.ts b/sync-for-payables/src/funcs/suppliersCreate.ts index 5e3dad5c5..0d8100cb6 100644 --- a/sync-for-payables/src/funcs/suppliersCreate.ts +++ b/sync-for-payables/src/funcs/suppliersCreate.ts @@ -33,6 +33,17 @@ import { Result } from "../sdk/types/fp.js"; * 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. + * + * ### Supported Integrations + * + * | Integration | Supported | + * |-------------------------------|-----------| + * | FreeAgent | Yes | + * | QuickBooks Online | Yes | + * | Xero | Yes | + * | Oracle NetSuite | Yes | + * | Sage Intacct | Yes | + * | Zoho Books | Yes | */ export function suppliersCreate( client: CodatSyncPayablesCore, @@ -101,7 +112,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/suppliers", )(pathParams); diff --git a/sync-for-payables/src/funcs/suppliersList.ts b/sync-for-payables/src/funcs/suppliersList.ts index 8133e20e3..df736ae44 100644 --- a/sync-for-payables/src/funcs/suppliersList.ts +++ b/sync-for-payables/src/funcs/suppliersList.ts @@ -37,6 +37,17 @@ import { Result } from "../sdk/types/fp.js"; * By default, this endpoint returns a list of active and archived suppliers. You can use [querying](https://docs.codat.io/using-the-api/querying) to change that. * * For example, to retrieve only active suppliers (i.e. `status=Active`) or suppliers created within the specified number of days (e.g. `sourceModifiedDate>2023-12-15T00:00:00.000Z`), query the endpoint as follows: `/payables/suppliers?query=sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Active`.For example, to retrieve active suppliers modified after a particular date use `query=sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Active`. + * + * ### Supported Integrations + * + * | Integration | Supported | + * |-------------------------------|-----------| + * | FreeAgent | Yes | + * | QuickBooks Online | Yes | + * | Xero | Yes | + * | Oracle NetSuite | Yes | + * | Sage Intacct | Yes | + * | Zoho Books | Yes | */ export function suppliersList( client: CodatSyncPayablesCore, @@ -105,7 +116,6 @@ async function $do( charEncoding: "percent", }), }; - const path = pathToFunc( "/companies/{companyId}/connections/{connectionId}/payables/suppliers", )(pathParams); diff --git a/sync-for-payables/src/funcs/suppliersUpdate.ts b/sync-for-payables/src/funcs/suppliersUpdate.ts new file mode 100644 index 000000000..129cccdae --- /dev/null +++ b/sync-for-payables/src/funcs/suppliersUpdate.ts @@ -0,0 +1,231 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { CodatSyncPayablesCore } from "../core.js"; +import { encodeJSON, encodeSimple } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { CodatSyncPayablesError } from "../sdk/models/errors/codatsyncpayableserror.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../sdk/models/errors/httpclienterrors.js"; +import * as errors from "../sdk/models/errors/index.js"; +import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; +import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; +import * as operations from "../sdk/models/operations/index.js"; +import * as shared from "../sdk/models/shared/index.js"; +import { APICall, APIPromise } from "../sdk/types/async.js"; +import { Result } from "../sdk/types/fp.js"; + +/** + * Update supplier + * + * @remarks + * 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. + * + * This is a full-replace PUT endpoint. Any fields not included in the request body will be cleared on the supplier record. + * + * ### Supported Integrations + * + * | Integration | Supported | + * |-------------------------------|-----------| + * | FreeAgent | Yes | + * | QuickBooks Online | Yes | + * | Xero | Yes | + * | Oracle NetSuite | No | + * | Sage Intacct | No | + * | Zoho Books | No | + * + * ### Platform-specific behavior + * + * - **Xero**: Archived suppliers cannot be updated (returns `400`). Suppliers must be unarchived manually in the Xero UI before updating. + * - **QuickBooks Online**: Currency can only be set when creating a supplier, and cannot be changed via update. + */ +export function suppliersUpdate( + client: CodatSyncPayablesCore, + request: operations.UpdateSupplierRequest, + options?: RequestOptions, +): APIPromise< + Result< + shared.Supplier, + | errors.ErrorMessage + | CodatSyncPayablesError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: CodatSyncPayablesCore, + request: operations.UpdateSupplierRequest, + options?: RequestOptions, +): Promise< + [ + Result< + shared.Supplier, + | errors.ErrorMessage + | CodatSyncPayablesError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => operations.UpdateSupplierRequest$outboundSchema.parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = encodeJSON("body", payload.supplierPrototype, { explode: true }); + + const pathParams = { + companyId: encodeSimple("companyId", payload.companyId, { + explode: false, + charEncoding: "percent", + }), + connectionId: encodeSimple("connectionId", payload.connectionId, { + explode: false, + charEncoding: "percent", + }), + supplierId: encodeSimple("supplierId", payload.supplierId, { + explode: false, + charEncoding: "percent", + }), + }; + const path = pathToFunc( + "/companies/{companyId}/connections/{connectionId}/payables/suppliers/{supplierId}", + )(pathParams); + + const headers = new Headers(compactMap({ + "Content-Type": "application/json", + Accept: "application/json", + })); + + const secConfig = await extractSecurity(client._options.authHeader); + const securityInput = secConfig == null ? {} : { authHeader: secConfig }; + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + options: client._options, + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "update-supplier", + oAuth2Scopes: null, + + resolvedSecurity: requestSecurity, + + securitySource: client._options.authHeader, + retryConfig: options?.retries + || client._options.retryConfig + || { + strategy: "backoff", + backoff: { + initialInterval: 500, + maxInterval: 60000, + exponent: 1.5, + maxElapsedTime: 3600000, + }, + retryConnectionErrors: true, + } + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["408", "429", "5XX"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "PUT", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + userAgent: client._options.userAgent, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: [ + "400", + "401", + "402", + "403", + "404", + "429", + "4XX", + "500", + "503", + "5XX", + ], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + HttpMeta: { Response: response, Request: req }, + }; + + const [result] = await M.match< + shared.Supplier, + | errors.ErrorMessage + | CodatSyncPayablesError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >( + M.json(200, shared.Supplier$inboundSchema), + M.jsonErr( + [400, 401, 402, 403, 404, 429], + errors.ErrorMessage$inboundSchema, + ), + M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema), + M.fail("4XX"), + M.fail("5XX"), + )(response, req, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/sync-for-payables/src/lib/config.ts b/sync-for-payables/src/lib/config.ts index fd701a606..4ca670297 100644 --- a/sync-for-payables/src/lib/config.ts +++ b/sync-for-payables/src/lib/config.ts @@ -61,8 +61,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "3.0.0", - sdkVersion: "9.3.0", - genVersion: "2.812.2", + sdkVersion: "9.3.1", + genVersion: "2.869.10", userAgent: - "speakeasy-sdk/typescript 9.3.0 2.812.2 3.0.0 @codat/sync-for-payables", + "speakeasy-sdk/typescript 9.3.1 2.869.10 3.0.0 @codat/sync-for-payables", } as const; diff --git a/sync-for-payables/src/lib/files.ts b/sync-for-payables/src/lib/files.ts index 0344cd046..6ca6b37d3 100644 --- a/sync-for-payables/src/lib/files.ts +++ b/sync-for-payables/src/lib/files.ts @@ -80,3 +80,25 @@ export function getContentTypeFromFileName(fileName: string): string | null { return mimeTypes[ext] || null; } + +/** + * Creates a Blob from file content with the given MIME type. + * + * Node.js Buffers are Uint8Array subclasses that may share a pooled + * ArrayBuffer (byteOffset > 0, byteLength < buffer.byteLength). Passing + * such a Buffer directly to `new Blob([buf])` can include the entire + * underlying pool on some runtimes, producing a Blob with extra bytes + * that corrupts multipart uploads. + * + * Copying into a standalone Uint8Array ensures the Blob receives only the + * intended bytes regardless of runtime behaviour. + */ +export function bytesToBlob( + content: Uint8Array | ArrayBuffer | Blob | string, + contentType: string, +): Blob { + if (content instanceof Uint8Array) { + return new Blob([new Uint8Array(content)], { type: contentType }); + } + return new Blob([content as BlobPart], { type: contentType }); +} diff --git a/sync-for-payables/src/lib/matchers.ts b/sync-for-payables/src/lib/matchers.ts index 41b6095f0..b096d6f20 100644 --- a/sync-for-payables/src/lib/matchers.ts +++ b/sync-for-payables/src/lib/matchers.ts @@ -248,8 +248,9 @@ export function match( raw = body; break; default: - encoding satisfies never; - throw new Error(`Unsupported response type: ${encoding}`); + throw new Error( + `Unsupported response type: ${encoding satisfies never}`, + ); } if (matcher.enc === "fail") { diff --git a/sync-for-payables/src/lib/sdks.ts b/sync-for-payables/src/lib/sdks.ts index 126029ae9..43fcf336e 100644 --- a/sync-for-payables/src/lib/sdks.ts +++ b/sync-for-payables/src/lib/sdks.ts @@ -124,13 +124,15 @@ export class ClientSDK { if (!base) { return ERR(new InvalidRequestError("No base URL provided for operation")); } - const reqURL = new URL(base); - const inputURL = new URL(path, reqURL); - + const baseURL = new URL(base); + let reqURL: URL; if (path) { - reqURL.pathname += reqURL.pathname.endsWith("/") ? "" : "/"; - reqURL.pathname += inputURL.pathname.replace(/^\/+/, ""); + baseURL.pathname = baseURL.pathname.replace(/\/+$/, "") + "/"; + reqURL = new URL(path, baseURL); + } else { + reqURL = baseURL; } + reqURL.hash = ""; let finalQuery = query || ""; diff --git a/sync-for-payables/src/lib/security.ts b/sync-for-payables/src/lib/security.ts index c87ebc333..5d93cd4a1 100644 --- a/sync-for-payables/src/lib/security.ts +++ b/sync-for-payables/src/lib/security.ts @@ -197,8 +197,7 @@ export function resolveSecurity( applyBearer(state, spec); break; default: - spec satisfies never; - throw SecurityError.unrecognizedType(type); + throw SecurityError.unrecognizedType((spec satisfies never, type)); } }); diff --git a/sync-for-payables/src/lib/url.ts b/sync-for-payables/src/lib/url.ts index f3a8de6c0..79e7ce660 100644 --- a/sync-for-payables/src/lib/url.ts +++ b/sync-for-payables/src/lib/url.ts @@ -13,21 +13,23 @@ export function pathToFunc( const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g; return function buildURLPath(params: Record = {}): string { - return pathPattern.replace(paramRE, function (_, placeholder) { - if (!hasOwn.call(params, placeholder)) { - throw new Error(`Parameter '${placeholder}' is required`); - } + return pathPattern + .replace(paramRE, function (_, placeholder) { + if (!hasOwn.call(params, placeholder)) { + throw new Error(`Parameter '${placeholder}' is required`); + } - const value = params[placeholder]; - if (typeof value !== "string" && typeof value !== "number") { - throw new Error( - `Parameter '${placeholder}' must be a string or number`, - ); - } + const value = params[placeholder]; + if (typeof value !== "string" && typeof value !== "number") { + throw new Error( + `Parameter '${placeholder}' must be a string or number`, + ); + } - return options?.charEncoding === "percent" - ? encodeURIComponent(`${value}`) - : `${value}`; - }); + return options?.charEncoding === "percent" + ? encodeURIComponent(`${value}`) + : `${value}`; + }) + .replace(/^\/+/, ""); }; } diff --git a/sync-for-payables/src/sdk/models/operations/index.ts b/sync-for-payables/src/sdk/models/operations/index.ts index 12cda2c10..278d9d3bd 100644 --- a/sync-for-payables/src/sdk/models/operations/index.ts +++ b/sync-for-payables/src/sdk/models/operations/index.ts @@ -24,4 +24,5 @@ export * from "./replacecompany.js"; export * from "./unlinkconnection.js"; export * from "./updatebill.js"; export * from "./updatecompany.js"; +export * from "./updatesupplier.js"; export * from "./uploadbillattachment.js"; diff --git a/sync-for-payables/src/sdk/models/operations/updatesupplier.ts b/sync-for-payables/src/sdk/models/operations/updatesupplier.ts new file mode 100644 index 000000000..69cdde755 --- /dev/null +++ b/sync-for-payables/src/sdk/models/operations/updatesupplier.ts @@ -0,0 +1,50 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod/v3"; +import * as shared from "../shared/index.js"; + +export type UpdateSupplierRequest = { + /** + * Unique identifier for a company. + */ + companyId: string; + /** + * Unique identifier for a connection. + */ + connectionId: string; + /** + * Unique identifier for a supplier. + */ + supplierId: string; + supplierPrototype?: shared.SupplierPrototype | undefined; +}; + +/** @internal */ +export type UpdateSupplierRequest$Outbound = { + companyId: string; + connectionId: string; + supplierId: string; + supplierPrototype?: shared.SupplierPrototype$Outbound | undefined; +}; + +/** @internal */ +export const UpdateSupplierRequest$outboundSchema: z.ZodType< + UpdateSupplierRequest$Outbound, + z.ZodTypeDef, + UpdateSupplierRequest +> = z.object({ + companyId: z.string(), + connectionId: z.string(), + supplierId: z.string(), + supplierPrototype: shared.SupplierPrototype$outboundSchema.optional(), +}); + +export function updateSupplierRequestToJSON( + updateSupplierRequest: UpdateSupplierRequest, +): string { + return JSON.stringify( + UpdateSupplierRequest$outboundSchema.parse(updateSupplierRequest), + ); +} diff --git a/sync-for-payables/src/sdk/models/shared/address.ts b/sync-for-payables/src/sdk/models/shared/address.ts index 25111ed9c..d40d6e69a 100644 --- a/sync-for-payables/src/sdk/models/shared/address.ts +++ b/sync-for-payables/src/sdk/models/shared/address.ts @@ -34,7 +34,7 @@ export type Address = { */ region?: string | null | undefined; /** - * Country of the customer's address. For NetSuite, use the 2-digit [ISO 3166](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. + * Country of the address. We recommend using the 2-digit ISO 3166 country code (e.g. `GB`, `US`, `FR`) as this is accepted by all supported platforms. */ country?: string | null | undefined; /** diff --git a/sync-for-payables/src/sdk/suppliers.ts b/sync-for-payables/src/sdk/suppliers.ts index 7de8009b5..0ad27777d 100644 --- a/sync-for-payables/src/sdk/suppliers.ts +++ b/sync-for-payables/src/sdk/suppliers.ts @@ -4,6 +4,7 @@ import { suppliersCreate } from "../funcs/suppliersCreate.js"; import { suppliersList } from "../funcs/suppliersList.js"; +import { suppliersUpdate } from "../funcs/suppliersUpdate.js"; import { ClientSDK, RequestOptions } from "../lib/sdks.js"; import * as operations from "./models/operations/index.js"; import * as shared from "./models/shared/index.js"; @@ -21,6 +22,17 @@ export class Suppliers extends ClientSDK { * By default, this endpoint returns a list of active and archived suppliers. You can use [querying](https://docs.codat.io/using-the-api/querying) to change that. * * For example, to retrieve only active suppliers (i.e. `status=Active`) or suppliers created within the specified number of days (e.g. `sourceModifiedDate>2023-12-15T00:00:00.000Z`), query the endpoint as follows: `/payables/suppliers?query=sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Active`.For example, to retrieve active suppliers modified after a particular date use `query=sourceModifiedDate>2023-12-15T00:00:00.000Z&&status=Active`. + * + * ### Supported Integrations + * + * | Integration | Supported | + * |-------------------------------|-----------| + * | FreeAgent | Yes | + * | QuickBooks Online | Yes | + * | Xero | Yes | + * | Oracle NetSuite | Yes | + * | Sage Intacct | Yes | + * | Zoho Books | Yes | */ async list( request: operations.ListSuppliersRequest, @@ -40,6 +52,17 @@ export class Suppliers extends ClientSDK { * 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. + * + * ### Supported Integrations + * + * | Integration | Supported | + * |-------------------------------|-----------| + * | FreeAgent | Yes | + * | QuickBooks Online | Yes | + * | Xero | Yes | + * | Oracle NetSuite | Yes | + * | Sage Intacct | Yes | + * | Zoho Books | Yes | */ async create( request: operations.CreateSupplierRequest, @@ -51,4 +74,41 @@ export class Suppliers extends ClientSDK { options, )); } + + /** + * Update supplier + * + * @remarks + * 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. + * + * This is a full-replace PUT endpoint. Any fields not included in the request body will be cleared on the supplier record. + * + * ### Supported Integrations + * + * | Integration | Supported | + * |-------------------------------|-----------| + * | FreeAgent | Yes | + * | QuickBooks Online | Yes | + * | Xero | Yes | + * | Oracle NetSuite | No | + * | Sage Intacct | No | + * | Zoho Books | No | + * + * ### Platform-specific behavior + * + * - **Xero**: Archived suppliers cannot be updated (returns `400`). Suppliers must be unarchived manually in the Xero UI before updating. + * - **QuickBooks Online**: Currency can only be set when creating a supplier, and cannot be changed via update. + */ + async update( + request: operations.UpdateSupplierRequest, + options?: RequestOptions, + ): Promise { + return unwrapAsync(suppliersUpdate( + this, + request, + options, + )); + } } diff --git a/sync-for-payables/tsconfig.json b/sync-for-payables/tsconfig.json index 0ccdbe286..76110f883 100644 --- a/sync-for-payables/tsconfig.json +++ b/sync-for-payables/tsconfig.json @@ -13,6 +13,7 @@ "declaration": true, "declarationMap": true, "sourceMap": true, + "rootDir": "src", "outDir": ".", @@ -36,5 +37,5 @@ "forceConsistentCasingInFileNames": true }, "include": ["src"], - "exclude": ["node_modules"] + "exclude": ["node_modules", "src/__tests__"] }