diff --git a/.speakeasy/logs/changes/changes.html b/.speakeasy/logs/changes/changes.html index 8231b2857..ef6500023 100644 --- a/.speakeasy/logs/changes/changes.html +++ b/.speakeasy/logs/changes/changes.html @@ -98,15 +98,15 @@

Python SDK Changes:

\ No newline at end of file diff --git a/.speakeasy/logs/changes/changes.md b/.speakeasy/logs/changes/changes.md index 279b36965..5e3bc99ec 100644 --- a/.speakeasy/logs/changes/changes.md +++ b/.speakeasy/logs/changes/changes.md @@ -1,10 +1,10 @@ ## Python SDK Changes: -* `codat_bank_feeds.companies.create()`: `response.data_connections[].integration_key` **Changed** -* `codat_bank_feeds.companies.get()`: `response.data_connections[].integration_key` **Changed** -* `codat_bank_feeds.companies.list()`: `response.results[].data_connections[].integration_key` **Changed** -* `codat_bank_feeds.companies.replace()`: `response.data_connections[].integration_key` **Changed** -* `codat_bank_feeds.companies.update()`: `response.data_connections[].integration_key` **Changed** -* `codat_bank_feeds.connections.create()`: `response.integration_key` **Changed** -* `codat_bank_feeds.connections.get()`: `response.integration_key` **Changed** -* `codat_bank_feeds.connections.list()`: `response.results[].integration_key` **Changed** -* `codat_bank_feeds.connections.unlink()`: `response.integration_key` **Changed** +* `codat_sync_payables.companies.list()`: `response.results[].data_connections[].integration_key` **Changed** +* `codat_sync_payables.companies.create()`: `response.data_connections[].integration_key` **Changed** +* `codat_sync_payables.companies.replace()`: `response.data_connections[].integration_key` **Changed** +* `codat_sync_payables.companies.update()`: `response.data_connections[].integration_key` **Changed** +* `codat_sync_payables.companies.get()`: `response.data_connections[].integration_key` **Changed** +* `codat_sync_payables.connections.list()`: `response.results[].integration_key` **Changed** +* `codat_sync_payables.connections.create()`: `response.integration_key` **Changed** +* `codat_sync_payables.connections.get()`: `response.integration_key` **Changed** +* `codat_sync_payables.connections.unlink()`: `response.integration_key` **Changed** diff --git a/.speakeasy/logs/changes/new.openapi.yaml b/.speakeasy/logs/changes/new.openapi.yaml index e9a1f1efb..e62edc2cc 100644 --- a/.speakeasy/logs/changes/new.openapi.yaml +++ b/.speakeasy/logs/changes/new.openapi.yaml @@ -3,17 +3,25 @@ servers: - description: Production url: 'https://api.codat.io' info: - title: Bank Feeds - version: 3.0.0 - contact: - email: support@codat.io - name: Codat + title: Bill pay (synchronous solution) description: |- - Bank Feeds solution enables your SMB users to set up bank feeds from accounts in your application to supported accounting software. + The API reference for the synchronous Bill Pay solution. - A bank feed is a connection between a source bank account in your application and a target bank account in a supported accounting software. + 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. - [Explore solution](https://docs.codat.io/bank-feeds-api/overview) | [See OpenAPI spec](https://github.com/codatio/oas) + [Explore solution](https://docs.codat.io/payables/overview) | [See OpenAPI spec](https://github.com/codatio/oas) + + --- + ## Supported Integrations + + | Integration | Supported | + |-------------------------------|-----------| + | FreeAgent | Yes | + | QuickBooks Online | Yes | + | Oracle NetSuite | Yes | + | Sage Intacct | Yes | + | Xero | Yes | + | Zoho Books | Yes | --- @@ -23,11 +31,16 @@ info: | :- |:- | | Companies | Create and manage your SMB users' companies. | | Connections | Create new and manage existing data connections for a company. | - | Source accounts | Provide and manage lists of source bank accounts. | - | Account mapping | Extra functionality for building an account management UI. | - | Company information | Get detailed information about a company from the underlying platform. | - | Transactions | Create new bank account transactions for a company's connections, and see previous operations. | + | 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: [] @@ -68,7 +81,7 @@ x-speakeasy-name-override: methodNameOverride: download-attachment - operationId: ^upload-.*?-attachment methodNameOverride: upload-attachment -x-codat-docs-path: bank-feeds-api +x-codat-docs-path: sync-for-payables-api x-codat-keep-docs-paths-local: true x-codat-speakeasy-pagination: type: offsetLimit @@ -83,103 +96,18 @@ tags: description: Create and manage your SMB users' companies. - name: Connections description: Create new and manage existing data connections for a company. - - name: Bank accounts - description: Access bank accounts in an SMBs accounting software. - - name: Source accounts - description: Provide and manage lists of source bank accounts. - - name: Account mapping - description: Extra functionality for building an account management UI. - - name: Transactions - description: 'Create new bank account transactions for a company''s connections, and see previous operations.' - name: Company information - description: Get detailed information about a company from the underlying accounting software. - - name: Managed bank feeds - description: Manage bank feed syncs for source accounts. + 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: Bank accounts + description: Create a bank account for a given company's connection. paths: /companies: - post: - summary: Create company - tags: - - Companies - operationId: create-company - responses: - '200': - description: OK - content: - application/json: - x-speakeasy-usage-example: true - schema: - $ref: '#/components/schemas/Company' - examples: - With no description: - value: - id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 - name: Technicalium - description: '' - platform: '' - redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' - dataConnections: [] - created: '2022-11-10T10:45:18.1950523Z' - createdByUserName: Dan Tzabar - products: - - spend-insights - referenceSubsidiaryCompanies: [] - With a description: - value: - id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 - name: Technicalium - description: 'Technology services, including web and app design and development' - platform: '' - redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' - dataConnections: [] - created: '2022-11-10T10:45:18.1950523Z' - createdByUserName: Dan Tzabar - products: - - spend-insights - referenceSubsidiaryCompanies: [] - With a tag: - value: - id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 - name: Technicalium - description: '' - platform: '' - redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' - dataConnections: [] - created: '2022-11-10T10:45:18.1950523Z' - createdByUserName: Dan Tzabar - products: - - spend-insights - tags: - region: us - referenceSubsidiaryCompanies: [] - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - description: "\uFEFFUse the *Create company* endpoint to create a new [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) that represents your customer in Codat. \n\nA [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n\nIf forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`." - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyRequestBody' - examples: - With no description: - value: - name: Technicalium - With a description: - value: - name: Technicalium - description: 'Technology services, including web and app design and development' get: summary: List companies tags: @@ -347,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/bank-feeds-api#/schemas/Company) associated to your instances.\n\nA [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/bank-feeds-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' @@ -359,136 +287,93 @@ paths: 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).' - '/companies/{companyId}': - 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/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/bank-feeds-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' + post: + summary: Create company tags: - Companies + operationId: create-company responses: '200': description: OK content: application/json: + x-speakeasy-usage-example: true schema: $ref: '#/components/schemas/Company' examples: - Simple company: + With no description: value: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 - name: Toft stores holdings + name: Technicalium description: '' platform: '' redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' dataConnections: [] - created: '2022-11-10T10:45:18Z' + created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar products: - spend-insights - - lending - - expenses-v1 - - commerce referenceSubsidiaryCompanies: [] - Parent multi-entity company: + With a description: value: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 - name: Toft stores - description: '' + name: Technicalium + description: 'Technology services, including web and app design and development' platform: '' redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' dataConnections: [] - created: '2022-11-10T10:45:18Z' + created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar products: - spend-insights - - lending - - expenses-v1 - - commerce - referenceSubsidiaryCompanies: - - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d - name: Toft stores UK - links: - portal: 'https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary' - - id: db94eddc-9212-4568-9b5c-3eab0e325913 - name: Toft stores US - links: - portal: 'https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary' - Subsidiary multi-entity company: + referenceSubsidiaryCompanies: [] + With a tag: value: - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d - name: Toft stores UK + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Technicalium description: '' platform: '' - redirect: 'https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d' - dataConnections: - - id: d5ab61b7-1ad0-46fd-9f9f-b6761047941e - integrationId: cc750323-5a47-4f28-8d8e-30fbbf2ce137 - integrationKey: akxx - sourceId: 9815b998-024d-4415-a40b-89903b2cad6f - platformName: Oracle NetSuite - linkUrl: 'https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start' - status: Linked - lastSync: '2022-01-01T12:30:00.000Z' - created: '2022-01-01T11:30:00Z' - sourceType: Accounting - created: '2022-11-10T10:45:18Z' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar products: - spend-insights - - lending - - expenses-v1 - - commerce - referenceParentCompany: - id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 - name: Toft stores - links: - portal: 'https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary' + tags: + region: us referenceSubsidiaryCompanies: [] + '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' - delete: - summary: Delete a company - operationId: delete-company - parameters: - - $ref: '#/components/parameters/companyId' - description: "\uFEFFThe *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/bank-feeds-api#/schemas/Company), its [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) and any cached data. This operation is irreversible.\n\nA [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n" - tags: - - Companies - responses: - '204': - description: No Content - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' + description: "\uFEFFUse the *Create company* endpoint to create a new [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company) that represents your customer in Codat. \n\nA [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payables-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n\nIf forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`." + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompanyRequestBody' + examples: + With no description: + value: + name: Technicalium + With a description: + value: + name: Technicalium + description: 'Technology services, including web and app design and development' + '/companies/{companyId}': put: summary: 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/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/bank-feeds-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: @@ -531,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/bank-feeds-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' @@ -571,32 +456,17 @@ paths: Update name: value: name: New Name - '/companies/{companyId}/accessToken': - get: - summary: Get company access token - operationId: get-company-access-token - x-speakeasy-name-override: get-access-token - description: |- - Use the _Get company access token_ endpoint to return an access token for the specified company ID. The token is valid for one day. - - The token is required by Codat's embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to verify the identity of the user and improve the reliability of data provided by them. + delete: + summary: Delete a company + operationId: delete-company parameters: - $ref: '#/components/parameters/companyId' + description: "\uFEFFThe *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company), its [connections](https://docs.codat.io/sync-for-payables-api#/schemas/Connection) and any cached data. This operation is irreversible.\n\nA [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payables-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n" tags: - Companies responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyAccessToken' - examples: - Simple company: - value: - expiresIn: 86400 - accessToken: string - tokenType: Bearer + '204': + description: No Content '401': $ref: '#/components/responses/Unauthorized' '402': @@ -611,42 +481,143 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections': get: - summary: List connections - description: "\uFEFFList the connections for a company." - operationId: list-connections - tags: - - Connections + summary: Get company + operationId: get-company + description: "\uFEFFThe *Get company* endpoint returns a single company for a given `companyId`.\n\nA [company](https://docs.codat.io/sync-for-payables-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/sync-for-payables-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n" parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' - - $ref: '#/components/parameters/query' - - $ref: '#/components/parameters/orderBy' + tags: + - Companies responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Connections' + $ref: '#/components/schemas/Company' examples: - Connections: + Simple company: value: - results: - - id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd - integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c - integrationKey: dfxm - sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee - platformName: Basiq - linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Linked - lastSync: '2022-10-27T10:22:43.6464237Z' - created: '2022-10-27T09:53:29Z' - sourceType: Banking - pageNumber: 0 - pageSize: 0 + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores holdings + description: '' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + - lending + - expenses-v1 + - commerce + referenceSubsidiaryCompanies: [] + Parent multi-entity company: + value: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores + description: '' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + 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 + links: + portal: 'https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary' + - id: db94eddc-9212-4568-9b5c-3eab0e325913 + name: Toft stores US + links: + portal: 'https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary' + Subsidiary multi-entity company: + value: + id: c8d3af58-7011-47ce-b3f2-89faf300ef6d + name: Toft stores UK + description: '' + platform: '' + redirect: 'https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d' + dataConnections: + - id: d5ab61b7-1ad0-46fd-9f9f-b6761047941e + integrationId: cc750323-5a47-4f28-8d8e-30fbbf2ce137 + integrationKey: akxx + sourceId: 9815b998-024d-4415-a40b-89903b2cad6f + platformName: Oracle NetSuite + linkUrl: 'https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start' + status: Linked + lastSync: '2022-01-01T12:30:00.000Z' + created: '2022-01-01T11:30:00Z' + 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 + links: + portal: 'https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary' + referenceSubsidiaryCompanies: [] + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections': + get: + summary: List connections + description: "\uFEFFList the connections for a company." + operationId: list-connections + tags: + - Connections + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Connections' + examples: + Connections: + value: + results: + - id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd + integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c + integrationKey: dfxm + sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee + platformName: Basiq + linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' + status: Linked + lastSync: '2022-10-27T10:22:43.6464237Z' + created: '2022-10-27T09:53:29Z' + sourceType: Banking + pageNumber: 0 + pageSize: 0 totalResults: 0 _links: self: @@ -847,441 +818,32 @@ paths: value: status: Unlinked description: '' - '/companies/{companyId}/connections/{connectionId}/data/bankAccounts': + '/companies/{companyId}/connections/{connectionId}/payables/info': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' get: - x-internal: true + 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: - - Bank accounts - summary: List bank accounts - operationId: list-bank-accounts - parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' - - $ref: '#/components/parameters/query' - - $ref: '#/components/parameters/orderBy' + - Company information responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/BankAccounts' + $ref: '#/components/schemas/CompanyInformation' examples: - Dynamics 365 Business Central: - value: - results: - - id: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b - accountName: '55' - accountType: Unknown - nominalCode: '10500' - sortCode: '' - accountNumber: '' - iBan: '' - currency: GBP - balance: -352.03 - modifiedDate: '2023-03-27T14:21:10Z' - sourceModifiedDate: '2023-02-07T00:00:00' - overdraftLimit: 0 - metadata: - isDeleted: false - - id: 47020f80-60e6-ec11-82f8-0022481a77f0 - accountName: '555' - accountType: Unknown - nominalCode: '40300' - sortCode: '' - accountNumber: '' - iBan: '' - currency: PLN - balance: 661.79 - modifiedDate: '2023-03-27T14:21:10Z' - sourceModifiedDate: '2022-06-07T00:00:00' - overdraftLimit: 0 - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 28 - _links: - current: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts - next: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=2&pageSize=2 - FreeAgent: - value: - results: - - id: '738783' - accountName: \w3fw - accountType: Debit - sortCode: '236972' - accountNumber: A06268209 - currency: GBP - balance: -10484.65 - availableBalance: -10484.65 - modifiedDate: '2023-04-25T14:19:12Z' - metadata: - isDeleted: false - - id: '738778' - accountName: 2e2bna45hy\ - accountType: Debit - sortCode: '236972' - accountNumber: D01825250 - currency: GBP - balance: -114.4 - availableBalance: -114.4 - modifiedDate: '2023-04-25T14:19:12Z' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 82 - _links: - current: - href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts - next: - href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=2&pageSize=2 - KashFlow: - value: - results: - - id: '765768' - accountName: 16th Account - accountType: Unknown - nominalCode: '70700' - currency: GBP - balance: 326 - availableBalance: 326 - modifiedDate: '2022-09-30T10:29:16Z' - - id: '765766' - accountName: 1a1a - accountType: Unknown - nominalCode: '70600' - currency: GBP - balance: 0 - availableBalance: 0 - modifiedDate: '2022-09-30T10:29:16Z' - pageNumber: 1 - pageSize: 2 - totalResults: 56 - _links: - current: - href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts - next: - href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=2&pageSize=2 - Oracle NetSuite: - value: - results: - - id: '825' - accountName: Codat Europe Bank - accountType: Debit - nominalCode: '111111122222111' - currency: GBP - balance: 558.22 - modifiedDate: '2023-05-02T13:24:36Z' - sourceModifiedDate: '2022-07-15T11:34:02' - metadata: - isDeleted: false - - id: '826' - accountName: Codat Europe Bank USD - accountType: Debit - nominalCode: '1133221133' - currency: USD - modifiedDate: '2023-05-02T13:24:36Z' - sourceModifiedDate: '2021-03-26T10:31:40' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 4 - _links: - current: - href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts - next: - href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=2&pageSize=2 - QuickBooks Desktop: - value: - results: - - id: 20000-933270541 - accountName: Checking - accountType: Unknown - nominalCode: '10100' - currency: GBP - balance: 46954.1 - availableBalance: 46954.1 - modifiedDate: '2023-04-26T09:12:37Z' - sourceModifiedDate: '2023-12-16T05:06:45' - metadata: - isDeleted: false - - id: 550001-1071509830 - accountName: Petty Cash - accountType: Unknown - nominalCode: '10400' - currency: GBP - balance: 500 - availableBalance: 500 - modifiedDate: '2023-04-26T09:12:37Z' - sourceModifiedDate: '2023-12-16T05:06:45' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 3 - _links: - current: - href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts - next: - href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=2&pageSize=2 - QuickBooks Online Sandbox: - value: - results: - - id: '164' - accountName: '00' - accountType: Debit - nominalCode: '123567' - currency: GBP - balance: 0 - availableBalance: 0 - modifiedDate: '2023-04-26T09:35:57Z' - sourceModifiedDate: '2022-07-20T14:11:28Z' - metadata: - isDeleted: false - - id: '163' - accountName: '11' - accountType: Debit - currency: GBP - balance: 0 - availableBalance: 0 - modifiedDate: '2023-04-26T09:35:57Z' - sourceModifiedDate: '2022-07-20T14:11:28Z' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 57 - _links: - current: - href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts - next: - href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=2&pageSize=2 - QuickBooks Online: - value: - results: - - id: '202' - accountName: \aa - accountType: Debit - currency: GBP - balance: 123 - availableBalance: 123 - modifiedDate: '2023-01-18T11:02:37Z' - sourceModifiedDate: '2022-11-11T14:15:13Z' - - id: '193' - accountName: 1 year ago - accountType: Debit - currency: GBP - balance: 5300.02 - availableBalance: 5300.02 - modifiedDate: '2023-01-18T11:02:37Z' - sourceModifiedDate: '2023-01-18T06:05:12Z' - pageNumber: 1 - pageSize: 2 - totalResults: 140 - _links: - current: - href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts - next: - href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=2&pageSize=2 - Sage 50 (UK): - value: - results: - - id: '1200' - accountName: Bank Current Account - accountType: Unknown - nominalCode: '1200' - sortCode: 23-34-34 - accountNumber: '003234234' - iBan: '' - currency: GBP - balance: -20091.04 - availableBalance: -20091.04 - modifiedDate: '2023-03-30T14:42:37Z' - sourceModifiedDate: '2022-11-25T09:25:48' - overdraftLimit: 120000 - institution: Lloyds Bank PLC - metadata: - isDeleted: false - - id: '1210' - accountName: Bank Deposit Account - accountType: Unknown - nominalCode: '1210' - sortCode: 45-45-45 - accountNumber: 9/00474345 - iBan: '' - currency: GBP - balance: 3510 - availableBalance: 3510 - modifiedDate: '2023-03-30T14:42:37Z' - sourceModifiedDate: '2022-11-25T09:25:48' - overdraftLimit: 0 - institution: Halifax Building Society - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 6 - _links: - current: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts - next: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=2&pageSize=2 - Sage Business Cloud Accounting: - value: - results: - - id: 154d05abe9f24c4babe0f6a741dec1b9 - accountName: Abdi Internet Bank - accountType: Unknown - nominalCode: '1560' - sortCode: '010101' - accountNumber: '11111' - currency: GBP - balance: 49.61 - availableBalance: 49.61 - modifiedDate: '2022-10-24T14:52:53Z' - sourceModifiedDate: '2020-01-27T10:53:26Z' - - id: 565ce07212bc492c8c2d04f43f9f67e3 - accountName: Abdi Live Test - accountType: Unknown - nominalCode: '147852' - sortCode: '123456' - accountNumber: '1234567' - currency: GBP - balance: -225830.75 - availableBalance: -225830.75 - modifiedDate: '2022-10-24T14:52:53Z' - sourceModifiedDate: '2020-01-28T14:00:20Z' - pageNumber: 1 - pageSize: 2 - totalResults: 45 - _links: - current: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts - next: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=2&pageSize=2 - Sage Intacct: - value: - results: - - id: 'CREDITCARD:55' - accountName: CoT Credit Card - accountType: Credit - nominalCode: '10021' - currency: GBP - modifiedDate: '2023-04-04T16:31:46Z' - sourceModifiedDate: '2023-03-27T14:11:48' - metadata: - isDeleted: false - - id: 'CREDITCARD:58' - accountName: Cot Credit Card 2 - accountType: Credit - nominalCode: '11112' - currency: GBP - modifiedDate: '2023-04-04T16:31:46Z' - sourceModifiedDate: '2023-03-27T14:15:11' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 14 - _links: - current: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts - next: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=2&pageSize=2 - Xero: - value: - results: - - id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 - accountName: Business Bank Account - accountType: Debit - sortCode: '990404' - accountNumber: '987654321' - currency: GBP - balance: 6681.79 - modifiedDate: '2023-03-15T20:36:09Z' - sourceModifiedDate: '2023-03-15T20:35:07' - metadata: - isDeleted: false - - id: a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba - accountName: Business Savings Account - accountType: Debit - sortCode: '890303' - accountNumber: '876543210' - currency: GBP - balance: 0 - modifiedDate: '2023-03-15T20:36:09Z' - sourceModifiedDate: '2023-03-15T20:36:06' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 2 - _links: - current: - href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts - Zoho Books: + Company information: value: - results: - - id: '104957000000060010' - accountName: Abdi Test - accountType: Unknown - sortCode: '112233' - accountNumber: xxxx5678 - currency: GBP - balance: 69858.44 - modifiedDate: '2022-10-03T08:40:38Z' - institution: Test Bank - - id: '104957000000065002' - accountName: Abdi Test 2 - accountType: Unknown - sortCode: '' - accountNumber: '' - currency: AED - balance: 98.03 - modifiedDate: '2022-10-03T08:40:38Z' - institution: '' - pageNumber: 1 - pageSize: 2 - totalResults: 4 - _links: - current: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts - next: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=2&pageSize=2 + companyName: Bank of Dave + baseCurrency: GBP '400': - $ref: '#/components/responses/Malformed-Query' + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1290,865 +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' - description: |- - The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankAccount) for a given company's connection. - - [Bank accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. - - Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/bank-feeds-api#/operations/refresh-company-data). - - '/companies/{companyId}/connections/{connectionId}/options/bankAccounts': + '/companies/{companyId}/connections/{connectionId}/payables/mappingOptions/bills': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' get: - summary: Get create/update bank account model - x-internal: true + 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: - - Bank accounts + - Bills + parameters: + - $ref: '#/components/parameters/continuationToken' + - $ref: '#/components/parameters/statusQuery' responses: '200': - description: OK + description: Success content: application/json: schema: - $ref: '#/components/schemas/PushOption' + $ref: '#/components/schemas/BillMappingOptions' 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: + Mapping options: 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 + 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': @@ -2163,33 +916,42 @@ paths: $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/bank-feeds-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/bank-feeds-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}/connections/{connectionId}/push/bankAccounts': + '/companies/{companyId}/connections/{connectionId}/payables/mappingOptions/payments': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' - post: - x-internal: true + 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: - - Bank accounts - summary: Create bank account + - Bill payments parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BankAccounts/allOf/0/properties/results/items/definitions/bankAccountPrototype' - examples: {} + - $ref: '#/components/parameters/continuationToken' + - $ref: '#/components/parameters/statusQuery' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/BankAccounts/allOf/0/properties/results/items/definitions/bankAccountCreateResponse' - 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': @@ -2206,58 +968,101 @@ 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/bank-feeds-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/bank-feeds-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/bank-feeds-api#/operations/get-create-update-bankAccounts-model)." - operationId: create-bank-account - '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/batch': + '/companies/{companyId}/connections/{connectionId}/payables/bills': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' - post: - tags: - - Source accounts - summary: Create source accounts + get: + summary: List bills description: |- - The _Batch create source accounts_ endpoint allows you to create multiple representations of your SMB's bank accounts within Codat's domain. The company can then map the source account to an existing or new target account in their accounting software. + 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. - > ### Versioning - > If you are integrating the Bank Feeds solution with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below. - operationId: create-batch-source-account - x-speakeasy-name-override: create-batch - requestBody: - content: - application/json: - schema: - oneOf: - - type: array - items: - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccountV2Prototype' - - type: array - items: - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccountPrototype' + [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: + - Bills + parameters: + - $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: - '201': + '200': description: Success content: application/json: schema: - type: array - items: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2BatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchCreateResponse' - '207': - description: Multi-Status - content: - application/json: - schema: - type: array - items: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2BatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchErrorResponse' + $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': @@ -2267,81 +1072,128 @@ paths: '404': $ref: '#/components/responses/Not-Found' '409': - description: Conflict - content: - application/json: - schema: - type: array - items: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2BatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchErrorResponse' + $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' post: - tags: - - Source accounts - summary: Create single source account + summary: Create bill description: |- - The _Create Source Account_ endpoint allows you to create a representation of a bank account within Codat's domain. The company can then map the source account to an existing or new target account in their accounting software. + The *Create bill* endpoint creates a new [bill](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) for a given company's connection. - > ### Versioning - > If you are integrating the Bank Feeds solution with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below. - operationId: create-source-account + [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: + - Bills + 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: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccountV2Prototype' - - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccountPrototype' + $ref: '#/components/schemas/Bill/definitions/billPrototype' examples: - Version 2: - value: - id: acc-001 - accountName: account-081 - accountType: checking - accountNumber: '12345670' - routingInfo: - bankCode: 021001088 - type: bankcode - currency: GBP - balance: 99.99 - accountInfo: - description: account description 1 - nickname: account 123 - accountOpenDate: '2023-05-06' - availableBalance: 10 - modifiedDate: '2024-08-02T00:00:00.000Z' - Version 1: + Create bill: value: - id: acc-002 - accountName: account-081 - sortCode: '123456' - accountType: Credit - accountNumber: '12345670' + 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 - balance: 99.99 - modifiedDate: '2023-01-09T14:14:14.1057478Z' + 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: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2' - - $ref: '#/components/schemas/SourceAccount' - 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': @@ -2352,28 +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' - get: + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $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: - - Source accounts - summary: List source accounts - description: "\uFEFFThe _List source accounts_ endpoint returns a list of [source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) for a given company's connection.\n\n[Source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) are the bank's bank account within Codat's domain from which transactions are synced into the accounting platform.\n\n> ### Versioning\n> If you are integrating the Bank Feeds solution with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below." - operationId: list-source-accounts + - Bills + 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/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: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccounts' - - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccounts' - 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': @@ -2382,38 +1334,47 @@ 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' - '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/{accountId}': - patch: + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $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: - - Source accounts - summary: Update source account - description: "\uFEFFThe _Update source account_ endpoint updates a single source account for a single data connection connected to a single company.\n\n### Tips and pitfalls\n\n* This endpoint makes it possible to update the `accountName`, `status`, and `balance` fields.\n * The `status` field can only be updated to 'disconnected'.\n * The `balance` field can only be updated on accounts that are **not** 'connected'.\n* Updates made here apply exclusively to source accounts and will not affect target accounts in the accounting software." - operationId: update-source-account - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/accountId' + - Bills requestBody: content: - application/json: + multipart/form-data: schema: - $ref: '#/components/schemas/SourceAccount' - examples: {} + $ref: '#/components/schemas/AttachmentUpload' responses: - '200': - description: Success + '201': + description: Created content: application/json: - x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/SourceAccount' - 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': @@ -2430,22 +1391,36 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - delete: + 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: - - Source accounts - summary: Delete source account - description: | - The _Delete source account_ endpoint enables you to remove a source account. - - Removing a source account will also remove any mapping between the source bank feed bank accounts and the target bankfeed bank account. - operationId: delete-source-account - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/accountId' + - Bills responses: - '204': - description: No Content + '200': + description: Success + content: + application/json: + schema: + $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': @@ -2454,33 +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' - '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/credentials': - post: + '/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: - - Source accounts - summary: Generate source account credentials - description: "\uFEFFThe _Generate bank account credentials_ endpoint can be used to generate credentials for QuickBooks Online to authenticate the Bank Feed in the QBO portal. Each time this endpoint is called, a new set of credentials will be generated.\n\nThe old credentials will still be valid until the revoke credentials endpoint is used, which will revoke all credentials associated to the data connection.\n\n> **For QuickBooks Online only**\n>\n> Only call this endpoint when onboarding SMBs that use QuickBooks Online." - operationId: generate-credentials - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - requestBody: - required: true - content: - application/json: {} + - Bills responses: '200': description: Success content: - application/json: + application/octet-stream: schema: - $ref: '#/components/schemas/BankAccountCredentials' + title: Data + type: string + format: binary '401': $ref: '#/components/responses/Unauthorized' '402': @@ -2495,22 +1477,58 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - delete: - tags: - - Source accounts - summary: Delete all source account credentials - x-speakeasy-name-override: delete-credentials + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/payment': + parameters: + - $ref: '#/components/parameters/companyId' + - $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 _Delete Bank Account Credentials_ endpoint serves as a comprehensive mechanism for revoking all existing authorization credentials that a company employs to establish its Bank Feed connection. + 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. - In cases where multiple credential sets have been generated, a single API call to this endpoint revokes all of them. - operationId: delete-bank-feed-credentials - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' + [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: - '204': - description: No Content + '201': + description: Created + content: + application/json: + schema: + $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': @@ -2519,51 +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' - '/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/mapping': + '/companies/{companyId}/connections/{connectionId}/payables/suppliers': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' get: tags: - - Account mapping - summary: List bank feed accounts - description: "\uFEFFThe *List bank accounts* endpoint returns information about a source bank account and any current or potential target mapping accounts.\n\nA bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).\n\n> **For custom builds only**\n> \n> Only use this endpoint if you are building your own account management UI." - operationId: get-bank-account-mapping + - 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. + + 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 | + 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: Success content: application/json: schema: - $ref: '#/components/schemas/BankFeedMapping/definitions/bankFeedMappings' + $ref: '#/components/schemas/Supplier/definitions/suppliers' examples: - Example: + Suppliers: value: - - sourceAccountId: account-001 - status: pending - targetAccountOptions: - - name: Money Bank account - id: d21e25d6-98c5-4bfb-b469-105833bea3c8 - accountNumber: '789' - sortCode: '123456' - - name: Bank of Dave account - id: d06ff4b2-e4f2-4681-9841-014bd008cdab - accountNumber: '99887766' - sortCode: '998866' - - name: LuxLend account - id: c8f252fc-84f3-4a8b-ace8-ae99f41a81ae - accountNumber: '123456789' - sortCode: '123456' - sourceAccountName: account-001 - sourceAccountNumber: '12345670' - sourceBalance: 99.99 - sourceCurrency: GBP + 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/Malformed-Query' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -2572,6 +1643,8 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': @@ -2580,28 +1653,65 @@ paths: $ref: '#/components/responses/Service-Unavailable' post: tags: - - Account mapping - summary: Create bank feed account mapping - description: "\uFEFFThe *Create bank account mapping* endpoint creates a new mapping between a source bank account and a potential account in the accounting software (target account).\n\nA bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software).\n\nTo find valid target account options, first call the [List bank feed account mappings](https://docs.codat.io//bank-feeds-api#/operations/get-bank-account-mapping) endpoint.\n\n> **For custom builds only**\n>\n> Only use this endpoint if you are building your own account management UI.\n\n#### Account mapping variability\n\nThe method of mapping the source account to the target account varies depending on the accounting software your company uses.\n\n#### Mapping options:\n\n1. **API Mapping**: Integrate the mapping journey directly into your application for a seamless user experience.\n2. **Codat UI Mapping**: If you prefer a quicker setup, you can utilize Codat's provided user interface for mapping.\n3. **Accounting Platform Mapping**: For some accounting software, the mapping process must be conducted within the software itself.\n\n### Integration-specific behavior\n\n| Bank Feed Integration | API Mapping | Codat UI Mapping | Accounting Platform Mapping |\n| --------------------- | ----------- | ---------------- | --------------------------- |\n| Xero | ✅ | ✅ | |\n| FreeAgent | ✅ | ✅ | |\n| Oracle NetSuite | ✅ | ✅ | |\n| Exact Online (NL) | ✅ | ✅ | |\n| QuickBooks Online | | | ✅ |\n| Sage | | | ✅ |" - operationId: create-bank-account-mapping + - 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/BankFeedAccountMapping' + $ref: '#/components/schemas/Supplier/definitions/supplierPrototype' examples: - Example: + Suppliers: value: - sourceAccountId: acc-002 - targetAccountId: account-081 + 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: Success + '201': + description: Created content: application/json: schema: - $ref: '#/components/schemas/BankFeedAccountMappingResponse' - examples: {} + $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': @@ -2618,35 +1728,97 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections/{connectionId}/bankFeeds/info': + '/companies/{companyId}/connections/{connectionId}/payables/suppliers/{supplierId}': 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. + - 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. ### Supported Integrations - | Integration | Supported | - |-----------------------|-----------| - | Oracle NetSuite | Yes | - | Xero | Yes | - | Exact | No | - | FreeAgent | No | - | Sage | No | - | QuickBooks Online | No | - operationId: get-company-information - tags: - - Company information + + | 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. + operationId: update-supplier + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Supplier/definitions/supplierPrototype' + examples: + Update supplier: + value: + 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: Success content: application/json: schema: - $ref: '#/components/schemas/CompanyInformation' - examples: {} + $ref: '#/components/schemas/Supplier' + examples: + Updated supplier: + 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': @@ -2663,440 +1835,53 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections/{connectionId}/bankFeeds/otp': + '/companies/{companyId}/connections/{connectionId}/payables/bankAccounts': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' post: tags: - - Source accounts - summary: Generate one-time password - description: | - The *Generate OTP* endpoint generates a one-time password (OTP) for a bank feed connection. The OTP is returned along with an expiry time, after which it will no longer be valid. - - > **For Sage only** - > - > Only call this endpoint for connections to Sage. Calling it for other integrations will return an error. - operationId: generate-otp - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/GenerateOtpResponse' - 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}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions': - post: - tags: - - Transactions - summary: Create bank transactions - description: "\uFEFFThe *Create bank transactions* endpoint creates new [bank transactions](https://docs.codat.io/bank-feeds-api#/schemas/BankTransactions) for a given company's connection.\n\n[Bank transactions](https://docs.codat.io/bank-feeds-api#/schemas/BankTransactions) are records of monetary amounts that have moved in and out of an SMB's bank account.\n\n**Integration-specific behavior**\n\nThe required properties may vary based on the integration. For detailed requirements specific to each accounting software, refer to the API reference examples.\nAlternatively, you can view the [Get create bank transaction model](https://docs.codat.io/bank-feeds-api#/operations/get-create-bank-transactions-model) for more information." - operationId: create-bank-transactions - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/accountId' - - $ref: '#/components/parameters/timeoutInMinutes' - - name: allowSyncOnPushComplete - in: query - schema: - type: boolean - default: true - description: Allow a sync upon push completion. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateBankTransactions' - examples: - Xero: - value: - accountId: 49cd5a42-b311-4750-9361-52e2ed1d4653 - transactions: - - id: '716422529' - date: '2023-08-22T10:21:00' - description: Repayment of Credit Card - counterparty: Bank of Example - reference: Ref-12345 - reconciled: true - amount: 100 - balance: 100 - transactionType: Credit - - id: '716422530' - date: '2023-08-22T10:22:00' - description: Amazon Purchase - counterparty: Amazon - reference: Ref-12346 - reconciled: false - amount: -100 - balance: 0 - transactionType: Debit - - id: '716422531' - date: '2023-08-22T10:23:00' - description: Office Supplies - counterparty: Office Mart - reference: Ref-12347 - reconciled: false - amount: -60 - balance: -60 - transactionType: Debit - QuickBooks Online Bank Feeds: - value: - accountId: 49cd5a42-b311-4750-9361-52e2ed1d4653 - transactions: - - id: '716422529' - date: '2023-08-22T10:21:00' - description: Repayment of Credit Card - amount: 100 - balance: 100 - transactionType: Credit - - id: '716422530' - date: '2023-08-22T10:22:00' - description: Amazon Purchase - amount: -100 - balance: 0 - transactionType: Debit - - id: '716422531' - date: '2023-08-22T10:23:00' - description: Office Supplies - amount: -60 - balance: -60 - transactionType: Debit - FreeAgent: - value: - accountId: 49cd5a42-b311-4750-9361-52e2ed1d4653 - transactions: - - id: '716422529' - date: '2023-08-22T10:21:00' - description: Repayment of Credit Card - amount: 100 - transactionType: Credit - - id: '716422530' - date: '2023-08-22T10:22:00' - description: Amazon Purchase - amount: -100 - transactionType: Debit - - id: '716422531' - date: '2023-08-22T10:23:00' - description: Office Supplies - amount: -60 - transactionType: Debit - Sage: - value: - accountId: 49cd5a42-b311-4750-9361-52e2ed1d4653 - transactions: - - id: '716422529' - date: '2023-08-22T10:21:00' - description: Repayment of Credit Card - counterparty: Bank of Example - reference: Ref-12345 - amount: 100 - balance: 100 - transactionType: Credit - - id: '716422530' - date: '2023-08-22T10:22:00' - description: Amazon Purchase - counterparty: Amazon - reference: Ref-12346 - amount: -100 - balance: 0 - transactionType: Debit - - id: '716422531' - date: '2023-08-22T10:23:00' - description: Office Supplies - counterparty: Office Mart - reference: Ref-12347 - amount: -60 - balance: -60 - transactionType: Debit - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateBankTransactionsResponse' - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions': - get: - tags: - - Transactions - summary: Get create bank transactions model - description: |- - The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/bank-feeds-api#/schemas/BankTransactions) for a given company and integration. - - [Bank account transactions](https://docs.codat.io/bank-feeds-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. - - **Integration-specific behavior** - - See the *response examples* for integration-specific indicative models. - operationId: get-create-bank-transactions-model - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/accountId' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/PushOption' - examples: {} - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/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 create operation - tags: - - Transactions - operationId: get-create-operation - x-speakeasy-name-override: get-create-operation - description: |- - The **Get create operation** endpoint returns a specific [write operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company. - - Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. - - For bank feeds, your push operations will only relate to the `bankTransactions` data type. - 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}/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 create operations - tags: - - Transactions - operationId: list-create-operations - x-speakeasy-name-override: list-create-operations - description: |- - The **List create operations** endpoint returns a list of [write operations](/using-the-api/push) performed on the company. - - Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. - - For bank feeds, use this endpoint to view write operations related to the `bankTransactions` data type. - 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}/connections/{connectionId}/bankFeedAccounts/{sourceAccountId}/managedBankFeeds/syncs/{syncId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - name: sourceAccountId - in: path - required: true - schema: - type: string - description: The ID of the source bank account. - - name: syncId - in: path - required: true - schema: - type: string - format: uuid - description: The ID of the sync. - get: - tags: - - Managed bank feeds - summary: Get sync - operationId: get-managed-bank-feed-sync - x-speakeasy-name-override: get-sync - description: |- - The _Get sync_ endpoint returns the [sync status](https://docs.codat.io/bank-feeds-api#/schemas/SyncStatusResult) for a given 'syncId'. - - A sync is a single execution that fetches bank transactions from a connected bank account and records them in the company's accounting software. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SyncStatusResult' - '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}/bankFeedAccounts/{sourceAccountId}/managedBankFeeds/syncs/latest': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - name: sourceAccountId - in: path - required: true - schema: - type: string - description: The ID of the source bank account. - get: - tags: - - Managed bank feeds - summary: Get latest sync - operationId: get-latest-managed-bank-feed-sync - x-speakeasy-name-override: get-latest-sync - description: |- - The _Get latest sync_ endpoint returns the status for a given source account's [most recent sync](https://docs.codat.io/bank-feeds-api#/schemas/SyncStatusResult). - - A sync is a single execution that fetches bank transactions from a connected bank account and records them in the company's accounting software. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SyncStatusResult' - '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' - '/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/{sourceAccountId}/managedBankFeeds/syncs': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - name: sourceAccountId - in: path - required: true - schema: - type: string - description: The ID of the source bank account. - post: - tags: - - Managed bank feeds - summary: Run ad-hoc sync - operationId: run-managed-bank-feed-ad-hoc-sync - x-speakeasy-name-override: run-ad-hoc-sync - description: |- - The _Run ad-hoc sync_ endpoint immediately runs a sync with a fetch period from the last successful sync to the execution time of the new sync. - - A sync is a single execution that fetches bank transactions from a connected bank account and records them in the company's accounting software. - - Use either the [_Get latest sync_](https://docs.codat.io/bank-feeds-api#/operations/get-latest-managed-bank-feed-sync) endpoint or the [_Get sync_](https://docs.codat.io/bank-feeds-api#/operations/fetch-managed-bank-feed-sync-by-id) endpoint to get the result of this sync. + - 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/BankAccount/definitions/bankAccountPrototype' + examples: + Bank account example: + value: + nominalCode: '22' + name: Plutus - Payables - Bank Account 12 + accountNumber: 0120 0440 + sortCode: 50-50-50 + currency: GBP + accountType: Debit responses: '201': description: Created content: application/json: schema: - $ref: '#/components/schemas/StartScheduledSyncResult' + $ref: '#/components/schemas/BankAccount' + examples: + Created bank account: + value: + 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': @@ -3107,14 +1892,14 @@ 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: "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: @@ -3158,529 +1943,639 @@ webhooks: responses: '200': description: Return a 200 status to indicate that the webhook was received successfully. - bankFeeds.sourceAccount.connected: - post: - description: Triggered when a bank feed source account has become connected to a target account. This occurs when a user sets up mapping between the two. - x-svix-feature-flag: bank-feeds - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SourceAccountWebhook' - examples: - Connected: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: bankFeeds.sourceAccount.connected - generatedDate: '2022-10-23T00:00:00.000Z' - payload: - referenceCompany: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: Toft stores - description: Requested early access to the new financing scheme. - links: - portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' - connectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - sourceAccount: - id: acc-002 - accountName: account-081 - sortCode: '040004' - accountNumber: '12345678' - currency: GBP - balance: 99.99 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - status: pending - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - bankFeeds.sourceAccount.disconnected: - post: - description: Called when a bank feed source account has become disconnected. - x-svix-feature-flag: bank-feeds - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SourceAccountWebhook' - examples: - Disconnected: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: bankFeeds.sourceAccount.disconnected - generatedDate: '2022-10-23T00:00:00.000Z' - payload: - referenceCompany: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: Toft stores - description: Requested early access to the new financing scheme. - links: - portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' - connectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - sourceAccount: - id: acc-002 - accountName: account-081 - sortCode: '040004' - accountNumber: '12345678' - currency: GBP - balance: 99.99 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - status: pending - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. components: schemas: - BankAccountCredentials: - title: Bank Account Credentials - description: Result of generate credentials + 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. + + > **Retrieving attachments** + > + > If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data. + + Unlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments. + + Note that different integrations have different requirements for file size and extension of attachments. + + | Integration | File size | File extension | + |-------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| + | Xero | 4 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | + | QuickBooks Online | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | + | NetSuite | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP | + | Dynamics 365 Business Central | 350 MB | Dynamics do not explicitly outline which file types are supported but they do state here that "You can attach any type of file, such as text, image, or video files". | + 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**. + + 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. + + 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. + 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: + 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 + 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. + + 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. + 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: - username: + id: type: string - example: S0MW-TR0P-7DS0 - description: Username used by the bank feeds platform to retrieve transactions - password: + description: 'Identifier for the bill, unique for the company in the accounting software.' + reference: type: string - example: cO0ajh0uGyTN0Pwh - description: Password to enable the bank feeds platform to securely retrieve transactions. - examples: - - QuickBooks Online Bank Feeds: null - username: S0MW-TR0P-7DS0 - password: cO0ajh0uGyTN0Pwh - BankAccounts: - x-internal: true - title: 'Accounting: Bank accounts' - allOf: - - type: object - properties: - results: - type: array - items: - 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/bank-feeds-api#/schemas/Account) data type. + 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_. - ## Overview + ## Unknown currencies - A list of bank accounts associated with a company and a specific data connection. + In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - 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/BankAccounts/allOf/0/properties/results/items/definitions/bankAccountPrototype' - - 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 - supplementalData: - title: Supplemental data - type: object - x-internal: true - description: |- - Supplemental data is additional data you can include in our standard data types. + 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. - 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 - - title: Modified dates - x-internal: true - allOf: - - title: ModifiedDate - x-internal: true - type: object - properties: - modifiedDate: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: |- - The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache. + Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. - 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. + 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. - 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)). + 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). - 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/DateTime' - - 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. + 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. - 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 + ## Examples with base currency of GBP - In Codat's data model, dates and times are represented using the ISO 8601 standard. - definitions: - bankAccountPrototype: - title: Bank account prototype - type: object - properties: - accountName: - type: string - nullable: true - description: Name of the bank account in the accounting software. - accountType: - title: Bank Account Type - x-internal: true - enum: - - Unknown - - Credit - - Debit - type: string - description: |- - The type of transactions and balances on the account. - For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. - For Debit accounts, positive balances are assets, and positive transactions **increase** assets. - nominalCode: - type: string - nullable: true - description: Code used to identify each nominal account for a business. - sortCode: - type: string - nullable: true - description: |- - Sort code for the bank account. + | 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 | - 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. + ## Examples with base currency of USD - 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. + | 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 | - 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/SourceAccount/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/BankAccounts/allOf/0/properties/results/items/definitions/bankAccountStatus' - bankAccountCreateResponse: - title: Create bank account response - allOf: - - properties: - data: - allOf: - - $ref: '#/components/schemas/BankAccounts/allOf/0/properties/results/items' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - bankAccountRef: - title: Bank account reference - type: object - properties: - id: - type: string - description: Bank account 'id' for the account transaction. - name: - type: string - description: bank account 'name' for the account transaction. - description: Links to the Account transactions data type. - bankAccounts: - title: 'Accounting: Bank accounts' - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/BankAccounts/allOf/0/properties/results/items' - - $ref: '#/components/schemas/Companies/allOf/1' - bankAccountStatus: - title: Account status - enum: - - Unknown - - Active - - Archived - - Pending - type: string - description: Status of the bank account. - example: Active - - $ref: '#/components/schemas/Companies/allOf/1' - BankFeedAccountMapping: - title: Bank feed account mapping - type: object - additionalProperties: false - properties: - sourceAccountId: - type: string - description: Unique ID for the source account - targetAccountId: - type: string + ### 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. | + lineItems: + type: array nullable: true - description: Unique ID for the target account - feedStartDate: - $ref: '#/components/schemas/DateTime' + 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: The date from which bank transactions can be provided to the platform. + 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. + + 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. required: - - sourceAccountId - examples: - - sourceAccountId: acc-002 - targetAccountId: account-081 - BankFeedAccountMappingResponse: - title: Bank feed account mapping response + - supplierRef + - issueDate + - dueDate + - currency + - status + definitions: + 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: + description: + type: string + nullable: true + 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: '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: '''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: 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 properties: - sourceAccountId: - type: string - description: Unique ID for the source account. - targetAccountId: + id: type: string - nullable: true - description: Unique ID for the target account. - status: + format: uuid + description: Unique identifier of the bill event. + type: type: string - nullable: true - description: Status of the POST request. - error: + description: Type of webhook event. + example: payables.bill.created + createdDate: type: string - nullable: true - description: Error returned during the post request - examples: - - sourceAccountId: acc-002 - targetAccountId: account-081 - status: Failed - error: A feed connection already exists to this account - BankFeedMapping: - title: Bank feed mapping + 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: Mapping options bills + description: The bill mapping options for a company's accounting software. type: object - additionalProperties: false properties: - sourceAccountId: - type: string - description: Unique ID for the source account. - sourceAccountName: - type: string - description: Name for the source account. - sourceAccountNumber: + 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. + - `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 + description: The current status of the account. + enum: + - Active + - Archived + example: Active + BillPayment: + title: Bill payment + type: object + description: '' + properties: + id: type: string - description: Account number for the source account. - sourceBalance: + description: 'Identifier for the bill payment, unique for the company in the accounting software.' + amount: type: number format: decimal - description: Balance for the source account. - sourceCurrency: - $ref: '#/components/schemas/SourceAccount/properties/currency' - targetAccountId: - type: string - nullable: true - description: Unique ID for the target account in the accounting software. - targetAccountName: - type: string - description: Name for the target account in the accounting software. - status: + 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 status. - targetAccountOptions: - type: array nullable: true - description: An array of potential target accounts. - items: - $ref: '#/components/schemas/BankFeedMapping/definitions/targetAccountOption' - feedStartDate: - $ref: '#/components/schemas/DateTime' - nullable: true - description: The date from which bank transactions can be provided to the platform. - description: 'A bank feed connection between a source account and a target account, including potential target accounts.' + 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: - targetAccountOption: - title: Target Account Option + billPaymentPrototype: + title: Bill payment prototype + type: object + properties: + 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: Id of the target account. - name: - type: string - nullable: true - description: Name of the target account. - balance: - type: number - format: decimal - nullable: true - description: The balance of the account. - sortCode: - type: string - nullable: true - description: The sort code of the account. - accountNumber: - type: string - nullable: true - description: The account number of the account. - bankFeedMappings: - title: Bank feed mappings - type: array - items: - $ref: '#/components/schemas/BankFeedMapping' - additionalProperties: false - examples: - - sourceAccountId: acc-002 - targetAccountId: account-081 - sourceCurrency: USD - status: Success - feedStartDate: '2023-01-09T14:14:14.1057478Z' - sourceAccountName: ACME Bank - sourceAccountNumber: 1234-5678 - sourceBalance: 500 - targetAccountName: ACME Bank - - sourceAccountId: c53fd75a-dddb-4493-839a-5090b008f625 - status: pending - targetAccountOptions: - - name: account-081 - id: 044096a7-1478-4554-8820-f478caad1b00 - balance: 100.99 - sortCode: '602336' - accountNumber: '23203' - sourceAccountName: bank name here - sourceAccountNumber: '5670' - sourceBalance: 1550 - sourceCurrency: GBP - BankTransactions: - title: Bank transactions - type: array - maxItems: 1000 - items: - title: Bank transaction - type: object - properties: - id: - type: string - description: 'Identifier for the bank account transaction, unique for the company in the accounting software.' - example: '716422529' - date: - title: Local date time - type: string - examples: - - '2023-08-22T10:21:00' - - '2023-08-22' - 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: - - ``` - 2023-08-22T10:21:00 - 2023-08-22 - ``` - - When pushing bank transaction data to Codat, the date is treated as a local date. This means: - - - The date/time is used exactly as provided, without any timezone conversion. - - If a timezone offset is included (e.g., `2023-08-22T10:21:00-05:00`), the offset will be ignored and only the local date/time portion will be used. - - We recommend providing dates without a timezone suffix for clarity (e.g., `2023-08-22T10:21:00` rather than `2023-08-22T10:21:00Z`). - description: - type: string - nullable: true - description: Description of the bank transaction. - example: Debit for Payment Id sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60 - counterparty: - type: string - nullable: true - description: The giving or receiving party such as a person or organization. - example: ACME INC - reference: - type: string - nullable: true - description: An optional reference to the bank transaction. - example: reference for transaction - reconciled: - type: boolean - nullable: true - description: '`True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting software.' - example: false - amount: - type: number - format: decimal - description: The amount transacted in the bank transaction. - example: 999.99 - balance: - type: number - format: decimal - description: 'The remaining balance in the account with ID `accountId`. This field is optional for QuickBooks Online but is required for Xero, Sage, NetSuite, Exact, and FreeAgent.' - example: -999.99 - transactionType: - title: Bank transaction type - nullable: true - description: Type of transaction for the bank statement line. - type: string - enum: - - Unknown - - Credit - - Debit - - Int - - Div - - Fee - - SerChg - - Dep - - Atm - - Pos - - Xfer - - Check - - Payment - - Cash - - DirectDep - - DirectDebit - - RepeatPmt - - Other + 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 @@ -3697,7 +2592,7 @@ components: - client.rateLimit.reset - client.rateLimit.reached generatedDate: - $ref: '#/components/schemas/DateTime' + $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' @@ -3713,7 +2608,7 @@ components: type: integer description: Total number of requests remaining for your client. expiryDate: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' description: The date time in UTC when your daily quota is reset. Companies: title: Companies @@ -3725,68 +2620,10 @@ components: type: array items: $ref: '#/components/schemas/Company' - - type: object - title: Pagination information - x-internal: true - properties: - pageNumber: - type: integer - description: Current page number. - pageSize: - type: integer - description: Number of items to return in results array. - maximum: 2000 - totalResults: - type: integer - description: Total number of items. - _links: - $ref: '#/components/schemas/Companies/allOf/1/definitions/links' - definitions: - links: - title: Hal Links - type: object - required: - - self - - current - properties: - self: - $ref: '#/components/schemas/Companies/allOf/1/definitions/halRef' - current: - $ref: '#/components/schemas/Companies/allOf/1/definitions/halRef' - next: - $ref: '#/components/schemas/Companies/allOf/1/definitions/halRef' - previous: - $ref: '#/components/schemas/Companies/allOf/1/definitions/halRef' - examples: - - self: - href: /companies - current: - href: /companies?page=1&pageSize=10 - halRef: - title: Hypertext reference - type: object - properties: - href: - type: string - format: uri-reference - description: Uri hypertext reference. - required: - - pageNumber - - pageSize - - totalResults - - _links - examples: - - pageNumber: 1 - pageSize: 10 - totalResults: 1 - _links: - self: - href: '/companies/{id}/data/{dataType}' - current: - href: '/companies/{id}/data/{dataType}?page=1&pageSize=10' + - $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/bank-feeds-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' @@ -3816,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/DateTime' + $ref: '#/components/schemas/Connection/properties/created' nullable: true created: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' createdByUserName: type: string description: Name of user that created the company in Codat. @@ -3898,62 +2735,19 @@ components: products: - spend-insights - lending - CompanyAccessToken: - title: Company access token - description: Details of the access token provisioned for a company. - type: object - allOf: - - $ref: '#/components/schemas/CompanyAccessToken/definitions/accessToken' - definitions: - accessToken: - title: Access token - type: object - properties: - expiresIn: - type: integer - description: The number of seconds until the access token expires. - example: 86400 - accessToken: - type: string - description: The access token for the company. - tokenType: - type: string - description: The type of token. - example: Bearer - required: - - expiresIn - - accessToken - - tokenType - examples: - - expiresIn: 86400 - accessToken: string - tokenType: Bearer CompanyInformation: title: Company information - description: Information about the company from the underlying accounting software. type: object + description: Gets the latest basic info for a company. properties: companyName: type: string - nullable: false + nullable: true description: Name of the linked company. baseCurrency: type: string - nullable: false - description: Currency set in the accounting software of the linked company. - planType: - type: string - nullable: true - description: 'Accounting software subscription type such as Trial, Demo, Standard.' - multicurrencyEnabled: - type: boolean - description: Boolean showing if the organisation has multicurrency enabled. - currencies: - type: array nullable: true - description: Array of enabled currencies for the linked company. - items: - type: string + description: Currency set in the accounting software of the linked company. Used by the currency rate. CompanyRequestBody: title: Create company request x-internal: true @@ -3990,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/bank-feeds-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: @@ -4032,10 +2826,34 @@ components: status: $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' lastSync: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' nullable: true created: - $ref: '#/components/schemas/DateTime' + 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 + ``` + + + + 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 @@ -4079,7 +2897,7 @@ components: type: string description: A message about a error returned by Codat. erroredOnUtc: - $ref: '#/components/schemas/DateTime' + $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. @@ -4091,7 +2909,7 @@ components: resolvedOnUtc: description: The datetime in Utc that the error was resolved. nullable: true - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' dataConnectionSourceType: title: Source Type description: The type of platform of the connection. @@ -4126,110 +2944,88 @@ components: type: array items: $ref: '#/components/schemas/Connection' - - $ref: '#/components/schemas/Companies/allOf/1' - CreateBankTransactions: - title: Create bank transactions + - $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 + - currentStatus properties: - accountId: + dataType: + title: Data types + x-internal: true type: string - description: Unique identifier for a bank account. - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - '7110701885' - - EILBDVJVNUAGVKRQ - - Checking 0202 - transactions: - $ref: '#/components/schemas/BankTransactions' - required: - - accountId - - transactions - CreateBankTransactionsResponse: - title: Create bank transaction response - x-internal: true - allOf: - - type: object - properties: - data: - $ref: '#/components/schemas/CreateBankTransactions' - - $ref: '#/components/schemas/PushOperation' + description: Available data types + enum: + - accountTransactions + - balanceSheet + - bankAccounts + - bankTransactions + - billCreditNotes + - billPayments + - bills + - cashFlowStatement + - chartOfAccounts + - company + - creditNotes + - customers + - directCosts + - directIncomes + - invoices + - itemReceipts + - items + - journalEntries + - journals + - paymentMethods + - payments + - profitAndLoss + - purchaseOrders + - salesOrders + - suppliers + - taxRates + - trackingCategories + - transfers + - banking-accountBalances + - banking-accounts + - banking-transactionCategories + - banking-transactions + - commerce-companyInfo + - commerce-customers + - commerce-disputes + - commerce-locations + - commerce-orders + - commerce-paymentMethods + - commerce-payments + - commerce-productCategories + - commerce-products + - commerce-taxComponents + - commerce-transactions + example: invoices + lastSuccessfulSync: + $ref: '#/components/schemas/Connection/properties/created' + currentStatus: + $ref: '#/components/schemas/PullOperation/properties/status' + latestSyncId: + type: string + description: Unique identifier for most recent sync of data type. + format: uuid + example: ad474a37-2003-478e-baee-9af9f1ec2fe3 + latestSuccessfulSyncId: + type: string + description: Unique identifier for the most recent successful sync of data type. + format: uuid + example: 8220fc90-55b6-47bc-9417-48ac6ea93101 + examples: + - dataType: string + lastSuccessfulSync: '2022-01-01T13:00:00.000Z' + currentStatus: string + latestSyncId: ad474a37-2003-478e-baee-9af9f1ec2fe3 + latestSuccessfulSyncId: 8220fc90-55b6-47bc-9417-48ac6ea93101 DataType: - title: Data types x-internal: true - type: string - description: Available data types - enum: - - accountTransactions - - balanceSheet - - bankAccounts - - bankTransactions - - billCreditNotes - - billPayments - - bills - - cashFlowStatement - - chartOfAccounts - - company - - creditNotes - - customers - - directCosts - - directIncomes - - invoices - - itemReceipts - - items - - journalEntries - - journals - - paymentMethods - - payments - - profitAndLoss - - purchaseOrders - - salesOrders - - suppliers - - taxRates - - trackingCategories - - transfers - - banking-accountBalances - - banking-accounts - - banking-transactionCategories - - banking-transactions - - commerce-companyInfo - - commerce-customers - - commerce-disputes - - commerce-locations - - commerce-orders - - commerce-paymentMethods - - commerce-payments - - commerce-productCategories - - commerce-products - - commerce-taxComponents - - commerce-transactions - example: invoices - DateTime: - title: Date time - type: string - examples: - - '2022-10-23T00:00: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 - ``` - - - - 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. + $ref: '#/components/schemas/DataStatus/properties/dataType' ErrorMessage: title: Error message type: object @@ -4288,24 +3084,137 @@ components: type: string nullable: true description: Name of validator. - GenerateOtpResponse: - title: OTP response + Pagination: + title: Pagination metadata + x-internal: true type: object - description: Response containing a one-time password and its expiry time. - additionalProperties: false properties: - otp: + continuationToken: type: string - description: The one-time password. - expiry: - $ref: '#/components/schemas/DateTime' - description: The expiry date and time of the OTP in UTC. + 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 + x-internal: true + properties: + pageNumber: + type: integer + description: Current page number. + pageSize: + type: integer + description: Number of items to return in results array. + maximum: 2000 + totalResults: + type: integer + description: Total number of items. + _links: + $ref: '#/components/schemas/PagingInfo/definitions/links' + definitions: + links: + title: Hal Links + type: object + required: + - self + - current + properties: + self: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + current: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + next: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + previous: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + examples: + - self: + href: /companies + current: + href: /companies?page=1&pageSize=10 + halRef: + title: Hypertext reference + type: object + properties: + href: + type: string + format: uri-reference + description: Uri hypertext reference. required: - - otp - - expiry + - pageNumber + - pageSize + - totalResults + - _links examples: - - otp: GT40U4 - expiry: '2026-04-08T10:30:00Z' + - pageNumber: 1 + pageSize: 10 + totalResults: 1 + _links: + self: + 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: |- @@ -4369,9 +3278,9 @@ components: nullable: true description: A message about a transient or persistent error returned by Codat or the source platform. requested: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' completed: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' progress: type: integer description: An integer signifying the progress of the pull operation. @@ -4412,7 +3321,7 @@ components: type: array items: $ref: '#/components/schemas/PullOperation' - - $ref: '#/components/schemas/Companies/allOf/1' + - $ref: '#/components/schemas/PagingInfo' PushOperation: title: Push operation type: object @@ -4425,7 +3334,7 @@ components: items: $ref: '#/components/schemas/PushOperation/definitions/pushOperationChange' dataType: - $ref: '#/components/schemas/DataType' + $ref: '#/components/schemas/DataStatus/properties/dataType' description: 'The type of data being pushed, eg invoices, customers.' companyId: $ref: '#/components/parameters/companyId/schema' @@ -4436,10 +3345,10 @@ components: dataConnectionKey: $ref: '#/components/parameters/connectionId/schema' requestedOnUtc: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' description: The datetime when the push was requested. completedOnUtc: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' description: 'The datetime when the push was completed, null if Pending.' timeoutInMinutes: type: integer @@ -4493,731 +3402,210 @@ components: itemId: type: string nullable: true - description: Unique identifier for a validation item. - message: - type: string - nullable: true - description: A message outlining validation item's issue. - validatorName: - type: string - nullable: true - description: Name of validator. - additionalProperties: false - pushChangeType: - title: Push change type - description: Type of change being applied to record in third party platform. - type: string - enum: - - Unknown - - Created - - Modified - - Deleted - - AttachmentUploaded - pushOperationRef: - title: Push operation reference - x-internal: true - type: object - properties: - id: - type: string - description: Unique identifier for a push operation. - dataType: - $ref: '#/components/schemas/DataType' - nullable: true - additionalProperties: false - pushOperationStatus: - title: Push operation status - type: string - enum: - - Pending - - Failed - - Success - - TimedOut - description: The current status of the push operation. - pushOperationChange: - type: object - properties: - type: - $ref: '#/components/schemas/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/Companies/allOf/1' - 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' - SourceAccount: - title: Source account (v1) - type: object - description: The target bank account in a supported accounting software for ingestion into a bank feed. - additionalProperties: false - properties: - id: - type: string - description: Unique ID for the bank account. - accountName: - type: string - nullable: true - description: The bank account name. - accountType: - type: string - nullable: true - description: The type of bank account e.g. Credit. - accountNumber: - type: string - nullable: true - description: The account number. - sortCode: - type: string - nullable: true - description: The sort code. - 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 - balance: - type: number - format: decimal - nullable: true - description: The latest balance for the bank account. - modifiedDate: - $ref: '#/components/schemas/DateTime' - nullable: true - description: The last date the bank account was modified. - status: - type: string - nullable: true - description: Status of the source account. - enum: - - pending - - connected - - connecting - - disconnected - - unknown - feedStartDate: - $ref: '#/components/schemas/DateTime' - nullable: true - required: - - id - definitions: - sourceAccountPrototype: - title: Source account (v1) - type: object - properties: - id: - $ref: '#/components/schemas/SourceAccount/properties/id' - accountName: - $ref: '#/components/schemas/SourceAccount/properties/accountName' - accountType: - $ref: '#/components/schemas/SourceAccount/properties/accountType' - accountNumber: - $ref: '#/components/schemas/SourceAccount/properties/accountNumber' - sortCode: - $ref: '#/components/schemas/SourceAccount/properties/sortCode' - currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' - balance: - $ref: '#/components/schemas/SourceAccount/properties/balance' - modifiedDate: - $ref: '#/components/schemas/SourceAccount/properties/modifiedDate' - required: - - id - sourceAccounts: - title: Source accounts - type: array - items: - $ref: '#/components/schemas/SourceAccount' - examples: - - id: acc-002 - accountName: account-081 - sortCode: '123456' - accountType: Credit - accountNumber: '12345670' - currency: GBP - balance: 99.99 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - status: pending - - id: acc-003 - accountName: account-095 - sortCode: '123456' - accountType: Credit - accountNumber: '12345671' - currency: USD - balance: 0 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - status: pending - SourceAccountBatchCreateResponse: - title: Batch source account request creation response - description: Account ID and resulting object of the batch `Create source account` request. - type: object - properties: - sourceAccountId: + description: Unique identifier for a validation item. + message: + type: string + nullable: true + description: A message outlining validation item's issue. + validatorName: + type: string + nullable: true + description: Name of validator. + additionalProperties: false + pushChangeType: + title: Push change type + description: Type of change being applied to record in third party platform. type: string - description: Unique ID for the source account. - examples: - - '12345' - result: - $ref: '#/components/schemas/SourceAccountBatchCreateResponse/definitions/sourceAccountBatchCreateResult' - definitions: - sourceAccountBatchCreateResult: - title: Source Account Batch Create Result - description: Status details and corresponding object of the `Create account` operation. + enum: + - Unknown + - Created + - Modified + - Deleted + - AttachmentUploaded + pushOperationRef: + title: Push operation reference + x-internal: true type: object properties: - statusCode: - type: integer - description: The HTTP status code for the creation of the source account - error: + id: type: string + description: Unique identifier for a push operation. + dataType: + $ref: '#/components/schemas/DataStatus/properties/dataType' nullable: true - description: A brief description of the error. - account: - $ref: '#/components/schemas/SourceAccount' - SourceAccountBatchErrorResponse: - title: Batch source account creation error - description: Describes the error that occured when trying to create the specified source account. - type: object - properties: - sourceAccountId: + additionalProperties: false + pushOperationStatus: + title: Push operation status type: string - description: Unique ID for the source account. - examples: - - '12345' - result: + enum: + - Pending + - Failed + - Success + - TimedOut + description: The current status of the push operation. + pushOperationChange: type: object properties: - statusCode: - description: The error status code for the attempted creation of the source account. - type: string - examples: - - 409 - error: - description: The error description for the attempted creation of the source account. + type: + $ref: '#/components/schemas/PushOperation/definitions/pushChangeType' + recordRef: + $ref: '#/components/schemas/PushOperation/definitions/pushOperationRef' + attachmentId: type: string - examples: - - A bank account already exists with the same Id - SourceAccountV2: - title: Source account (v2) + 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 - description: The target bank account in a supported accounting software for ingestion into a bank feed. - additionalProperties: false properties: id: type: string - description: Unique ID for the bank account. - accountName: + description: 'Identifier for the supplier, unique to the company in the accounting software.' + supplierName: type: string - description: The bank account name. - accountType: + description: 'Name of the supplier as recorded in the accounting system, typically the company name.' + contactName: type: string - description: 'The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard.' - enum: - - checking - - savings - - loan - - creditCard - - prepaidCard - accountNumber: + nullable: true + description: Name of the main contact for the supplier. + emailAddress: type: string - description: The account number. - sortCode: + nullable: true + description: Email address that the supplier may be contacted on. + phone: type: string nullable: true - description: The sort code. - routingInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/routingInfo' - currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' + 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/Supplier/definitions/supplierStatus' balance: type: number format: decimal - description: The latest balance for the bank account. - accountInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/accountInfo' - modifiedDate: - $ref: '#/components/schemas/DateTime' nullable: true - description: The last date the bank account was modified. - status: + description: Amount outstanding against the supplier. + defaultCurrency: type: string nullable: true - description: Status of the source account. - enum: - - pending - - connected - - connecting - - disconnected - - unknown - feedStartDate: - nullable: true - title: Date - type: string - example: '2022-10-23' - description: |- - In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example: - ``` - 2020-10-08 - ``` - required: - - id - - accountName - - accountType - - accountNumber - - currency - - balance + description: Default currency the supplier's transactional data is recorded in. + 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. + + 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. definitions: - sourceAccountV2Prototype: - title: Source account (v2) + supplierPrototype: + title: Supplier prototype type: object properties: - id: - $ref: '#/components/schemas/SourceAccountV2/properties/id' - accountName: - $ref: '#/components/schemas/SourceAccountV2/properties/accountName' - accountType: - $ref: '#/components/schemas/SourceAccountV2/properties/accountType' - accountNumber: - $ref: '#/components/schemas/SourceAccountV2/properties/accountNumber' - routingInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/routingInfo' - sortCode: - $ref: '#/components/schemas/SourceAccountV2/properties/sortCode' - currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' + 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/SourceAccountV2/properties/balance' - modifiedDate: - $ref: '#/components/schemas/SourceAccountV2/properties/modifiedDate' - accountInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/accountInfo' + $ref: '#/components/schemas/Supplier/properties/balance' + defaultCurrency: + $ref: '#/components/schemas/Supplier/properties/defaultCurrency' required: - - id - - accountName - - accountType - - accountNumber - - currency - - balance - accountInfo: - title: Account Info - type: object - nullable: true - properties: - description: - type: string - nullable: true - description: Description of the account. - nickname: - type: string - nullable: true - description: Name given to the account by the user. Used in UIs to assist in account selection. - accountOpenDate: - $ref: '#/components/schemas/SourceAccountV2/properties/feedStartDate' - nullable: true - description: Date when the account was opened or created at the provider - availableBalance: - type: number - format: decimal - nullable: true - description: Balance of funds available for use. This includes pending activity. - sourceAccounts: - title: Source accounts - type: array - items: - $ref: '#/components/schemas/SourceAccountV2' - routingInfo: - title: Routing Info + - supplierName + - status + supplierRef: + title: Supplier reference + description: Reference to the supplier the record relates to. type: object - description: Routing information for the bank. This does not include account number. properties: - bankCode: - type: string - nullable: true - description: The numeric identifier of the routing number - type: + id: + minLength: 1 type: string - nullable: true - default: bankcode - enum: - - rtn - - aba - - swift - - bsb - - iban - - nz2 - - trno - - sortcode - - blz - - ifsc - - bankcode - - apca - - clabe - description: The type of routing number. - examples: - - id: acc-001 - accountName: account-081 - accountType: checking - accountNumber: '12345670' - routingInfo: - bankCode: 021001088 - type: bankcode - currency: GBP - balance: 99.99 - accountInfo: - description: account description 1 - nickname: account 123 - accountOpenDate: '2023-05-06' - availableBalance: 10 - modifiedDate: '2024-08-02T00:00:00.000Z' - status: pending - feedStartDate: '2024-05-01' - - id: acc-002 - accountName: account-083 - accountType: savings - accountNumber: '23456789' - routingInfo: - bankCode: 021001088 - type: bankcode - currency: GBP - balance: 400 - accountInfo: - description: account description 2 - nickname: account 1290 - accountOpenDate: '2023-05-23' - availableBalance: 400 - modifiedDate: '2024-08-02T00:00:00.000Z' - status: pending - feedStartDate: '2024-05-01' - SourceAccountV2BatchCreateResponse: - title: Batch source account (v2) creation response - description: Account ID and resulting object of the batch `Create source account` request. - type: object - properties: - sourceAccountId: - type: string - description: Unique ID for the source account. - examples: - - '12345' - result: - $ref: '#/components/schemas/SourceAccountV2BatchCreateResponse/definitions/sourceAccountV2BatchCreateResult' - definitions: - sourceAccountV2BatchCreateResult: - title: Source Account V2 Batch CreateResult - description: Status details and corresponding object of the `Create account` operation. - type: object - properties: - statusCode: - type: integer - description: The HTTP status code for the creation of the source account - error: + description: The supplier's unique ID + supplierName: type: string nullable: true - description: A brief description of the error. - account: - $ref: '#/components/schemas/SourceAccountV2' - SourceAccountWebhook: - title: Source account status changed webhook - type: object - properties: - id: - type: string - format: uuid - example: ba29118f-5406-4e59-b05c-ba307ca38d01 - description: Unique identifier of the event. - eventType: + description: The supplier's name + required: + - id + supplierStatus: + description: Status of the supplier. type: string - description: The type of event. - examples: - - bankFeeds.sourceAccount.connected - - bankFeeds.sourceAccount.disconnected - generatedDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/SourceAccountWebhook/definitions/sourceAccountWebhookPayload' - definitions: - sourceAccountWebhookPayload: - title: Payload + enum: + - Unknown + - Active + - Archived + suppliers: + title: Suppliers type: object properties: - referenceCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - companyId: - $ref: '#/components/parameters/companyId/schema' - deprecated: true - connectionId: - $ref: '#/components/parameters/connectionId/schema' - sourceAccount: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2' - - $ref: '#/components/schemas/SourceAccount' - StartScheduledSyncResult: - title: Start scheduled sync result - type: object - description: Represents the result of an ad-hoc sync request. - properties: - syncId: - type: string - format: uuid - description: The unique identifier for the created sync. - required: - - syncId - SyncStatusResult: - title: Sync status - type: object - description: Represents the status of a managed bank feed sync. - properties: - syncId: - type: string - format: uuid - description: The unique identifier for the sync. - clientId: - type: string - format: uuid - description: The ID of the client associated with the company that owns the source bank account. - companyId: - type: string - format: uuid - description: The ID of the company that owns the source bank account. - companyName: - type: string - description: The name of the company that owns the source bank account. - dataConnectionId: - type: string - format: uuid - description: The ID of the target accounting data connection. - sourceAccountId: - type: string - description: The ID of the source bank account from which transactions are fetched. - periodStartUtc: - type: string - format: date-time - description: The start of the sync period. - periodEndUtc: - type: string - format: date-time - description: The end of the sync period. - executionStartUtc: - type: string - format: date-time - description: The UTC timestamp when the sync started executing. - status: - type: string - description: 'The current status of the sync. Known values are `Started`, `Failed`, `SuccessDataPushed`, `SuccessNoDataPushed`, `PartialSuccessDataPushed`.' - example: SuccessDataPushed - executionEndUtc: - type: string - format: date-time - nullable: true - description: 'The UTC timestamp when the sync execution ended, if completed (i.e. `status` is any value other than `Started`).' - errorMessage: - type: string - nullable: true - description: Error message if the sync failed. - errorCode: - type: string - nullable: true - description: Error code if the sync failed. - pushOperationKeys: - type: array - items: - type: string - format: uuid - nullable: true - description: 'List of write operation keys associated with the sync, if the sync resulted in write attempts.' - required: - - syncId - - clientId - - companyId - - companyName - - dataConnectionId - - sourceAccountId - - periodStartUtc - - periodEndUtc - - executionStartUtc - - status + 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: - companyId: - name: companyId + attachmentId: + name: attachmentId in: path required: true schema: type: string format: uuid example: 8a210b68-6988-11ed-a1eb-0242ac120002 - description: Unique identifier for your SMB in Codat. - description: Unique identifier for a company. - connectionId: - name: connectionId - in: path - required: true - schema: - type: string - format: uuid - example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - description: Unique identifier for a company's data connection. - description: Unique identifier for a connection. - accountId: - name: accountId - in: path - required: true - schema: - type: string - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - 7110701885 - - EILBDVJVNUAGVKRQ - description: Unique identifier for an account. + description: Unique identifier for an attachment. page: name: page in: query @@ -5255,29 +3643,54 @@ components: type: string example: '-modifiedDate' description: 'Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).' - dataType: - name: dataType - description: The key of a Codat data type + 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 required: true schema: - $ref: '#/components/schemas/DataType' - datasetId: - name: datasetId + type: string + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + description: Unique identifier for your SMB in Codat. + description: Unique identifier for a company. + connectionId: + name: connectionId in: path required: true schema: type: string format: uuid - description: Unique identifier for the dataset that completed its sync. - description: Unique identifier for the dataset that completed its sync. - timeoutInMinutes: - name: timeoutInMinutes + example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + description: Unique identifier for a company's data connection. + description: Unique identifier for a connection. + continuationToken: + name: continuationToken in: query + required: false schema: - type: integer - format: int32 - description: Time limit for the push operation to complete before it is timed out. + 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: 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. @@ -5415,6 +3828,21 @@ components: correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 + Idempotency-Conflict: + description: A request is in progress with the same idempotency key. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 409 + service: PublicApi + error: The data set has not been requested. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 Too-Many-Requests: description: Too many requests were made in a given amount of time. Wait a short period and then try again. content: diff --git a/.speakeasy/logs/changes/old.openapi.yaml b/.speakeasy/logs/changes/old.openapi.yaml index b20877e2f..68b700f8b 100644 --- a/.speakeasy/logs/changes/old.openapi.yaml +++ b/.speakeasy/logs/changes/old.openapi.yaml @@ -3,31 +3,12 @@ servers: - description: Production url: 'https://api.codat.io' info: - title: Bank Feeds + 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: - email: support@codat.io name: Codat - description: |- - Bank Feeds solution enables your SMB users to set up bank feeds from accounts in your application to supported accounting software. - - A bank feed is a connection between a source bank account in your application and a target bank account in a supported accounting software. - - [Explore solution](https://docs.codat.io/bank-feeds-api/overview) | [See OpenAPI spec](https://github.com/codatio/oas) - - --- - - ## Endpoints - - | Endpoints | Description | - | :- |:- | - | Companies | Create and manage your SMB users' companies. | - | Connections | Create new and manage existing data connections for a company. | - | Source accounts | Provide and manage lists of source bank accounts. | - | Account mapping | Extra functionality for building an account management UI. | - | Company information | Get detailed information about a company from the underlying platform. | - | Transactions | Create new bank account transactions for a company's connections, and see previous operations. | - + email: support@codat.io termsOfService: 'https://www.codat.io/legals/' security: - auth_header: [] @@ -68,7 +49,7 @@ x-speakeasy-name-override: methodNameOverride: download-attachment - operationId: ^upload-.*?-attachment methodNameOverride: upload-attachment -x-codat-docs-path: bank-feeds-api +x-codat-docs-path: sync-for-payables-api x-codat-keep-docs-paths-local: true x-codat-speakeasy-pagination: type: offsetLimit @@ -83,103 +64,18 @@ tags: description: Create and manage your SMB users' companies. - name: Connections description: Create new and manage existing data connections for a company. - - name: Bank accounts - description: Access bank accounts in an SMBs accounting software. - - name: Source accounts - description: Provide and manage lists of source bank accounts. - - name: Account mapping - description: Extra functionality for building an account management UI. - - name: Transactions - description: 'Create new bank account transactions for a company''s connections, and see previous operations.' - name: Company information - description: Get detailed information about a company from the underlying accounting software. - - name: Managed bank feeds - description: Manage bank feed syncs for source accounts. + 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: Bank accounts + description: Create a bank account for a given company's connection. paths: /companies: - post: - summary: Create company - tags: - - Companies - operationId: create-company - responses: - '200': - description: OK - content: - application/json: - x-speakeasy-usage-example: true - schema: - $ref: '#/components/schemas/Company' - examples: - With no description: - value: - id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 - name: Technicalium - description: '' - platform: '' - redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' - dataConnections: [] - created: '2022-11-10T10:45:18.1950523Z' - createdByUserName: Dan Tzabar - products: - - spend-insights - referenceSubsidiaryCompanies: [] - With a description: - value: - id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 - name: Technicalium - description: 'Technology services, including web and app design and development' - platform: '' - redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' - dataConnections: [] - created: '2022-11-10T10:45:18.1950523Z' - createdByUserName: Dan Tzabar - products: - - spend-insights - referenceSubsidiaryCompanies: [] - With a tag: - value: - id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 - name: Technicalium - description: '' - platform: '' - redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' - dataConnections: [] - created: '2022-11-10T10:45:18.1950523Z' - createdByUserName: Dan Tzabar - products: - - spend-insights - tags: - region: us - referenceSubsidiaryCompanies: [] - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - description: "\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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: - schema: - $ref: '#/components/schemas/CompanyRequestBody' - examples: - With no description: - value: - name: Technicalium - With a description: - value: - name: Technicalium - description: 'Technology services, including web and app design and development' get: summary: List companies tags: @@ -347,7 +243,7 @@ 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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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" + 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' @@ -359,136 +255,93 @@ paths: 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).' - '/companies/{companyId}': - 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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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' + post: + summary: Create company tags: - Companies + operationId: create-company responses: '200': description: OK content: application/json: + x-speakeasy-usage-example: true schema: $ref: '#/components/schemas/Company' examples: - Simple company: + With no description: value: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 - name: Toft stores holdings + name: Technicalium description: '' platform: '' redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' dataConnections: [] - created: '2022-11-10T10:45:18Z' + created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar products: - spend-insights - - lending - - expenses-v1 - - commerce referenceSubsidiaryCompanies: [] - Parent multi-entity company: + With a description: value: id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 - name: Toft stores - description: '' + name: Technicalium + description: 'Technology services, including web and app design and development' platform: '' redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' dataConnections: [] - created: '2022-11-10T10:45:18Z' + created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar products: - spend-insights - - lending - - expenses-v1 - - commerce - referenceSubsidiaryCompanies: - - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d - name: Toft stores UK - links: - portal: 'https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary' - - id: db94eddc-9212-4568-9b5c-3eab0e325913 - name: Toft stores US - links: - portal: 'https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary' - Subsidiary multi-entity company: + referenceSubsidiaryCompanies: [] + With a tag: value: - id: c8d3af58-7011-47ce-b3f2-89faf300ef6d - name: Toft stores UK + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Technicalium description: '' platform: '' - redirect: 'https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d' - dataConnections: - - id: d5ab61b7-1ad0-46fd-9f9f-b6761047941e - integrationId: cc750323-5a47-4f28-8d8e-30fbbf2ce137 - integrationKey: akxx - sourceId: 9815b998-024d-4415-a40b-89903b2cad6f - platformName: Oracle NetSuite - linkUrl: 'https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start' - status: Linked - lastSync: '2022-01-01T12:30:00.000Z' - created: '2022-01-01T11:30:00Z' - sourceType: Accounting - created: '2022-11-10T10:45:18Z' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18.1950523Z' createdByUserName: Dan Tzabar products: - spend-insights - - lending - - expenses-v1 - - commerce - referenceParentCompany: - id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 - name: Toft stores - links: - portal: 'https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary' + tags: + region: us referenceSubsidiaryCompanies: [] + '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' - 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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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: - '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: "\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: + schema: + $ref: '#/components/schemas/CompanyRequestBody' + examples: + With no description: + value: + name: Technicalium + With a description: + value: + name: Technicalium + description: 'Technology services, including web and app design and development' + '/companies/{companyId}': put: summary: 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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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\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: @@ -531,7 +384,7 @@ paths: 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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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" + 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' @@ -571,29 +424,17 @@ paths: Update name: value: name: New Name - '/companies/{companyId}/accessToken': - get: - summary: Get company access token - operationId: get-company-access-token - x-speakeasy-name-override: get-access-token - description: "Use the _Get company access token_ endpoint to return an access token for the specified company ID. The token is valid for one day. \n\nThe token is required by Codat's embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to verify the identity of the user and improve the reliability of data provided by them." + 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\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: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyAccessToken' - examples: - Simple company: - value: - expiresIn: 86400 - accessToken: string - tokenType: Bearer + '204': + description: No Content '401': $ref: '#/components/responses/Unauthorized' '402': @@ -608,49 +449,150 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections': get: - summary: List connections - description: "\uFEFF\x4C\x69\x73\x74\x20\x74\x68\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x66\x6F\x72\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E" - operationId: list-connections - tags: - - Connections + 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\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' - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' - - $ref: '#/components/parameters/query' - - $ref: '#/components/parameters/orderBy' + tags: + - Companies responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/Connections' + $ref: '#/components/schemas/Company' examples: - Connections: + Simple company: value: - results: - - id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd - integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c - integrationKey: dfxm - sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee - platformName: Basiq - linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Linked - lastSync: '2022-10-27T10:22:43.6464237Z' - created: '2022-10-27T09:53:29Z' - sourceType: Banking - pageNumber: 0 - pageSize: 0 - totalResults: 0 - _links: - self: - href: string - current: - href: string - next: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores holdings + description: '' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + dataConnections: [] + created: '2022-11-10T10:45:18Z' + createdByUserName: Dan Tzabar + products: + - spend-insights + - lending + - expenses-v1 + - commerce + referenceSubsidiaryCompanies: [] + Parent multi-entity company: + value: + id: ab12c58d-a678-4ebf-a159-ae99e1807bd0 + name: Toft stores + description: '' + platform: '' + redirect: 'https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0' + 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 + links: + portal: 'https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary' + - id: db94eddc-9212-4568-9b5c-3eab0e325913 + name: Toft stores US + links: + portal: 'https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary' + Subsidiary multi-entity company: + value: + id: c8d3af58-7011-47ce-b3f2-89faf300ef6d + name: Toft stores UK + description: '' + platform: '' + redirect: 'https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d' + dataConnections: + - id: d5ab61b7-1ad0-46fd-9f9f-b6761047941e + integrationId: cc750323-5a47-4f28-8d8e-30fbbf2ce137 + integrationKey: akxx + sourceId: 9815b998-024d-4415-a40b-89903b2cad6f + platformName: Oracle NetSuite + linkUrl: 'https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start' + status: Linked + lastSync: '2022-01-01T12:30:00.000Z' + created: '2022-01-01T11:30:00Z' + 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 + links: + portal: 'https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary' + referenceSubsidiaryCompanies: [] + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections': + get: + summary: List connections + description: "\uFEFF\x4C\x69\x73\x74\x20\x74\x68\x65\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x73\x20\x66\x6F\x72\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E" + operationId: list-connections + tags: + - Connections + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Connections' + examples: + Connections: + value: + results: + - id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd + integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c + integrationKey: dfxm + sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee + platformName: Basiq + linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' + status: Linked + lastSync: '2022-10-27T10:22:43.6464237Z' + created: '2022-10-27T09:53:29Z' + sourceType: Banking + pageNumber: 0 + pageSize: 0 + totalResults: 0 + _links: + self: + href: string + current: + href: string + next: href: string previous: href: string @@ -844,441 +786,32 @@ paths: value: status: Unlinked description: '' - '/companies/{companyId}/connections/{connectionId}/data/bankAccounts': + '/companies/{companyId}/connections/{connectionId}/payables/info': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' get: - x-internal: true + 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: - - Bank accounts - summary: List bank accounts - operationId: list-bank-accounts - parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' - - $ref: '#/components/parameters/query' - - $ref: '#/components/parameters/orderBy' + - Company information responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/BankAccounts' + $ref: '#/components/schemas/CompanyInformation' examples: - Dynamics 365 Business Central: - value: - results: - - id: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b - accountName: '55' - accountType: Unknown - nominalCode: '10500' - sortCode: '' - accountNumber: '' - iBan: '' - currency: GBP - balance: -352.03 - modifiedDate: '2023-03-27T14:21:10Z' - sourceModifiedDate: '2023-02-07T00:00:00' - overdraftLimit: 0 - metadata: - isDeleted: false - - id: 47020f80-60e6-ec11-82f8-0022481a77f0 - accountName: '555' - accountType: Unknown - nominalCode: '40300' - sortCode: '' - accountNumber: '' - iBan: '' - currency: PLN - balance: 661.79 - modifiedDate: '2023-03-27T14:21:10Z' - sourceModifiedDate: '2022-06-07T00:00:00' - overdraftLimit: 0 - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 28 - _links: - current: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts - next: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=2&pageSize=2 - FreeAgent: - value: - results: - - id: '738783' - accountName: \w3fw - accountType: Debit - sortCode: '236972' - accountNumber: A06268209 - currency: GBP - balance: -10484.65 - availableBalance: -10484.65 - modifiedDate: '2023-04-25T14:19:12Z' - metadata: - isDeleted: false - - id: '738778' - accountName: 2e2bna45hy\ - accountType: Debit - sortCode: '236972' - accountNumber: D01825250 - currency: GBP - balance: -114.4 - availableBalance: -114.4 - modifiedDate: '2023-04-25T14:19:12Z' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 82 - _links: - current: - href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts - next: - href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=2&pageSize=2 - KashFlow: - value: - results: - - id: '765768' - accountName: 16th Account - accountType: Unknown - nominalCode: '70700' - currency: GBP - balance: 326 - availableBalance: 326 - modifiedDate: '2022-09-30T10:29:16Z' - - id: '765766' - accountName: 1a1a - accountType: Unknown - nominalCode: '70600' - currency: GBP - balance: 0 - availableBalance: 0 - modifiedDate: '2022-09-30T10:29:16Z' - pageNumber: 1 - pageSize: 2 - totalResults: 56 - _links: - current: - href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts - next: - href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=2&pageSize=2 - Oracle NetSuite: - value: - results: - - id: '825' - accountName: Codat Europe Bank - accountType: Debit - nominalCode: '111111122222111' - currency: GBP - balance: 558.22 - modifiedDate: '2023-05-02T13:24:36Z' - sourceModifiedDate: '2022-07-15T11:34:02' - metadata: - isDeleted: false - - id: '826' - accountName: Codat Europe Bank USD - accountType: Debit - nominalCode: '1133221133' - currency: USD - modifiedDate: '2023-05-02T13:24:36Z' - sourceModifiedDate: '2021-03-26T10:31:40' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 4 - _links: - current: - href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts - next: - href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=2&pageSize=2 - QuickBooks Desktop: - value: - results: - - id: 20000-933270541 - accountName: Checking - accountType: Unknown - nominalCode: '10100' - currency: GBP - balance: 46954.1 - availableBalance: 46954.1 - modifiedDate: '2023-04-26T09:12:37Z' - sourceModifiedDate: '2023-12-16T05:06:45' - metadata: - isDeleted: false - - id: 550001-1071509830 - accountName: Petty Cash - accountType: Unknown - nominalCode: '10400' - currency: GBP - balance: 500 - availableBalance: 500 - modifiedDate: '2023-04-26T09:12:37Z' - sourceModifiedDate: '2023-12-16T05:06:45' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 3 - _links: - current: - href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts - next: - href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=2&pageSize=2 - QuickBooks Online Sandbox: - value: - results: - - id: '164' - accountName: '00' - accountType: Debit - nominalCode: '123567' - currency: GBP - balance: 0 - availableBalance: 0 - modifiedDate: '2023-04-26T09:35:57Z' - sourceModifiedDate: '2022-07-20T14:11:28Z' - metadata: - isDeleted: false - - id: '163' - accountName: '11' - accountType: Debit - currency: GBP - balance: 0 - availableBalance: 0 - modifiedDate: '2023-04-26T09:35:57Z' - sourceModifiedDate: '2022-07-20T14:11:28Z' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 57 - _links: - current: - href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts - next: - href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=2&pageSize=2 - QuickBooks Online: - value: - results: - - id: '202' - accountName: \aa - accountType: Debit - currency: GBP - balance: 123 - availableBalance: 123 - modifiedDate: '2023-01-18T11:02:37Z' - sourceModifiedDate: '2022-11-11T14:15:13Z' - - id: '193' - accountName: 1 year ago - accountType: Debit - currency: GBP - balance: 5300.02 - availableBalance: 5300.02 - modifiedDate: '2023-01-18T11:02:37Z' - sourceModifiedDate: '2023-01-18T06:05:12Z' - pageNumber: 1 - pageSize: 2 - totalResults: 140 - _links: - current: - href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts - next: - href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=2&pageSize=2 - Sage 50 (UK): - value: - results: - - id: '1200' - accountName: Bank Current Account - accountType: Unknown - nominalCode: '1200' - sortCode: 23-34-34 - accountNumber: '003234234' - iBan: '' - currency: GBP - balance: -20091.04 - availableBalance: -20091.04 - modifiedDate: '2023-03-30T14:42:37Z' - sourceModifiedDate: '2022-11-25T09:25:48' - overdraftLimit: 120000 - institution: Lloyds Bank PLC - metadata: - isDeleted: false - - id: '1210' - accountName: Bank Deposit Account - accountType: Unknown - nominalCode: '1210' - sortCode: 45-45-45 - accountNumber: 9/00474345 - iBan: '' - currency: GBP - balance: 3510 - availableBalance: 3510 - modifiedDate: '2023-03-30T14:42:37Z' - sourceModifiedDate: '2022-11-25T09:25:48' - overdraftLimit: 0 - institution: Halifax Building Society - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 6 - _links: - current: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts - next: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=2&pageSize=2 - Sage Business Cloud Accounting: - value: - results: - - id: 154d05abe9f24c4babe0f6a741dec1b9 - accountName: Abdi Internet Bank - accountType: Unknown - nominalCode: '1560' - sortCode: '010101' - accountNumber: '11111' - currency: GBP - balance: 49.61 - availableBalance: 49.61 - modifiedDate: '2022-10-24T14:52:53Z' - sourceModifiedDate: '2020-01-27T10:53:26Z' - - id: 565ce07212bc492c8c2d04f43f9f67e3 - accountName: Abdi Live Test - accountType: Unknown - nominalCode: '147852' - sortCode: '123456' - accountNumber: '1234567' - currency: GBP - balance: -225830.75 - availableBalance: -225830.75 - modifiedDate: '2022-10-24T14:52:53Z' - sourceModifiedDate: '2020-01-28T14:00:20Z' - pageNumber: 1 - pageSize: 2 - totalResults: 45 - _links: - current: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts - next: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=2&pageSize=2 - Sage Intacct: - value: - results: - - id: 'CREDITCARD:55' - accountName: CoT Credit Card - accountType: Credit - nominalCode: '10021' - currency: GBP - modifiedDate: '2023-04-04T16:31:46Z' - sourceModifiedDate: '2023-03-27T14:11:48' - metadata: - isDeleted: false - - id: 'CREDITCARD:58' - accountName: Cot Credit Card 2 - accountType: Credit - nominalCode: '11112' - currency: GBP - modifiedDate: '2023-04-04T16:31:46Z' - sourceModifiedDate: '2023-03-27T14:15:11' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 14 - _links: - current: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts - next: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=2&pageSize=2 - Xero: - value: - results: - - id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 - accountName: Business Bank Account - accountType: Debit - sortCode: '990404' - accountNumber: '987654321' - currency: GBP - balance: 6681.79 - modifiedDate: '2023-03-15T20:36:09Z' - sourceModifiedDate: '2023-03-15T20:35:07' - metadata: - isDeleted: false - - id: a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba - accountName: Business Savings Account - accountType: Debit - sortCode: '890303' - accountNumber: '876543210' - currency: GBP - balance: 0 - modifiedDate: '2023-03-15T20:36:09Z' - sourceModifiedDate: '2023-03-15T20:36:06' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 2 - _links: - current: - href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts - Zoho Books: + Company information: value: - results: - - id: '104957000000060010' - accountName: Abdi Test - accountType: Unknown - sortCode: '112233' - accountNumber: xxxx5678 - currency: GBP - balance: 69858.44 - modifiedDate: '2022-10-03T08:40:38Z' - institution: Test Bank - - id: '104957000000065002' - accountName: Abdi Test 2 - accountType: Unknown - sortCode: '' - accountNumber: '' - currency: AED - balance: 98.03 - modifiedDate: '2022-10-03T08:40:38Z' - institution: '' - pageNumber: 1 - pageSize: 2 - totalResults: 4 - _links: - current: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts - next: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=2&pageSize=2 + companyName: Bank of Dave + baseCurrency: GBP '400': - $ref: '#/components/responses/Malformed-Query' + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1287,859 +820,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' - description: "The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankAccount) for a given company's connection.\n\n[Bank accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/bank-feeds-api#/operations/refresh-company-data).\n " - '/companies/{companyId}/connections/{connectionId}/options/bankAccounts': + '/companies/{companyId}/connections/{connectionId}/payables/mappingOptions/bills': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' get: - summary: Get create/update bank account model - x-internal: true + 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: - - Bank accounts + - Bills + parameters: + - $ref: '#/components/parameters/continuationToken' + - $ref: '#/components/parameters/statusQuery' responses: '200': - description: OK + description: Success content: application/json: schema: - $ref: '#/components/schemas/PushOption' + $ref: '#/components/schemas/BillMappingOptions' 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): + Mapping options: 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 + 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': @@ -2154,33 +884,42 @@ paths: $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/bank-feeds-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/bank-feeds-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}/connections/{connectionId}/push/bankAccounts': + '/companies/{companyId}/connections/{connectionId}/payables/mappingOptions/payments': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' - post: - x-internal: true + 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: - - Bank accounts - summary: Create bank account + - Bill payments parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BankAccounts/allOf/0/properties/results/items/definitions/bankAccountPrototype' - examples: {} + - $ref: '#/components/parameters/continuationToken' + - $ref: '#/components/parameters/statusQuery' responses: '200': description: Success content: application/json: schema: - $ref: '#/components/schemas/BankAccounts/allOf/0/properties/results/items/definitions/bankAccountCreateResponse' - 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': @@ -2197,58 +936,101 @@ 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/bank-feeds-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/bank-feeds-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/bank-feeds-api#/operations/get-create-update-bankAccounts-model)." - operationId: create-bank-account - '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/batch': + '/companies/{companyId}/connections/{connectionId}/payables/bills': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' - post: - tags: - - Source accounts - summary: Create source accounts + get: + summary: List bills description: |- - The _Batch create source accounts_ endpoint allows you to create multiple representations of your SMB's bank accounts within Codat's domain. The company can then map the source account to an existing or new target account in their accounting software. + 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. - > ### Versioning - > If you are integrating the Bank Feeds solution with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below. - operationId: create-batch-source-account - x-speakeasy-name-override: create-batch - requestBody: - content: - application/json: - schema: - oneOf: - - type: array - items: - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccountV2Prototype' - - type: array - items: - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccountPrototype' + [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: + - Bills + parameters: + - $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: - '201': + '200': description: Success content: application/json: schema: - type: array - items: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2BatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchCreateResponse' - '207': - description: Multi-Status - content: - application/json: - schema: - type: array - items: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2BatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchErrorResponse' + $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': @@ -2258,81 +1040,128 @@ paths: '404': $ref: '#/components/responses/Not-Found' '409': - description: Conflict - content: - application/json: - schema: - type: array - items: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2BatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchErrorResponse' + $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' post: - tags: - - Source accounts - summary: Create single source account + summary: Create bill description: |- - The _Create Source Account_ endpoint allows you to create a representation of a bank account within Codat's domain. The company can then map the source account to an existing or new target account in their accounting software. + The *Create bill* endpoint creates a new [bill](https://docs.codat.io/sync-for-payables-api#/schemas/Bill) for a given company's connection. - > ### Versioning - > If you are integrating the Bank Feeds solution with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below. - operationId: create-source-account + [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: + - Bills + 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: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccountV2Prototype' - - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccountPrototype' + $ref: '#/components/schemas/Bill/definitions/billPrototype' examples: - Version 2: - value: - id: acc-001 - accountName: account-081 - accountType: checking - accountNumber: '12345670' - routingInfo: - bankCode: 021001088 - type: bankcode - currency: GBP - balance: 99.99 - accountInfo: - description: account description 1 - nickname: account 123 - accountOpenDate: '2023-05-06' - availableBalance: 10 - modifiedDate: '2024-08-02T00:00:00.000Z' - Version 1: + Create bill: value: - id: acc-002 - accountName: account-081 - sortCode: '123456' - accountType: Credit - accountNumber: '12345670' + 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 - balance: 99.99 - modifiedDate: '2023-01-09T14:14:14.1057478Z' + 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: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2' - - $ref: '#/components/schemas/SourceAccount' - 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': @@ -2343,28 +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' - get: + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $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: - - Source accounts - summary: List source accounts - description: "\uFEFF\x54\x68\x65\x20\x5F\x4C\x69\x73\x74\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x5F\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\x73\x6F\x75\x72\x63\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x42\x61\x6E\x6B\x46\x65\x65\x64\x41\x63\x63\x6F\x75\x6E\x74\x29\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\x2E\n\n\x5B\x53\x6F\x75\x72\x63\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x42\x61\x6E\x6B\x46\x65\x65\x64\x41\x63\x63\x6F\x75\x6E\x74\x29\x20\x61\x72\x65\x20\x74\x68\x65\x20\x62\x61\x6E\x6B\x27\x73\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x77\x69\x74\x68\x69\x6E\x20\x43\x6F\x64\x61\x74\x27\x73\x20\x64\x6F\x6D\x61\x69\x6E\x20\x66\x72\x6F\x6D\x20\x77\x68\x69\x63\x68\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x20\x61\x72\x65\x20\x73\x79\x6E\x63\x65\x64\x20\x69\x6E\x74\x6F\x20\x74\x68\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x70\x6C\x61\x74\x66\x6F\x72\x6D\x2E\n\n\x3E\x20\x23\x23\x23\x20\x56\x65\x72\x73\x69\x6F\x6E\x69\x6E\x67\n\x3E\x20\x49\x66\x20\x79\x6F\x75\x20\x61\x72\x65\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6E\x67\x20\x74\x68\x65\x20\x42\x61\x6E\x6B\x20\x46\x65\x65\x64\x73\x20\x73\x6F\x6C\x75\x74\x69\x6F\x6E\x20\x77\x69\x74\x68\x20\x43\x6F\x64\x61\x74\x20\x61\x66\x74\x65\x72\x20\x41\x75\x67\x75\x73\x74\x20\x31\x2C\x20\x32\x30\x32\x34\x2C\x20\x70\x6C\x65\x61\x73\x65\x20\x75\x73\x65\x20\x74\x68\x65\x20\x76\x32\x20\x76\x65\x72\x73\x69\x6F\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x41\x50\x49\x2C\x20\x61\x73\x20\x64\x65\x74\x61\x69\x6C\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x73\x63\x68\x65\x6D\x61\x20\x62\x65\x6C\x6F\x77\x2E\x20\x46\x6F\x72\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x73\x20\x63\x6F\x6D\x70\x6C\x65\x74\x65\x64\x20\x62\x65\x66\x6F\x72\x65\x20\x41\x75\x67\x75\x73\x74\x20\x31\x2C\x20\x32\x30\x32\x34\x2C\x20\x73\x65\x6C\x65\x63\x74\x20\x74\x68\x65\x20\x76\x31\x20\x76\x65\x72\x73\x69\x6F\x6E\x20\x66\x72\x6F\x6D\x20\x74\x68\x65\x20\x73\x63\x68\x65\x6D\x61\x20\x64\x72\x6F\x70\x64\x6F\x77\x6E\x20\x62\x65\x6C\x6F\x77\x2E" - operationId: list-source-accounts + - Bills + 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/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: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccounts' - - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccounts' - 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': @@ -2373,38 +1302,47 @@ 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' - '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/{accountId}': - patch: + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $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: - - Source accounts - summary: Update source account - description: "\uFEFF\x54\x68\x65\x20\x5F\x55\x70\x64\x61\x74\x65\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x5F\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x75\x70\x64\x61\x74\x65\x73\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x66\x6F\x72\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x63\x6F\x6E\x6E\x65\x63\x74\x65\x64\x20\x74\x6F\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\n\n\x23\x23\x23\x20\x54\x69\x70\x73\x20\x61\x6E\x64\x20\x70\x69\x74\x66\x61\x6C\x6C\x73\n\n\x2A\x20\x54\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x6D\x61\x6B\x65\x73\x20\x69\x74\x20\x70\x6F\x73\x73\x69\x62\x6C\x65\x20\x74\x6F\x20\x75\x70\x64\x61\x74\x65\x20\x74\x68\x65\x20\x60\x61\x63\x63\x6F\x75\x6E\x74\x4E\x61\x6D\x65\x60\x2C\x20\x60\x73\x74\x61\x74\x75\x73\x60\x2C\x20\x61\x6E\x64\x20\x60\x62\x61\x6C\x61\x6E\x63\x65\x60\x20\x66\x69\x65\x6C\x64\x73\x2E\n\x20\x20\x20\x20\x2A\x20\x54\x68\x65\x20\x60\x73\x74\x61\x74\x75\x73\x60\x20\x66\x69\x65\x6C\x64\x20\x63\x61\x6E\x20\x6F\x6E\x6C\x79\x20\x62\x65\x20\x75\x70\x64\x61\x74\x65\x64\x20\x74\x6F\x20\x27\x64\x69\x73\x63\x6F\x6E\x6E\x65\x63\x74\x65\x64\x27\x2E\n\x20\x20\x20\x20\x2A\x20\x54\x68\x65\x20\x60\x62\x61\x6C\x61\x6E\x63\x65\x60\x20\x66\x69\x65\x6C\x64\x20\x63\x61\x6E\x20\x6F\x6E\x6C\x79\x20\x62\x65\x20\x75\x70\x64\x61\x74\x65\x64\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x74\x68\x61\x74\x20\x61\x72\x65\x20\x2A\x2A\x6E\x6F\x74\x2A\x2A\x20\x27\x63\x6F\x6E\x6E\x65\x63\x74\x65\x64\x27\x2E\n\x2A\x20\x55\x70\x64\x61\x74\x65\x73\x20\x6D\x61\x64\x65\x20\x68\x65\x72\x65\x20\x61\x70\x70\x6C\x79\x20\x65\x78\x63\x6C\x75\x73\x69\x76\x65\x6C\x79\x20\x74\x6F\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x77\x69\x6C\x6C\x20\x6E\x6F\x74\x20\x61\x66\x66\x65\x63\x74\x20\x74\x61\x72\x67\x65\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x69\x6E\x20\x74\x68\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x2E" - operationId: update-source-account - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/accountId' + - Bills requestBody: content: - application/json: + multipart/form-data: schema: - $ref: '#/components/schemas/SourceAccount' - examples: {} + $ref: '#/components/schemas/AttachmentUpload' responses: - '200': - description: Success + '201': + description: Created content: application/json: - x-speakeasy-usage-example: true schema: - $ref: '#/components/schemas/SourceAccount' - 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': @@ -2421,22 +1359,36 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - delete: + 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: - - Source accounts - summary: Delete source account - description: | - The _Delete source account_ endpoint enables you to remove a source account. - - Removing a source account will also remove any mapping between the source bank feed bank accounts and the target bankfeed bank account. - operationId: delete-source-account - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/accountId' + - Bills responses: - '204': - description: No Content + '200': + description: Success + content: + application/json: + schema: + $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': @@ -2445,33 +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' - '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/credentials': - post: + '/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: - - Source accounts - summary: Generate source account credentials - description: "\uFEFF\x54\x68\x65\x20\x5F\x47\x65\x6E\x65\x72\x61\x74\x65\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x63\x72\x65\x64\x65\x6E\x74\x69\x61\x6C\x73\x5F\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x63\x61\x6E\x20\x62\x65\x20\x75\x73\x65\x64\x20\x74\x6F\x20\x67\x65\x6E\x65\x72\x61\x74\x65\x20\x63\x72\x65\x64\x65\x6E\x74\x69\x61\x6C\x73\x20\x66\x6F\x72\x20\x51\x75\x69\x63\x6B\x42\x6F\x6F\x6B\x73\x20\x4F\x6E\x6C\x69\x6E\x65\x20\x74\x6F\x20\x61\x75\x74\x68\x65\x6E\x74\x69\x63\x61\x74\x65\x20\x74\x68\x65\x20\x42\x61\x6E\x6B\x20\x46\x65\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x51\x42\x4F\x20\x70\x6F\x72\x74\x61\x6C\x2E\x20\x45\x61\x63\x68\x20\x74\x69\x6D\x65\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x69\x73\x20\x63\x61\x6C\x6C\x65\x64\x2C\x20\x61\x20\x6E\x65\x77\x20\x73\x65\x74\x20\x6F\x66\x20\x63\x72\x65\x64\x65\x6E\x74\x69\x61\x6C\x73\x20\x77\x69\x6C\x6C\x20\x62\x65\x20\x67\x65\x6E\x65\x72\x61\x74\x65\x64\x2E\n\n\x54\x68\x65\x20\x6F\x6C\x64\x20\x63\x72\x65\x64\x65\x6E\x74\x69\x61\x6C\x73\x20\x77\x69\x6C\x6C\x20\x73\x74\x69\x6C\x6C\x20\x62\x65\x20\x76\x61\x6C\x69\x64\x20\x75\x6E\x74\x69\x6C\x20\x74\x68\x65\x20\x72\x65\x76\x6F\x6B\x65\x20\x63\x72\x65\x64\x65\x6E\x74\x69\x61\x6C\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x69\x73\x20\x75\x73\x65\x64\x2C\x20\x77\x68\x69\x63\x68\x20\x77\x69\x6C\x6C\x20\x72\x65\x76\x6F\x6B\x65\x20\x61\x6C\x6C\x20\x63\x72\x65\x64\x65\x6E\x74\x69\x61\x6C\x73\x20\x61\x73\x73\x6F\x63\x69\x61\x74\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x20\x64\x61\x74\x61\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x2E\n\n\x3E\x20\x2A\x2A\x46\x6F\x72\x20\x51\x75\x69\x63\x6B\x42\x6F\x6F\x6B\x73\x20\x4F\x6E\x6C\x69\x6E\x65\x20\x6F\x6E\x6C\x79\x2A\x2A\n\x3E\n\x3E\x20\x4F\x6E\x6C\x79\x20\x63\x61\x6C\x6C\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x77\x68\x65\x6E\x20\x6F\x6E\x62\x6F\x61\x72\x64\x69\x6E\x67\x20\x53\x4D\x42\x73\x20\x74\x68\x61\x74\x20\x75\x73\x65\x20\x20\x51\x75\x69\x63\x6B\x42\x6F\x6F\x6B\x73\x20\x4F\x6E\x6C\x69\x6E\x65\x2E" - operationId: generate-credentials - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - requestBody: - required: true - content: - application/json: {} + - Bills responses: '200': description: Success content: - application/json: + application/octet-stream: schema: - $ref: '#/components/schemas/BankAccountCredentials' + title: Data + type: string + format: binary '401': $ref: '#/components/responses/Unauthorized' '402': @@ -2486,22 +1445,58 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - delete: - tags: - - Source accounts - summary: Delete all source account credentials - x-speakeasy-name-override: delete-credentials + '/companies/{companyId}/connections/{connectionId}/payables/bills/{billId}/payment': + parameters: + - $ref: '#/components/parameters/companyId' + - $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 _Delete Bank Account Credentials_ endpoint serves as a comprehensive mechanism for revoking all existing authorization credentials that a company employs to establish its Bank Feed connection. + 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. - In cases where multiple credential sets have been generated, a single API call to this endpoint revokes all of them. - operationId: delete-bank-feed-credentials - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' + [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: - '204': - description: No Content + '201': + description: Created + content: + application/json: + schema: + $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': @@ -2510,51 +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' - '/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/mapping': + '/companies/{companyId}/connections/{connectionId}/payables/suppliers': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' get: tags: - - Account mapping - summary: List bank feed accounts - description: "\uFEFF\x54\x68\x65\x20\x2A\x4C\x69\x73\x74\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x69\x6E\x66\x6F\x72\x6D\x61\x74\x69\x6F\x6E\x20\x61\x62\x6F\x75\x74\x20\x61\x20\x73\x6F\x75\x72\x63\x65\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x61\x6E\x64\x20\x61\x6E\x79\x20\x63\x75\x72\x72\x65\x6E\x74\x20\x6F\x72\x20\x70\x6F\x74\x65\x6E\x74\x69\x61\x6C\x20\x74\x61\x72\x67\x65\x74\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2E\n\n\x41\x20\x62\x61\x6E\x6B\x20\x66\x65\x65\x64\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x69\x73\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\x20\x6C\x69\x6E\x6B\x20\x62\x65\x74\x77\x65\x65\x6E\x20\x74\x68\x65\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x28\x70\x72\x6F\x76\x69\x64\x65\x64\x20\x62\x79\x20\x74\x68\x65\x20\x43\x6F\x64\x61\x74\x20\x75\x73\x65\x72\x29\x20\x61\x6E\x64\x20\x74\x68\x65\x20\x74\x61\x72\x67\x65\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x28\x74\x68\x65\x20\x65\x6E\x64\x20\x75\x73\x65\x72\x27\x73\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x20\x74\x68\x65\x20\x75\x6E\x64\x65\x72\x6C\x79\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x29\x2E\n\n\x3E\x20\x2A\x2A\x46\x6F\x72\x20\x63\x75\x73\x74\x6F\x6D\x20\x62\x75\x69\x6C\x64\x73\x20\x6F\x6E\x6C\x79\x2A\x2A\n\x3E\x20\n\x3E\x20\x4F\x6E\x6C\x79\x20\x75\x73\x65\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x69\x66\x20\x79\x6F\x75\x20\x61\x72\x65\x20\x62\x75\x69\x6C\x64\x69\x6E\x67\x20\x79\x6F\x75\x72\x20\x6F\x77\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x6E\x61\x67\x65\x6D\x65\x6E\x74\x20\x55\x49\x2E" - operationId: get-bank-account-mapping + - 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`.\n\n### Supported Integrations\n\n| Integration | Supported |\n|-------------------------------|-----------|\n| FreeAgent | Yes |\n| QuickBooks Online | Yes |\n| Xero | Yes |\n| Oracle NetSuite | Yes |\n| Sage Intacct | Yes |\n| Zoho Books | Yes |" + 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: Success content: application/json: schema: - $ref: '#/components/schemas/BankFeedMapping/definitions/bankFeedMappings' + $ref: '#/components/schemas/Supplier/definitions/suppliers' examples: - Example: + Suppliers: value: - - sourceAccountId: account-001 - status: pending - targetAccountOptions: - - name: Money Bank account - id: d21e25d6-98c5-4bfb-b469-105833bea3c8 - accountNumber: '789' - sortCode: '123456' - - name: Bank of Dave account - id: d06ff4b2-e4f2-4681-9841-014bd008cdab - accountNumber: '99887766' - sortCode: '998866' - - name: LuxLend account - id: c8f252fc-84f3-4a8b-ace8-ae99f41a81ae - accountNumber: '123456789' - sortCode: '123456' - sourceAccountName: account-001 - sourceAccountNumber: '12345670' - sourceBalance: 99.99 - sourceCurrency: GBP + 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/Malformed-Query' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -2563,6 +1593,8 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': @@ -2571,28 +1603,65 @@ paths: $ref: '#/components/responses/Service-Unavailable' post: tags: - - Account mapping - summary: Create bank feed account mapping - description: "\uFEFF\x54\x68\x65\x20\x2A\x43\x72\x65\x61\x74\x65\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x70\x70\x69\x6E\x67\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x63\x72\x65\x61\x74\x65\x73\x20\x61\x20\x6E\x65\x77\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x62\x65\x74\x77\x65\x65\x6E\x20\x61\x20\x73\x6F\x75\x72\x63\x65\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x61\x6E\x64\x20\x61\x20\x70\x6F\x74\x65\x6E\x74\x69\x61\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x20\x74\x68\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x20\x28\x74\x61\x72\x67\x65\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x29\x2E\n\n\x41\x20\x62\x61\x6E\x6B\x20\x66\x65\x65\x64\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x69\x73\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\x20\x6C\x69\x6E\x6B\x20\x62\x65\x74\x77\x65\x65\x6E\x20\x74\x68\x65\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x28\x70\x72\x6F\x76\x69\x64\x65\x64\x20\x62\x79\x20\x74\x68\x65\x20\x43\x6F\x64\x61\x74\x20\x75\x73\x65\x72\x29\x20\x61\x6E\x64\x20\x74\x68\x65\x20\x74\x61\x72\x67\x65\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x28\x74\x68\x65\x20\x65\x6E\x64\x20\x75\x73\x65\x72\x27\x73\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x20\x74\x68\x65\x20\x75\x6E\x64\x65\x72\x6C\x79\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x29\x2E\n\n\x54\x6F\x20\x66\x69\x6E\x64\x20\x76\x61\x6C\x69\x64\x20\x74\x61\x72\x67\x65\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6F\x70\x74\x69\x6F\x6E\x73\x2C\x20\x66\x69\x72\x73\x74\x20\x63\x61\x6C\x6C\x20\x74\x68\x65\x20\x5B\x4C\x69\x73\x74\x20\x62\x61\x6E\x6B\x20\x66\x65\x65\x64\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x70\x70\x69\x6E\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\x2F\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\x73\x2D\x61\x70\x69\x23\x2F\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x73\x2F\x67\x65\x74\x2D\x62\x61\x6E\x6B\x2D\x61\x63\x63\x6F\x75\x6E\x74\x2D\x6D\x61\x70\x70\x69\x6E\x67\x29\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x2E\n\n\x3E\x20\x2A\x2A\x46\x6F\x72\x20\x63\x75\x73\x74\x6F\x6D\x20\x62\x75\x69\x6C\x64\x73\x20\x6F\x6E\x6C\x79\x2A\x2A\n\x3E\n\x3E\x20\x4F\x6E\x6C\x79\x20\x75\x73\x65\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x69\x66\x20\x79\x6F\x75\x20\x61\x72\x65\x20\x62\x75\x69\x6C\x64\x69\x6E\x67\x20\x79\x6F\x75\x72\x20\x6F\x77\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x6E\x61\x67\x65\x6D\x65\x6E\x74\x20\x55\x49\x2E\n\n\x23\x23\x23\x23\x20\x41\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x76\x61\x72\x69\x61\x62\x69\x6C\x69\x74\x79\n\n\x54\x68\x65\x20\x6D\x65\x74\x68\x6F\x64\x20\x6F\x66\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x74\x68\x65\x20\x73\x6F\x75\x72\x63\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x74\x6F\x20\x74\x68\x65\x20\x74\x61\x72\x67\x65\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x76\x61\x72\x69\x65\x73\x20\x64\x65\x70\x65\x6E\x64\x69\x6E\x67\x20\x6F\x6E\x20\x74\x68\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x20\x79\x6F\x75\x72\x20\x63\x6F\x6D\x70\x61\x6E\x79\x20\x75\x73\x65\x73\x2E\n\n\x23\x23\x23\x23\x20\x4D\x61\x70\x70\x69\x6E\x67\x20\x6F\x70\x74\x69\x6F\x6E\x73\x3A\n\n\x31\x2E\x20\x2A\x2A\x41\x50\x49\x20\x4D\x61\x70\x70\x69\x6E\x67\x2A\x2A\x3A\x20\x49\x6E\x74\x65\x67\x72\x61\x74\x65\x20\x74\x68\x65\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x6A\x6F\x75\x72\x6E\x65\x79\x20\x64\x69\x72\x65\x63\x74\x6C\x79\x20\x69\x6E\x74\x6F\x20\x79\x6F\x75\x72\x20\x61\x70\x70\x6C\x69\x63\x61\x74\x69\x6F\x6E\x20\x66\x6F\x72\x20\x61\x20\x73\x65\x61\x6D\x6C\x65\x73\x73\x20\x75\x73\x65\x72\x20\x65\x78\x70\x65\x72\x69\x65\x6E\x63\x65\x2E\n\x32\x2E\x20\x2A\x2A\x43\x6F\x64\x61\x74\x20\x55\x49\x20\x4D\x61\x70\x70\x69\x6E\x67\x2A\x2A\x3A\x20\x49\x66\x20\x79\x6F\x75\x20\x70\x72\x65\x66\x65\x72\x20\x61\x20\x71\x75\x69\x63\x6B\x65\x72\x20\x73\x65\x74\x75\x70\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x75\x74\x69\x6C\x69\x7A\x65\x20\x43\x6F\x64\x61\x74\x27\x73\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x20\x75\x73\x65\x72\x20\x69\x6E\x74\x65\x72\x66\x61\x63\x65\x20\x66\x6F\x72\x20\x6D\x61\x70\x70\x69\x6E\x67\x2E\n\x33\x2E\x20\x2A\x2A\x41\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x50\x6C\x61\x74\x66\x6F\x72\x6D\x20\x4D\x61\x70\x70\x69\x6E\x67\x2A\x2A\x3A\x20\x46\x6F\x72\x20\x73\x6F\x6D\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x2C\x20\x74\x68\x65\x20\x6D\x61\x70\x70\x69\x6E\x67\x20\x70\x72\x6F\x63\x65\x73\x73\x20\x6D\x75\x73\x74\x20\x62\x65\x20\x63\x6F\x6E\x64\x75\x63\x74\x65\x64\x20\x77\x69\x74\x68\x69\x6E\x20\x74\x68\x65\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x20\x69\x74\x73\x65\x6C\x66\x2E\n\n\x23\x23\x23\x20\x49\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x2D\x73\x70\x65\x63\x69\x66\x69\x63\x20\x62\x65\x68\x61\x76\x69\x6F\x72\n\n\x7C\x20\x42\x61\x6E\x6B\x20\x46\x65\x65\x64\x20\x49\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x7C\x20\x41\x50\x49\x20\x4D\x61\x70\x70\x69\x6E\x67\x20\x7C\x20\x43\x6F\x64\x61\x74\x20\x55\x49\x20\x4D\x61\x70\x70\x69\x6E\x67\x20\x7C\x20\x41\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x50\x6C\x61\x74\x66\x6F\x72\x6D\x20\x4D\x61\x70\x70\x69\x6E\x67\x20\x7C\n\x7C\x20\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x20\x7C\x20\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x20\x7C\x20\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x20\x7C\x20\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x2D\x20\x7C\n\x7C\x20\x58\x65\x72\x6F\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\n\x7C\x20\x46\x72\x65\x65\x41\x67\x65\x6E\x74\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\n\x7C\x20\x4F\x72\x61\x63\x6C\x65\x20\x4E\x65\x74\x53\x75\x69\x74\x65\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\n\x7C\x20\x45\x78\x61\x63\x74\x20\x4F\x6E\x6C\x69\x6E\x65\x20\x28\x4E\x4C\x29\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\n\x7C\x20\x51\x75\x69\x63\x6B\x42\x6F\x6F\x6B\x73\x20\x4F\x6E\x6C\x69\x6E\x65\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\n\x7C\x20\x53\x61\x67\x65\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C\x20\u2705\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7C" - operationId: create-bank-account-mapping + - 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/BankFeedAccountMapping' + $ref: '#/components/schemas/Supplier/definitions/supplierPrototype' examples: - Example: + Suppliers: value: - sourceAccountId: acc-002 - targetAccountId: account-081 + 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: Success + '201': + description: Created content: application/json: schema: - $ref: '#/components/schemas/BankFeedAccountMappingResponse' - examples: {} + $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': @@ -2609,35 +1678,97 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections/{connectionId}/bankFeeds/info': + '/companies/{companyId}/connections/{connectionId}/payables/suppliers/{supplierId}': 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. + - 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. ### Supported Integrations - | Integration | Supported | - |-----------------------|-----------| - | Oracle NetSuite | Yes | - | Xero | Yes | - | Exact | No | - | FreeAgent | No | - | Sage | No | - | QuickBooks Online | No | - operationId: get-company-information - tags: - - Company information + + | 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. + operationId: update-supplier + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Supplier/definitions/supplierPrototype' + examples: + Update supplier: + value: + 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: Success content: application/json: schema: - $ref: '#/components/schemas/CompanyInformation' - examples: {} + $ref: '#/components/schemas/Supplier' + examples: + Updated supplier: + 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': @@ -2654,429 +1785,53 @@ paths: $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections/{connectionId}/bankFeeds/otp': + '/companies/{companyId}/connections/{connectionId}/payables/bankAccounts': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' post: tags: - - Source accounts - summary: Generate one-time password - description: | - The *Generate OTP* endpoint generates a one-time password (OTP) for a bank feed connection. The OTP is returned along with an expiry time, after which it will no longer be valid. - - > **For Sage only** - > - > Only call this endpoint for connections to Sage. Calling it for other integrations will return an error. - operationId: generate-otp + - 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/BankAccount/definitions/bankAccountPrototype' + examples: + Bank account example: + value: + nominalCode: '22' + name: Plutus - Payables - Bank Account 12 + accountNumber: 0120 0440 + sortCode: 50-50-50 + currency: GBP + accountType: Debit responses: - '200': - description: Success + '201': + description: Created content: application/json: schema: - $ref: '#/components/schemas/GenerateOtpResponse' - 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}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions': - post: - tags: - - Transactions - summary: Create bank transactions - description: "\uFEFF\x54\x68\x65\x20\x2A\x43\x72\x65\x61\x74\x65\x20\x62\x61\x6E\x6B\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x63\x72\x65\x61\x74\x65\x73\x20\x6E\x65\x77\x20\x5B\x62\x61\x6E\x6B\x20\x74\x72\x61\x6E\x73\x61\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x42\x61\x6E\x6B\x54\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x29\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\x2E\n\n\x5B\x42\x61\x6E\x6B\x20\x74\x72\x61\x6E\x73\x61\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\x73\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x42\x61\x6E\x6B\x54\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x29\x20\x61\x72\x65\x20\x72\x65\x63\x6F\x72\x64\x73\x20\x6F\x66\x20\x6D\x6F\x6E\x65\x74\x61\x72\x79\x20\x61\x6D\x6F\x75\x6E\x74\x73\x20\x74\x68\x61\x74\x20\x68\x61\x76\x65\x20\x6D\x6F\x76\x65\x64\x20\x69\x6E\x20\x61\x6E\x64\x20\x6F\x75\x74\x20\x6F\x66\x20\x61\x6E\x20\x53\x4D\x42\x27\x73\x20\x62\x61\x6E\x6B\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\n\n\x2A\x2A\x49\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x2D\x73\x70\x65\x63\x69\x66\x69\x63\x20\x62\x65\x68\x61\x76\x69\x6F\x72\x2A\x2A\n\n\x54\x68\x65\x20\x72\x65\x71\x75\x69\x72\x65\x64\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x20\x6D\x61\x79\x20\x76\x61\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\x2E\x20\x46\x6F\x72\x20\x64\x65\x74\x61\x69\x6C\x65\x64\x20\x72\x65\x71\x75\x69\x72\x65\x6D\x65\x6E\x74\x73\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x74\x6F\x20\x65\x61\x63\x68\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x2C\x20\x72\x65\x66\x65\x72\x20\x74\x6F\x20\x74\x68\x65\x20\x41\x50\x49\x20\x72\x65\x66\x65\x72\x65\x6E\x63\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\x73\x2E\n\x41\x6C\x74\x65\x72\x6E\x61\x74\x69\x76\x65\x6C\x79\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x76\x69\x65\x77\x20\x74\x68\x65\x20\x5B\x47\x65\x74\x20\x63\x72\x65\x61\x74\x65\x20\x62\x61\x6E\x6B\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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\x62\x61\x6E\x6B\x2D\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x2D\x6D\x6F\x64\x65\x6C\x29\x20\x66\x6F\x72\x20\x6D\x6F\x72\x65\x20\x69\x6E\x66\x6F\x72\x6D\x61\x74\x69\x6F\x6E\x2E" - operationId: create-bank-transactions - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/accountId' - - $ref: '#/components/parameters/timeoutInMinutes' - - name: allowSyncOnPushComplete - in: query - schema: - type: boolean - default: true - description: Allow a sync upon push completion. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateBankTransactions' - examples: - Xero: - value: - accountId: 49cd5a42-b311-4750-9361-52e2ed1d4653 - transactions: - - id: '716422529' - date: '2023-08-22T10:21:00' - description: Repayment of Credit Card - counterparty: Bank of Example - reference: Ref-12345 - reconciled: true - amount: 100 - balance: 100 - transactionType: Credit - - id: '716422530' - date: '2023-08-22T10:22:00' - description: Amazon Purchase - counterparty: Amazon - reference: Ref-12346 - reconciled: false - amount: -100 - balance: 0 - transactionType: Debit - - id: '716422531' - date: '2023-08-22T10:23:00' - description: Office Supplies - counterparty: Office Mart - reference: Ref-12347 - reconciled: false - amount: -60 - balance: -60 - transactionType: Debit - QuickBooks Online Bank Feeds: - value: - accountId: 49cd5a42-b311-4750-9361-52e2ed1d4653 - transactions: - - id: '716422529' - date: '2023-08-22T10:21:00' - description: Repayment of Credit Card - amount: 100 - balance: 100 - transactionType: Credit - - id: '716422530' - date: '2023-08-22T10:22:00' - description: Amazon Purchase - amount: -100 - balance: 0 - transactionType: Debit - - id: '716422531' - date: '2023-08-22T10:23:00' - description: Office Supplies - amount: -60 - balance: -60 - transactionType: Debit - FreeAgent: - value: - accountId: 49cd5a42-b311-4750-9361-52e2ed1d4653 - transactions: - - id: '716422529' - date: '2023-08-22T10:21:00' - description: Repayment of Credit Card - amount: 100 - transactionType: Credit - - id: '716422530' - date: '2023-08-22T10:22:00' - description: Amazon Purchase - amount: -100 - transactionType: Debit - - id: '716422531' - date: '2023-08-22T10:23:00' - description: Office Supplies - amount: -60 - transactionType: Debit - Sage: - value: - accountId: 49cd5a42-b311-4750-9361-52e2ed1d4653 - transactions: - - id: '716422529' - date: '2023-08-22T10:21:00' - description: Repayment of Credit Card - counterparty: Bank of Example - reference: Ref-12345 - amount: 100 - balance: 100 - transactionType: Credit - - id: '716422530' - date: '2023-08-22T10:22:00' - description: Amazon Purchase - counterparty: Amazon - reference: Ref-12346 - amount: -100 - balance: 0 - transactionType: Debit - - id: '716422531' - date: '2023-08-22T10:23:00' - description: Office Supplies - counterparty: Office Mart - reference: Ref-12347 - amount: -60 - balance: -60 - transactionType: Debit - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateBankTransactionsResponse' - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions': - get: - tags: - - Transactions - summary: Get create bank transactions model - description: |- - The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/bank-feeds-api#/schemas/BankTransactions) for a given company and integration. - - [Bank account transactions](https://docs.codat.io/bank-feeds-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. - - **Integration-specific behavior** - - See the *response examples* for integration-specific indicative models. - operationId: get-create-bank-transactions-model - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - $ref: '#/components/parameters/accountId' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/PushOption' - examples: {} - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/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 create operation - tags: - - Transactions - operationId: get-create-operation - x-speakeasy-name-override: get-create-operation - description: |- - The **Get create operation** endpoint returns a specific [write operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company. - - Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. - - For bank feeds, your push operations will only relate to the `bankTransactions` data type. - 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}/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 create operations - tags: - - Transactions - operationId: list-create-operations - x-speakeasy-name-override: list-create-operations - description: "The **List create operations** endpoint returns a list of [write operations](/using-the-api/push) performed on the company.\n\nWrite operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. \n\nFor bank feeds, use this endpoint to view write operations related to the `bankTransactions` data type." - 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}/connections/{connectionId}/bankFeedAccounts/{sourceAccountId}/managedBankFeeds/syncs/{syncId}': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - name: sourceAccountId - in: path - required: true - schema: - type: string - description: The ID of the source bank account. - - name: syncId - in: path - required: true - schema: - type: string - format: uuid - description: The ID of the sync. - get: - tags: - - Managed bank feeds - summary: Get sync - operationId: get-managed-bank-feed-sync - x-speakeasy-name-override: get-sync - description: "The _Get sync_ endpoint returns the [sync status](https://docs.codat.io/bank-feeds-api#/schemas/SyncStatusResult) for a given 'syncId'. \n\nA sync is a single execution that fetches bank transactions from a connected bank account and records them in the company's accounting software." - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SyncStatusResult' - '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}/bankFeedAccounts/{sourceAccountId}/managedBankFeeds/syncs/latest': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - name: sourceAccountId - in: path - required: true - schema: - type: string - description: The ID of the source bank account. - get: - tags: - - Managed bank feeds - summary: Get latest sync - operationId: get-latest-managed-bank-feed-sync - x-speakeasy-name-override: get-latest-sync - description: "The _Get latest sync_ endpoint returns the status for a given source account's [most recent sync](https://docs.codat.io/bank-feeds-api#/schemas/SyncStatusResult). \n\nA sync is a single execution that fetches bank transactions from a connected bank account and records them in the company's accounting software." - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SyncStatusResult' - '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' - '/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/{sourceAccountId}/managedBankFeeds/syncs': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - - name: sourceAccountId - in: path - required: true - schema: - type: string - description: The ID of the source bank account. - post: - tags: - - Managed bank feeds - summary: Run ad-hoc sync - operationId: run-managed-bank-feed-ad-hoc-sync - x-speakeasy-name-override: run-ad-hoc-sync - description: |- - The _Run ad-hoc sync_ endpoint immediately runs a sync with a fetch period from the last successful sync to the execution time of the new sync. - - A sync is a single execution that fetches bank transactions from a connected bank account and records them in the company's accounting software. - - Use either the [_Get latest sync_](https://docs.codat.io/bank-feeds-api#/operations/get-latest-managed-bank-feed-sync) endpoint or the [_Get sync_](https://docs.codat.io/bank-feeds-api#/operations/fetch-managed-bank-feed-sync-by-id) endpoint to get the result of this sync. - responses: - '201': - description: Created - content: - application/json: - schema: - $ref: '#/components/schemas/StartScheduledSyncResult' + $ref: '#/components/schemas/BankAccount' + examples: + Created bank account: + value: + 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': @@ -3087,14 +1842,14 @@ 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: "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: @@ -3138,500 +1893,551 @@ webhooks: responses: '200': description: Return a 200 status to indicate that the webhook was received successfully. - bankFeeds.sourceAccount.connected: - post: - description: Triggered when a bank feed source account has become connected to a target account. This occurs when a user sets up mapping between the two. - x-svix-feature-flag: bank-feeds - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SourceAccountWebhook' - examples: - Connected: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: bankFeeds.sourceAccount.connected - generatedDate: '2022-10-23T00:00:00.000Z' - payload: - referenceCompany: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: Toft stores - description: Requested early access to the new financing scheme. - links: - portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' - connectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - sourceAccount: - id: acc-002 - accountName: account-081 - sortCode: '040004' - accountNumber: '12345678' - currency: GBP - balance: 99.99 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - status: pending - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - bankFeeds.sourceAccount.disconnected: - post: - description: Called when a bank feed source account has become disconnected. - x-svix-feature-flag: bank-feeds - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SourceAccountWebhook' - examples: - Disconnected: - value: - id: ba29118f-5406-4e59-b05c-ba307ca38d01 - eventType: bankFeeds.sourceAccount.disconnected - generatedDate: '2022-10-23T00:00:00.000Z' - payload: - referenceCompany: - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: Toft stores - description: Requested early access to the new financing scheme. - links: - portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' - connectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - sourceAccount: - id: acc-002 - accountName: account-081 - sortCode: '040004' - accountNumber: '12345678' - currency: GBP - balance: 99.99 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - status: pending - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. components: schemas: - BankAccountCredentials: - title: Bank Account Credentials - description: Result of generate credentials - type: object - properties: - username: - type: string - example: S0MW-TR0P-7DS0 - description: Username used by the bank feeds platform to retrieve transactions - password: - type: string - example: cO0ajh0uGyTN0Pwh - description: Password to enable the bank feeds platform to securely retrieve transactions. - examples: - - QuickBooks Online Bank Feeds: null - username: S0MW-TR0P-7DS0 - password: cO0ajh0uGyTN0Pwh - BankAccounts: + Address: + title: Address x-internal: true - title: 'Accounting: Bank accounts' - allOf: - - type: object - properties: - results: - type: array - items: - 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/bank-feeds-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/BankAccounts/allOf/0/properties/results/items/definitions/bankAccountPrototype' - - 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 - 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 - - title: Modified dates - x-internal: true - allOf: - - title: ModifiedDate - x-internal: true - type: object - properties: - modifiedDate: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: |- - The date when the record was last fetched from the 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/DateTime' - - 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: - bankAccountPrototype: - title: Bank account prototype - type: object - properties: - accountName: - type: string - nullable: true - description: Name of the bank account in the accounting software. - accountType: - title: Bank Account Type - x-internal: true - enum: - - Unknown - - Credit - - Debit - type: string - description: "The type of transactions and balances on the account. \nFor Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. \nFor Debit accounts, positive balances are assets, and positive transactions **increase** assets." - nominalCode: - type: string - nullable: true - description: Code used to identify each nominal account for a business. - sortCode: - type: string - nullable: true - description: |- - Sort code for the bank account. - - 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/SourceAccount/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/BankAccounts/allOf/0/properties/results/items/definitions/bankAccountStatus' - bankAccountCreateResponse: - title: Create bank account response - allOf: - - properties: - data: - allOf: - - $ref: '#/components/schemas/BankAccounts/allOf/0/properties/results/items' - - deprecated: true - - $ref: '#/components/schemas/PushOperation' - bankAccountRef: - title: Bank account reference - type: object - properties: - id: - type: string - description: Bank account 'id' for the account transaction. - name: - type: string - description: bank account 'name' for the account transaction. - description: Links to the Account transactions data type. - bankAccounts: - title: 'Accounting: Bank accounts' - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/BankAccounts/allOf/0/properties/results/items' - - $ref: '#/components/schemas/Companies/allOf/1' - bankAccountStatus: - title: Account status - enum: - - Unknown - - Active - - Archived - - Pending - type: string - description: Status of the bank account. - example: Active - - $ref: '#/components/schemas/Companies/allOf/1' - BankFeedAccountMapping: - title: Bank feed account mapping type: object - additionalProperties: false properties: - sourceAccountId: + type: + $ref: '#/components/schemas/Address/definitions/addressType' + line1: type: string - description: Unique ID for the source account - targetAccountId: + nullable: true + description: Line 1 of the customer address. + line2: type: string nullable: true - description: Unique ID for the target account - feedStartDate: - $ref: '#/components/schemas/DateTime' + description: Line 2 of the customer address. + city: + type: string nullable: true - description: The date from which bank transactions can be provided to the platform. - required: - - sourceAccountId - examples: - - sourceAccountId: acc-002 - targetAccountId: account-081 - BankFeedAccountMappingResponse: - title: Bank feed account mapping response - type: object - additionalProperties: false - properties: - sourceAccountId: + description: City of the customer address. + region: type: string - description: Unique ID for the source account. - targetAccountId: + nullable: true + description: Region of the customer address. + country: type: string nullable: true - description: Unique ID for the target account. - status: + 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: Status of the POST request. - error: + 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 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: + 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 + type: object nullable: true - description: Error returned during the post request - examples: - - sourceAccountId: acc-002 - targetAccountId: account-081 - status: Failed - error: A feed connection already exists to this account - BankFeedMapping: - title: Bank feed mapping + 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: + 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. \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 properties: - sourceAccountId: + id: type: string - description: Unique ID for the source account. - sourceAccountName: + description: 'Identifier for the bill, unique for the company in the accounting software.' + reference: type: string - description: Name for the source account. - sourceAccountNumber: + 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: Account number for the source account. - sourceBalance: + 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 - description: Balance for the source account. - sourceCurrency: - $ref: '#/components/schemas/SourceAccount/properties/currency' - targetAccountId: - type: string nullable: true - description: Unique ID for the target account in the accounting software. - targetAccountName: - type: string - description: Name for the target account in the accounting software. - status: - type: string - description: The status. - targetAccountOptions: + 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 nullable: true - description: An array of potential target accounts. + description: Array of Bill line items. items: - $ref: '#/components/schemas/BankFeedMapping/definitions/targetAccountOption' - feedStartDate: - $ref: '#/components/schemas/DateTime' + $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: The date from which bank transactions can be provided to the platform. - description: 'A bank feed connection between a source account and a target account, including potential target accounts.' + 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: + - supplierRef + - issueDate + - dueDate + - currency + - status definitions: - targetAccountOption: - title: Target Account Option + billPrototype: + title: Bill prototype type: object properties: - id: - type: string - description: Id of the target account. - name: + 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: + description: type: string nullable: true - description: Name of the target account. - balance: + 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: The balance of the account. - sortCode: - type: string + description: 'Total amount of the line, including tax.' + taxRateRef: + $ref: '#/components/schemas/Bill/definitions/billTaxRateRef' + trackingRefs: + type: array nullable: true - description: The sort code of the account. - accountNumber: + 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: '''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: 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 + properties: + 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: + 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: 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: + 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: + billPaymentPrototype: + title: Bill payment prototype + type: object + properties: + 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 - nullable: true - description: The account number of the account. - bankFeedMappings: - title: Bank feed mappings - type: array - items: - $ref: '#/components/schemas/BankFeedMapping' - additionalProperties: false - examples: - - sourceAccountId: acc-002 - targetAccountId: account-081 - sourceCurrency: USD - status: Success - feedStartDate: '2023-01-09T14:14:14.1057478Z' - sourceAccountName: ACME Bank - sourceAccountNumber: 1234-5678 - sourceBalance: 500 - targetAccountName: ACME Bank - - sourceAccountId: c53fd75a-dddb-4493-839a-5090b008f625 - status: pending - targetAccountOptions: - - name: account-081 - id: 044096a7-1478-4554-8820-f478caad1b00 - balance: 100.99 - sortCode: '602336' - accountNumber: '23203' - sourceAccountName: bank name here - sourceAccountNumber: '5670' - sourceBalance: 1550 - sourceCurrency: GBP - BankTransactions: - title: Bank transactions - type: array - maxItems: 1000 - items: - title: Bank transaction - type: object - properties: - id: - type: string - description: 'Identifier for the bank account transaction, unique for the company in the accounting software.' - example: '716422529' - date: - title: Local date time - type: string - examples: - - '2023-08-22T10:21:00' - - '2023-08-22' - 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: - - ``` - 2023-08-22T10:21:00 - 2023-08-22 - ``` - - When pushing bank transaction data to Codat, the date is treated as a local date. This means: - - - The date/time is used exactly as provided, without any timezone conversion. - - If a timezone offset is included (e.g., `2023-08-22T10:21:00-05:00`), the offset will be ignored and only the local date/time portion will be used. - - We recommend providing dates without a timezone suffix for clarity (e.g., `2023-08-22T10:21:00` rather than `2023-08-22T10:21:00Z`). - description: - type: string - nullable: true - description: Description of the bank transaction. - example: Debit for Payment Id sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60 - counterparty: - type: string - nullable: true - description: The giving or receiving party such as a person or organization. - example: ACME INC - reference: - type: string - nullable: true - description: An optional reference to the bank transaction. - example: reference for transaction - reconciled: - type: boolean - nullable: true - description: '`True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting software.' - example: false - amount: - type: number - format: decimal - description: The amount transacted in the bank transaction. - example: 999.99 - balance: - type: number - format: decimal - description: 'The remaining balance in the account with ID `accountId`. This field is optional for QuickBooks Online but is required for Xero, Sage, NetSuite, Exact, and FreeAgent.' - example: -999.99 - transactionType: - title: Bank transaction type - nullable: true - description: Type of transaction for the bank statement line. - type: string - enum: - - Unknown - - Credit - - Debit - - Int - - Div - - Fee - - SerChg - - Dep - - Atm - - Pos - - Xfer - - Check - - Payment - - Cash - - DirectDep - - DirectDebit - - RepeatPmt - - Other + 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 @@ -3648,7 +2454,7 @@ components: - client.rateLimit.reset - client.rateLimit.reached generatedDate: - $ref: '#/components/schemas/DateTime' + $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' @@ -3664,7 +2470,7 @@ components: type: integer description: Total number of requests remaining for your client. expiryDate: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' description: The date time in UTC when your daily quota is reset. Companies: title: Companies @@ -3676,68 +2482,10 @@ components: type: array items: $ref: '#/components/schemas/Company' - - type: object - title: Pagination information - x-internal: true - properties: - pageNumber: - type: integer - description: Current page number. - pageSize: - type: integer - description: Number of items to return in results array. - maximum: 2000 - totalResults: - type: integer - description: Total number of items. - _links: - $ref: '#/components/schemas/Companies/allOf/1/definitions/links' - definitions: - links: - title: Hal Links - type: object - required: - - self - - current - properties: - self: - $ref: '#/components/schemas/Companies/allOf/1/definitions/halRef' - current: - $ref: '#/components/schemas/Companies/allOf/1/definitions/halRef' - next: - $ref: '#/components/schemas/Companies/allOf/1/definitions/halRef' - previous: - $ref: '#/components/schemas/Companies/allOf/1/definitions/halRef' - examples: - - self: - href: /companies - current: - href: /companies?page=1&pageSize=10 - halRef: - title: Hypertext reference - type: object - properties: - href: - type: string - format: uri-reference - description: Uri hypertext reference. - required: - - pageNumber - - pageSize - - totalResults - - _links - examples: - - pageNumber: 1 - pageSize: 10 - totalResults: 1 - _links: - self: - href: '/companies/{id}/data/{dataType}' - current: - href: '/companies/{id}/data/{dataType}?page=1&pageSize=10' + - $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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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' @@ -3767,10 +2515,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/DateTime' + $ref: '#/components/schemas/Connection/properties/created' nullable: true created: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' createdByUserName: type: string description: Name of user that created the company in Codat. @@ -3849,62 +2597,19 @@ components: products: - spend-insights - lending - CompanyAccessToken: - title: Company access token - description: Details of the access token provisioned for a company. - type: object - allOf: - - $ref: '#/components/schemas/CompanyAccessToken/definitions/accessToken' - definitions: - accessToken: - title: Access token - type: object - properties: - expiresIn: - type: integer - description: The number of seconds until the access token expires. - example: 86400 - accessToken: - type: string - description: The access token for the company. - tokenType: - type: string - description: The type of token. - example: Bearer - required: - - expiresIn - - accessToken - - tokenType - examples: - - expiresIn: 86400 - accessToken: string - tokenType: Bearer CompanyInformation: title: Company information - description: Information about the company from the underlying accounting software. type: object + description: Gets the latest basic info for a company. properties: companyName: type: string - nullable: false + nullable: true description: Name of the linked company. baseCurrency: - type: string - nullable: false - description: Currency set in the accounting software of the linked company. - planType: type: string nullable: true - description: 'Accounting software subscription type such as Trial, Demo, Standard.' - multicurrencyEnabled: - type: boolean - description: Boolean showing if the organisation has multicurrency enabled. - currencies: - type: array - nullable: true - description: Array of enabled currencies for the linked company. - items: - type: string + description: Currency set in the accounting software of the linked company. Used by the currency rate. CompanyRequestBody: title: Create company request x-internal: true @@ -3941,7 +2646,7 @@ components: $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\x62\x61\x6E\x6B\x2D\x66\x65\x65\x64\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: @@ -3983,10 +2688,15 @@ components: status: $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' lastSync: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' nullable: true created: - $ref: '#/components/schemas/DateTime' + 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 @@ -4031,7 +2741,7 @@ components: type: string description: A message about a error returned by Codat. erroredOnUtc: - $ref: '#/components/schemas/DateTime' + $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. @@ -4043,7 +2753,7 @@ components: resolvedOnUtc: description: The datetime in Utc that the error was resolved. nullable: true - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' dataConnectionSourceType: title: Source Type description: The type of platform of the connection. @@ -4078,91 +2788,88 @@ components: type: array items: $ref: '#/components/schemas/Connection' - - $ref: '#/components/schemas/Companies/allOf/1' - CreateBankTransactions: - title: Create bank transactions + - $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 + - currentStatus properties: - accountId: + dataType: + title: Data types + x-internal: true type: string - description: Unique identifier for a bank account. - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - '7110701885' - - EILBDVJVNUAGVKRQ - - Checking 0202 - transactions: - $ref: '#/components/schemas/BankTransactions' - required: - - accountId - - transactions - CreateBankTransactionsResponse: - title: Create bank transaction response - x-internal: true - allOf: - - type: object - properties: - data: - $ref: '#/components/schemas/CreateBankTransactions' - - $ref: '#/components/schemas/PushOperation' + description: Available data types + enum: + - accountTransactions + - balanceSheet + - bankAccounts + - bankTransactions + - billCreditNotes + - billPayments + - bills + - cashFlowStatement + - chartOfAccounts + - company + - creditNotes + - customers + - directCosts + - directIncomes + - invoices + - itemReceipts + - items + - journalEntries + - journals + - paymentMethods + - payments + - profitAndLoss + - purchaseOrders + - salesOrders + - suppliers + - taxRates + - trackingCategories + - transfers + - banking-accountBalances + - banking-accounts + - banking-transactionCategories + - banking-transactions + - commerce-companyInfo + - commerce-customers + - commerce-disputes + - commerce-locations + - commerce-orders + - commerce-paymentMethods + - commerce-payments + - commerce-productCategories + - commerce-products + - commerce-taxComponents + - commerce-transactions + example: invoices + lastSuccessfulSync: + $ref: '#/components/schemas/Connection/properties/created' + currentStatus: + $ref: '#/components/schemas/PullOperation/properties/status' + latestSyncId: + type: string + description: Unique identifier for most recent sync of data type. + format: uuid + example: ad474a37-2003-478e-baee-9af9f1ec2fe3 + latestSuccessfulSyncId: + type: string + description: Unique identifier for the most recent successful sync of data type. + format: uuid + example: 8220fc90-55b6-47bc-9417-48ac6ea93101 + examples: + - dataType: string + lastSuccessfulSync: '2022-01-01T13:00:00.000Z' + currentStatus: string + latestSyncId: ad474a37-2003-478e-baee-9af9f1ec2fe3 + latestSuccessfulSyncId: 8220fc90-55b6-47bc-9417-48ac6ea93101 DataType: - title: Data types x-internal: true - type: string - description: Available data types - enum: - - accountTransactions - - balanceSheet - - bankAccounts - - bankTransactions - - billCreditNotes - - billPayments - - bills - - cashFlowStatement - - chartOfAccounts - - company - - creditNotes - - customers - - directCosts - - directIncomes - - invoices - - itemReceipts - - items - - journalEntries - - journals - - paymentMethods - - payments - - profitAndLoss - - purchaseOrders - - salesOrders - - suppliers - - taxRates - - trackingCategories - - transfers - - banking-accountBalances - - banking-accounts - - banking-transactionCategories - - banking-transactions - - commerce-companyInfo - - commerce-customers - - commerce-disputes - - commerce-locations - - commerce-orders - - commerce-paymentMethods - - commerce-payments - - commerce-productCategories - - commerce-products - - commerce-taxComponents - - commerce-transactions - example: invoices - DateTime: - title: Date time - type: string - examples: - - '2022-10-23T00:00: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." + $ref: '#/components/schemas/DataStatus/properties/dataType' ErrorMessage: title: Error message type: object @@ -4221,24 +2928,137 @@ components: type: string nullable: true description: Name of validator. - GenerateOtpResponse: - title: OTP response + Pagination: + title: Pagination metadata + x-internal: true type: object - description: Response containing a one-time password and its expiry time. - additionalProperties: false properties: - otp: + continuationToken: type: string - description: The one-time password. - expiry: - $ref: '#/components/schemas/DateTime' - description: The expiry date and time of the OTP in UTC. + 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 + x-internal: true + properties: + pageNumber: + type: integer + description: Current page number. + pageSize: + type: integer + description: Number of items to return in results array. + maximum: 2000 + totalResults: + type: integer + description: Total number of items. + _links: + $ref: '#/components/schemas/PagingInfo/definitions/links' + definitions: + links: + title: Hal Links + type: object + required: + - self + - current + properties: + self: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + current: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + next: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + previous: + $ref: '#/components/schemas/PagingInfo/definitions/halRef' + examples: + - self: + href: /companies + current: + href: /companies?page=1&pageSize=10 + halRef: + title: Hypertext reference + type: object + properties: + href: + type: string + format: uri-reference + description: Uri hypertext reference. required: - - otp - - expiry + - pageNumber + - pageSize + - totalResults + - _links examples: - - otp: GT40U4 - expiry: '2026-04-08T10:30:00Z' + - pageNumber: 1 + pageSize: 10 + totalResults: 1 + _links: + self: + 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: |- @@ -4302,9 +3122,9 @@ components: nullable: true description: A message about a transient or persistent error returned by Codat or the source platform. requested: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' completed: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' progress: type: integer description: An integer signifying the progress of the pull operation. @@ -4345,7 +3165,7 @@ components: type: array items: $ref: '#/components/schemas/PullOperation' - - $ref: '#/components/schemas/Companies/allOf/1' + - $ref: '#/components/schemas/PagingInfo' PushOperation: title: Push operation type: object @@ -4358,7 +3178,7 @@ components: items: $ref: '#/components/schemas/PushOperation/definitions/pushOperationChange' dataType: - $ref: '#/components/schemas/DataType' + $ref: '#/components/schemas/DataStatus/properties/dataType' description: 'The type of data being pushed, eg invoices, customers.' companyId: $ref: '#/components/parameters/companyId/schema' @@ -4369,10 +3189,10 @@ components: dataConnectionKey: $ref: '#/components/parameters/connectionId/schema' requestedOnUtc: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' description: The datetime when the push was requested. completedOnUtc: - $ref: '#/components/schemas/DateTime' + $ref: '#/components/schemas/Connection/properties/created' description: 'The datetime when the push was completed, null if Pending.' timeoutInMinutes: type: integer @@ -4441,709 +3261,186 @@ components: description: Type of change being applied to record in third party platform. type: string enum: - - Unknown - - Created - - Modified - - Deleted - - AttachmentUploaded - pushOperationRef: - title: Push operation reference - x-internal: true - type: object - properties: - id: - type: string - description: Unique identifier for a push operation. - dataType: - $ref: '#/components/schemas/DataType' - nullable: true - additionalProperties: false - pushOperationStatus: - title: Push operation status - type: string - enum: - - Pending - - Failed - - Success - - TimedOut - description: The current status of the push operation. - pushOperationChange: - type: object - properties: - type: - $ref: '#/components/schemas/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/Companies/allOf/1' - 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' - SourceAccount: - title: Source account (v1) - type: object - description: The target bank account in a supported accounting software for ingestion into a bank feed. - additionalProperties: false - properties: - id: - type: string - description: Unique ID for the bank account. - accountName: - type: string - nullable: true - description: The bank account name. - accountType: - type: string - nullable: true - description: The type of bank account e.g. Credit. - accountNumber: - type: string - nullable: true - description: The account number. - sortCode: - type: string - nullable: true - description: The sort code. - 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 - balance: - type: number - format: decimal - nullable: true - description: The latest balance for the bank account. - modifiedDate: - $ref: '#/components/schemas/DateTime' - nullable: true - description: The last date the bank account was modified. - status: - type: string - nullable: true - description: Status of the source account. - enum: - - pending - - connected - - connecting - - disconnected - - unknown - feedStartDate: - $ref: '#/components/schemas/DateTime' - nullable: true - required: - - id - definitions: - sourceAccountPrototype: - title: Source account (v1) + - Unknown + - Created + - Modified + - Deleted + - AttachmentUploaded + pushOperationRef: + title: Push operation reference + x-internal: true type: object properties: id: - $ref: '#/components/schemas/SourceAccount/properties/id' - accountName: - $ref: '#/components/schemas/SourceAccount/properties/accountName' - accountType: - $ref: '#/components/schemas/SourceAccount/properties/accountType' - accountNumber: - $ref: '#/components/schemas/SourceAccount/properties/accountNumber' - sortCode: - $ref: '#/components/schemas/SourceAccount/properties/sortCode' - currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' - balance: - $ref: '#/components/schemas/SourceAccount/properties/balance' - modifiedDate: - $ref: '#/components/schemas/SourceAccount/properties/modifiedDate' - required: - - id - sourceAccounts: - title: Source accounts - type: array - items: - $ref: '#/components/schemas/SourceAccount' - examples: - - id: acc-002 - accountName: account-081 - sortCode: '123456' - accountType: Credit - accountNumber: '12345670' - currency: GBP - balance: 99.99 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - status: pending - - id: acc-003 - accountName: account-095 - sortCode: '123456' - accountType: Credit - accountNumber: '12345671' - currency: USD - balance: 0 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - status: pending - SourceAccountBatchCreateResponse: - title: Batch source account request creation response - description: Account ID and resulting object of the batch `Create source account` request. - type: object - properties: - sourceAccountId: - type: string - description: Unique ID for the source account. - examples: - - '12345' - result: - $ref: '#/components/schemas/SourceAccountBatchCreateResponse/definitions/sourceAccountBatchCreateResult' - definitions: - sourceAccountBatchCreateResult: - title: Source Account Batch Create Result - description: Status details and corresponding object of the `Create account` operation. - type: object - properties: - statusCode: - type: integer - description: The HTTP status code for the creation of the source account - error: type: string + description: Unique identifier for a push operation. + dataType: + $ref: '#/components/schemas/DataStatus/properties/dataType' nullable: true - description: A brief description of the error. - account: - $ref: '#/components/schemas/SourceAccount' - SourceAccountBatchErrorResponse: - title: Batch source account creation error - description: Describes the error that occured when trying to create the specified source account. - type: object - properties: - sourceAccountId: + additionalProperties: false + pushOperationStatus: + title: Push operation status type: string - description: Unique ID for the source account. - examples: - - '12345' - result: + enum: + - Pending + - Failed + - Success + - TimedOut + description: The current status of the push operation. + pushOperationChange: type: object properties: - statusCode: - description: The error status code for the attempted creation of the source account. - type: string - examples: - - 409 - error: - description: The error description for the attempted creation of the source account. + type: + $ref: '#/components/schemas/PushOperation/definitions/pushChangeType' + recordRef: + $ref: '#/components/schemas/PushOperation/definitions/pushOperationRef' + attachmentId: type: string - examples: - - A bank account already exists with the same Id - SourceAccountV2: - title: Source account (v2) + 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 - description: The target bank account in a supported accounting software for ingestion into a bank feed. - additionalProperties: false properties: id: type: string - description: Unique ID for the bank account. - accountName: + description: 'Identifier for the supplier, unique to the company in the accounting software.' + supplierName: type: string - description: The bank account name. - accountType: + description: 'Name of the supplier as recorded in the accounting system, typically the company name.' + contactName: type: string - description: 'The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard.' - enum: - - checking - - savings - - loan - - creditCard - - prepaidCard - accountNumber: + nullable: true + description: Name of the main contact for the supplier. + emailAddress: type: string - description: The account number. - sortCode: + nullable: true + description: Email address that the supplier may be contacted on. + phone: type: string nullable: true - description: The sort code. - routingInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/routingInfo' - currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' + 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/Supplier/definitions/supplierStatus' balance: type: number format: decimal - description: The latest balance for the bank account. - accountInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/accountInfo' - modifiedDate: - $ref: '#/components/schemas/DateTime' nullable: true - description: The last date the bank account was modified. - status: + description: Amount outstanding against the supplier. + defaultCurrency: type: string nullable: true - description: Status of the source account. - enum: - - pending - - connected - - connecting - - disconnected - - unknown - feedStartDate: - nullable: true - title: Date - type: string - example: '2022-10-23' - description: |- - In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example: - ``` - 2020-10-08 - ``` - required: - - id - - accountName - - accountType - - accountNumber - - currency - - balance + description: Default currency the supplier's transactional data is recorded in. + 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: - sourceAccountV2Prototype: - title: Source account (v2) + supplierPrototype: + title: Supplier prototype type: object properties: - id: - $ref: '#/components/schemas/SourceAccountV2/properties/id' - accountName: - $ref: '#/components/schemas/SourceAccountV2/properties/accountName' - accountType: - $ref: '#/components/schemas/SourceAccountV2/properties/accountType' - accountNumber: - $ref: '#/components/schemas/SourceAccountV2/properties/accountNumber' - routingInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/routingInfo' - sortCode: - $ref: '#/components/schemas/SourceAccountV2/properties/sortCode' - currency: - $ref: '#/components/schemas/SourceAccount/properties/currency' + 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/SourceAccountV2/properties/balance' - modifiedDate: - $ref: '#/components/schemas/SourceAccountV2/properties/modifiedDate' - accountInfo: - $ref: '#/components/schemas/SourceAccountV2/definitions/accountInfo' + $ref: '#/components/schemas/Supplier/properties/balance' + defaultCurrency: + $ref: '#/components/schemas/Supplier/properties/defaultCurrency' required: - - id - - accountName - - accountType - - accountNumber - - currency - - balance - accountInfo: - title: Account Info - type: object - nullable: true - properties: - description: - type: string - nullable: true - description: Description of the account. - nickname: - type: string - nullable: true - description: Name given to the account by the user. Used in UIs to assist in account selection. - accountOpenDate: - $ref: '#/components/schemas/SourceAccountV2/properties/feedStartDate' - nullable: true - description: Date when the account was opened or created at the provider - availableBalance: - type: number - format: decimal - nullable: true - description: Balance of funds available for use. This includes pending activity. - sourceAccounts: - title: Source accounts - type: array - items: - $ref: '#/components/schemas/SourceAccountV2' - routingInfo: - title: Routing Info + - supplierName + - status + supplierRef: + title: Supplier reference + description: Reference to the supplier the record relates to. type: object - description: Routing information for the bank. This does not include account number. properties: - bankCode: - type: string - nullable: true - description: The numeric identifier of the routing number - type: + id: + minLength: 1 type: string - nullable: true - default: bankcode - enum: - - rtn - - aba - - swift - - bsb - - iban - - nz2 - - trno - - sortcode - - blz - - ifsc - - bankcode - - apca - - clabe - description: The type of routing number. - examples: - - id: acc-001 - accountName: account-081 - accountType: checking - accountNumber: '12345670' - routingInfo: - bankCode: 021001088 - type: bankcode - currency: GBP - balance: 99.99 - accountInfo: - description: account description 1 - nickname: account 123 - accountOpenDate: '2023-05-06' - availableBalance: 10 - modifiedDate: '2024-08-02T00:00:00.000Z' - status: pending - feedStartDate: '2024-05-01' - - id: acc-002 - accountName: account-083 - accountType: savings - accountNumber: '23456789' - routingInfo: - bankCode: 021001088 - type: bankcode - currency: GBP - balance: 400 - accountInfo: - description: account description 2 - nickname: account 1290 - accountOpenDate: '2023-05-23' - availableBalance: 400 - modifiedDate: '2024-08-02T00:00:00.000Z' - status: pending - feedStartDate: '2024-05-01' - SourceAccountV2BatchCreateResponse: - title: Batch source account (v2) creation response - description: Account ID and resulting object of the batch `Create source account` request. - type: object - properties: - sourceAccountId: - type: string - description: Unique ID for the source account. - examples: - - '12345' - result: - $ref: '#/components/schemas/SourceAccountV2BatchCreateResponse/definitions/sourceAccountV2BatchCreateResult' - definitions: - sourceAccountV2BatchCreateResult: - title: Source Account V2 Batch CreateResult - description: Status details and corresponding object of the `Create account` operation. - type: object - properties: - statusCode: - type: integer - description: The HTTP status code for the creation of the source account - error: + description: The supplier's unique ID + supplierName: type: string nullable: true - description: A brief description of the error. - account: - $ref: '#/components/schemas/SourceAccountV2' - SourceAccountWebhook: - title: Source account status changed webhook - type: object - properties: - id: - type: string - format: uuid - example: ba29118f-5406-4e59-b05c-ba307ca38d01 - description: Unique identifier of the event. - eventType: + description: The supplier's name + required: + - id + supplierStatus: + description: Status of the supplier. type: string - description: The type of event. - examples: - - bankFeeds.sourceAccount.connected - - bankFeeds.sourceAccount.disconnected - generatedDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/SourceAccountWebhook/definitions/sourceAccountWebhookPayload' - definitions: - sourceAccountWebhookPayload: - title: Payload + enum: + - Unknown + - Active + - Archived + suppliers: + title: Suppliers type: object properties: - referenceCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - companyId: - $ref: '#/components/parameters/companyId/schema' - deprecated: true - connectionId: - $ref: '#/components/parameters/connectionId/schema' - sourceAccount: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2' - - $ref: '#/components/schemas/SourceAccount' - StartScheduledSyncResult: - title: Start scheduled sync result - type: object - description: Represents the result of an ad-hoc sync request. - properties: - syncId: - type: string - format: uuid - description: The unique identifier for the created sync. - required: - - syncId - SyncStatusResult: - title: Sync status - type: object - description: Represents the status of a managed bank feed sync. - properties: - syncId: - type: string - format: uuid - description: The unique identifier for the sync. - clientId: - type: string - format: uuid - description: The ID of the client associated with the company that owns the source bank account. - companyId: - type: string - format: uuid - description: The ID of the company that owns the source bank account. - companyName: - type: string - description: The name of the company that owns the source bank account. - dataConnectionId: - type: string - format: uuid - description: The ID of the target accounting data connection. - sourceAccountId: - type: string - description: The ID of the source bank account from which transactions are fetched. - periodStartUtc: - type: string - format: date-time - description: The start of the sync period. - periodEndUtc: - type: string - format: date-time - description: The end of the sync period. - executionStartUtc: - type: string - format: date-time - description: The UTC timestamp when the sync started executing. - status: - type: string - description: 'The current status of the sync. Known values are `Started`, `Failed`, `SuccessDataPushed`, `SuccessNoDataPushed`, `PartialSuccessDataPushed`.' - example: SuccessDataPushed - executionEndUtc: - type: string - format: date-time - nullable: true - description: 'The UTC timestamp when the sync execution ended, if completed (i.e. `status` is any value other than `Started`).' - errorMessage: - type: string - nullable: true - description: Error message if the sync failed. - errorCode: - type: string - nullable: true - description: Error code if the sync failed. - pushOperationKeys: - type: array - items: - type: string - format: uuid - nullable: true - description: 'List of write operation keys associated with the sync, if the sync resulted in write attempts.' - required: - - syncId - - clientId - - companyId - - companyName - - dataConnectionId - - sourceAccountId - - periodStartUtc - - periodEndUtc - - executionStartUtc - - status + 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: - companyId: - name: companyId + attachmentId: + name: attachmentId in: path required: true schema: type: string format: uuid example: 8a210b68-6988-11ed-a1eb-0242ac120002 - description: Unique identifier for your SMB in Codat. - description: Unique identifier for a company. - connectionId: - name: connectionId - in: path - required: true - schema: - type: string - format: uuid - example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - description: Unique identifier for a company's data connection. - description: Unique identifier for a connection. - accountId: - name: accountId - in: path - required: true - schema: - type: string - examples: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - 7110701885 - - EILBDVJVNUAGVKRQ - description: Unique identifier for an account. + description: Unique identifier for an attachment. page: name: page in: query @@ -5181,29 +3478,54 @@ components: type: string example: '-modifiedDate' description: 'Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).' - dataType: - name: dataType - description: The key of a Codat data type + 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 required: true schema: - $ref: '#/components/schemas/DataType' - datasetId: - name: datasetId + type: string + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + description: Unique identifier for your SMB in Codat. + description: Unique identifier for a company. + connectionId: + name: connectionId in: path required: true schema: type: string format: uuid - description: Unique identifier for the dataset that completed its sync. - description: Unique identifier for the dataset that completed its sync. - timeoutInMinutes: - name: timeoutInMinutes + example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + description: Unique identifier for a company's data connection. + description: Unique identifier for a connection. + continuationToken: + name: continuationToken in: query + required: false schema: - type: integer - format: int32 - description: Time limit for the push operation to complete before it is timed out. + 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: 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. @@ -5341,6 +3663,21 @@ components: correlationId: bc997528a9d7abb9161ef45f05d38599 canBeRetried: Unknown detailedErrorCode: 0 + Idempotency-Conflict: + description: A request is in progress with the same idempotency key. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + examples: + Conflict: + value: + statusCode: 409 + service: PublicApi + error: The data set has not been requested. + correlationId: bc997528a9d7abb9161ef45f05d38599 + canBeRetried: Unknown + detailedErrorCode: 0 Too-Many-Requests: description: Too many requests were made in a given amount of time. Wait a short period and then try again. content: diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 80ee4e99e..25a48de31 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.761.5 +speakeasyVersion: 1.761.9 sources: accounting-source: sourceNamespace: accounting-source @@ -82,8 +82,8 @@ sources: - prealpha sync-for-payables-source: sourceNamespace: sync-for-payables-source - sourceRevisionDigest: sha256:ee10928721af392894e08438793212efd7a6b75bbdee31aed74521b3b8c94140 - sourceBlobDigest: sha256:1b409571a17993221df3a8ee7fff2170733baceb19a51740c47ffcc1ee7a31fd + sourceRevisionDigest: sha256:f8f51f03b09f4db12dcb5b5f8dd785e924b34acf95c2963148d6332a539e20ee + sourceBlobDigest: sha256:7a4b9e31f75380f0764d515e7533741e4f7b0da48e595c9f0fcac4506d869725 tags: - latest - 3.0.0 @@ -163,10 +163,10 @@ targets: sync-for-payables-library: source: sync-for-payables-source sourceNamespace: sync-for-payables-source - sourceRevisionDigest: sha256:ee10928721af392894e08438793212efd7a6b75bbdee31aed74521b3b8c94140 - sourceBlobDigest: sha256:1b409571a17993221df3a8ee7fff2170733baceb19a51740c47ffcc1ee7a31fd + sourceRevisionDigest: sha256:f8f51f03b09f4db12dcb5b5f8dd785e924b34acf95c2963148d6332a539e20ee + sourceBlobDigest: sha256:7a4b9e31f75380f0764d515e7533741e4f7b0da48e595c9f0fcac4506d869725 codeSamplesNamespace: sync-for-payables-source-python-code-samples - codeSamplesRevisionDigest: sha256:84575811630fe65d8450f180cc068a6bf069134e57d1c8de1af248cc041ee255 + codeSamplesRevisionDigest: sha256:e7278eb6c05dba0cca947f2038debfc1518d61734868b941b81dd946377dce7b 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/.speakeasy/gen.lock b/sync-for-payables/.speakeasy/gen.lock index 29d5809a1..03be46a61 100644 --- a/sync-for-payables/.speakeasy/gen.lock +++ b/sync-for-payables/.speakeasy/gen.lock @@ -1,32 +1,32 @@ lockVersion: 2.0.0 id: 0722f07c-657c-4062-93f1-39ee3fe757d0 management: - docChecksum: 66b675d1d723d12ccffb437a1e3793aa + docChecksum: 384bfbce0790e3cb0ef8a6a311ab8782 docVersion: 3.0.0 - speakeasyVersion: 1.759.1 - generationVersion: 2.869.10 - releaseVersion: 9.0.1 - configChecksum: de9a217f3430843f1a133462179b6aba + speakeasyVersion: 1.761.9 + generationVersion: 2.881.4 + releaseVersion: 9.0.2 + configChecksum: 77deec0af6a2d388b65c1ff1128bd4e4 repoURL: https://github.com/codatio/client-sdk-python.git repoSubDirectory: sync-for-payables installationURL: https://github.com/codatio/client-sdk-python.git#subdirectory=sync-for-payables published: true persistentEdits: - generation_id: 66102a79-af79-456d-b932-bcd1f943ee15 - pristine_commit_hash: ca2606c5face54e4524a2a890c4ed887844d0e92 - pristine_tree_hash: f08ed44c3289c9da253f763830166d6a6a985107 + generation_id: 09bc7a7e-9635-4a6a-a013-d2c42db25428 + pristine_commit_hash: 4ea31e4b4dae51cba17458ced493147cc9e85177 + pristine_tree_hash: ba1b09cf55b09af560955e9d2f7735ef305ff797 features: python: additionalDependencies: 1.0.0 constsAndDefaults: 1.0.7 - core: 6.0.20 + core: 6.0.21 decimal: 1.0.0 defaultEnabledRetries: 0.2.0 downloadStreams: 1.0.1 enumUnions: 0.1.1 envVarSecurityUsage: 0.3.2 examples: 3.0.3 - globalSecurity: 3.0.5 + globalSecurity: 3.0.7 globalSecurityCallbacks: 1.0.0 globalServerURLs: 3.2.1 methodArguments: 1.0.2 @@ -34,7 +34,7 @@ features: nameOverrides: 3.0.3 nullables: 1.0.2 responseFormat: 1.1.0 - retries: 3.0.4 + retries: 3.0.5 sdkHooks: 1.2.1 serverEventsSentinels: 0.1.0 uploadStreams: 1.0.0 @@ -290,8 +290,8 @@ trackedFiles: pristine_git_object: 80229fd64c0eaf0ffef4e1d0ba9341329b9abb2e docs/models/shared/connection.md: id: 906ff4b2d85c - last_write_checksum: sha1:e6d72609fc62cc8cd246d411161e9d6d1a5c4c12 - pristine_git_object: 5bebcd785c886a0a9f2b9b8b61f760de4752482b + last_write_checksum: sha1:c5723774e129cf337c4c70da0ed652454db63657 + pristine_git_object: 32e3b4b5b86ef2b7f7bc9e91b43fbd62dc7eb95b docs/models/shared/connections.md: id: f1fe5197905a last_write_checksum: sha1:6e8736ebbdff0646c9c18d147a23889b3bab9918 @@ -422,8 +422,8 @@ trackedFiles: pristine_git_object: cb9c15d314c1930557401074329ed7a737147919 pyproject.toml: id: 5d07e7d72637 - last_write_checksum: sha1:69f35324f3aff9ce206bcbe16756b667188744e6 - pristine_git_object: 323d1dac6fe3b46cbc527b1b72c95ec34444e861 + last_write_checksum: sha1:0eca5d0f19436426f1ef1b067d7097c449d3576d + pristine_git_object: 95d8920ce1e7bddab5d9f52cb65995c379a255e8 scripts/prepare_readme.py: id: e0c5957a6035 last_write_checksum: sha1:d4b43d576372b8e73925ed9d58899b58d467046e @@ -450,36 +450,36 @@ trackedFiles: pristine_git_object: 4c4a0dfe5d3f88de010120b7cc131799fe918073 src/codat_sync_for_payables/_version.py: id: e4b8c113880b - last_write_checksum: sha1:e43b0d5b1a979696a76c4a12a061852f08181bcb - pristine_git_object: ab19f6e914ec72fd43bf3922b854935f7f7d118b + last_write_checksum: sha1:f675c75a95f449052b1c781047bff4ed35429b25 + pristine_git_object: 3a78fa4bca74dbd5333780ecf7c77c393ba67955 src/codat_sync_for_payables/bank_accounts.py: id: bffbddbd7457 - last_write_checksum: sha1:c3ad69a0d2744845db2b2f5ef86220d0e7bd3b98 - pristine_git_object: 0465022f34ce50aaaf2b18b2076f89b9bb3d4c22 + last_write_checksum: sha1:73a2d1955930822ddbe3fc2004a21828c0cd78c1 + pristine_git_object: d7e2d64882819d4cc08fd307c9a1a5d02b320347 src/codat_sync_for_payables/basesdk.py: id: 1b28cb884887 - last_write_checksum: sha1:44d6d2050de98db82d088dad3f14c99b6209d605 - pristine_git_object: 0ba2366ceb7e99695f1110300ba2bf04ba9d7f7c + last_write_checksum: sha1:1ead967e52c0f73038fa1b2f4f0d479426c6b7ae + pristine_git_object: 3aad0873331b57361bcc10d93d43a2f383c3fa4e src/codat_sync_for_payables/bill_payments.py: id: 0da608e0b7a7 - last_write_checksum: sha1:1e02e3acb11951269cd808994cc35c0060b2a3a2 - pristine_git_object: b634b6140d7903dd35f99e122662df77139c3da2 + last_write_checksum: sha1:f01b5d1fc4ea2864415ace57b65fe45494a805bd + pristine_git_object: 1c7c0d4abc4edc240a0f772394f89dad3ef30bca src/codat_sync_for_payables/bills.py: id: aa53d7af4704 - last_write_checksum: sha1:7e7483b3b5de9faf0853415607c62c3f1dc382f6 - pristine_git_object: bd54a718a25415def8ef6266de597c96dc0d5209 + last_write_checksum: sha1:bb0cf0abc275974f9c7a5524eb08c4c11618956d + pristine_git_object: 2cd20e93f9af37c554f88c1e8f5b7f2b9b86796e src/codat_sync_for_payables/companies.py: id: 5ace7f193226 - last_write_checksum: sha1:900ac2e710bdf41a8160a87a6c2f06d550ef9e2b - pristine_git_object: c4741ea603a169ecf254a21c7ab68c2f580ca257 + last_write_checksum: sha1:ee821a26a893a15b25999f9fdfda7fea4047f975 + pristine_git_object: a49b9a6494d00f4fd9e18202dc8377e7dbaf861d src/codat_sync_for_payables/company_information.py: id: 3fd5cdae8aa4 - last_write_checksum: sha1:ba1d4ca14b50cb5c50a70069c18c64293646b1c4 - pristine_git_object: ccf258f53ee03555eac00b2ac28bf43da5513c43 + last_write_checksum: sha1:12ba16b077fdd426e70f04358c4f69e6a5fa9197 + pristine_git_object: 939ae1b15e2afae26536be7e551ebeeb523e467d src/codat_sync_for_payables/connections.py: id: 01f416a3fe00 - last_write_checksum: sha1:0db1bed190b244c1c599159773d2eb0d68a4391a - pristine_git_object: 253b3b85a379f5712190e7c62d66fd8be08f007b + last_write_checksum: sha1:a4969264c8d4074b363774899187c64fa125504c + pristine_git_object: 2bb868a4a636045b94bc05d37fa2b61a88be71f2 src/codat_sync_for_payables/httpclient.py: id: e600b8855c02 last_write_checksum: sha1:5e55338d6ee9f01ab648cad4380201a8a3da7dd7 @@ -742,8 +742,8 @@ trackedFiles: pristine_git_object: c80c2629eb96fc3a2bd1cd15be61086bd463c74b src/codat_sync_for_payables/models/shared/connection.py: id: 8ce8180ca8b0 - last_write_checksum: sha1:ace4484f3cf4d0932d99f99263104a2dad2681bc - pristine_git_object: d804cfa0976604e88380f950e4dddb1a243d7f65 + last_write_checksum: sha1:d789fb6f53661408307c90b12e40220458df7812 + pristine_git_object: e4413479ebf8725f6bf87b1f689fb15f9589b613 src/codat_sync_for_payables/models/shared/connections.py: id: 2646a209fbb8 last_write_checksum: sha1:c2cf432ef4e7cd08aca5e096a4bc0a1be9893fc5 @@ -826,8 +826,8 @@ trackedFiles: pristine_git_object: 49269e53b7e7d876fee7cc040430f49c79990734 src/codat_sync_for_payables/suppliers.py: id: 8e23d8bbbb4e - last_write_checksum: sha1:92559b8f8efdcb406f66b495d3c5b4256f69d6fb - pristine_git_object: 826d5836d2c910a3f94bf75694e2061e4cb4aede + last_write_checksum: sha1:3e9db22ec0039614c225bf6760897c32e5f3e52b + pristine_git_object: 81ffdd371c9dcea04de273decdb2ac478769110b src/codat_sync_for_payables/types/__init__.py: id: 36f0e2eb152f last_write_checksum: sha1:140ebdd01a46f92ffc710c52c958c4eba3cf68ed @@ -874,8 +874,8 @@ trackedFiles: pristine_git_object: b661aff65d38b77d035149699aea09b2785d2fc6 src/codat_sync_for_payables/utils/metadata.py: id: 279791e309e3 - last_write_checksum: sha1:c6a560bd0c63ab158582f34dadb69433ea73b3d4 - pristine_git_object: 173b3e5ce658675c2f504222a56b3daaaa68107d + last_write_checksum: sha1:e703e5cbb5255144aacf86898d1420529afaaff8 + pristine_git_object: 5abddd588837ac297050ca3b543627faadb350a9 src/codat_sync_for_payables/utils/queryparams.py: id: 7fab68be229a last_write_checksum: sha1:b94c3f314fd3da0d1d215afc2731f48748e2aa59 @@ -890,12 +890,12 @@ trackedFiles: pristine_git_object: af07d4e941007af4213c5ec9047ef8a2fca04e5e src/codat_sync_for_payables/utils/security.py: id: 90581f8feeee - last_write_checksum: sha1:435dd8b180cefcd733e635b9fa45512da091d9c0 - pristine_git_object: 17996bd54b8624009802fbbdf30bcb4225b8dfed + last_write_checksum: sha1:c11eef495b6aaa249178c24c796940cc540b7a00 + pristine_git_object: 42d8d78e9981eed7507670014d99588e27ab325a src/codat_sync_for_payables/utils/serializers.py: id: aa9163915e56 - last_write_checksum: sha1:ce1d8d7f500a9ccba0aeca5057cee9c271f4dfd7 - pristine_git_object: 14321eb479de81d0d9580ec8291e0ff91bf29e57 + last_write_checksum: sha1:61009f2e4ef6613a1a5af813fe020373dae5a492 + pristine_git_object: d2149f8b909cb96628db140ac3cddb1b1e981367 src/codat_sync_for_payables/utils/unmarshal_json_response.py: id: ed38d0c2bb4d last_write_checksum: sha1:38941bbf58b0ef166d94fd0f7d79b1962bedf5c3 @@ -1930,7 +1930,15 @@ examplesVersion: 1.0.2 generatedTests: {} releaseNotes: | ## Python SDK Changes: - * `codat_sync_payables.suppliers.update()`: **Added** + * `codat_sync_payables.companies.list()`: `response.results[].data_connections[].integration_key` **Changed** + * `codat_sync_payables.companies.create()`: `response.data_connections[].integration_key` **Changed** + * `codat_sync_payables.companies.replace()`: `response.data_connections[].integration_key` **Changed** + * `codat_sync_payables.companies.update()`: `response.data_connections[].integration_key` **Changed** + * `codat_sync_payables.companies.get()`: `response.data_connections[].integration_key` **Changed** + * `codat_sync_payables.connections.list()`: `response.results[].integration_key` **Changed** + * `codat_sync_payables.connections.create()`: `response.integration_key` **Changed** + * `codat_sync_payables.connections.get()`: `response.integration_key` **Changed** + * `codat_sync_payables.connections.unlink()`: `response.integration_key` **Changed** generatedFiles: - .gitattributes - .python-version diff --git a/sync-for-payables/.speakeasy/gen.yaml b/sync-for-payables/.speakeasy/gen.yaml index 6b2b55b39..a3cd7ce1e 100644 --- a/sync-for-payables/.speakeasy/gen.yaml +++ b/sync-for-payables/.speakeasy/gen.yaml @@ -28,7 +28,7 @@ generation: generateNewTests: false skipResponseBodyAssertions: false python: - version: 9.0.1 + version: 9.0.2 additionalDependencies: dev: {} main: {} diff --git a/sync-for-payables/RELEASES.md b/sync-for-payables/RELEASES.md index 1aae56b90..7eb091cc7 100644 --- a/sync-for-payables/RELEASES.md +++ b/sync-for-payables/RELEASES.md @@ -98,4 +98,14 @@ Based on: ### Generated - [python v9.0.1] sync-for-payables ### Releases -- [PyPI v9.0.1] https://pypi.org/project/codat-sync-for-payables/9.0.1 - sync-for-payables \ No newline at end of file +- [PyPI v9.0.1] https://pypi.org/project/codat-sync-for-payables/9.0.1 - sync-for-payables + +## 2026-04-22 11:07:23 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.761.9 (2.881.4) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v9.0.2] sync-for-payables +### Releases +- [PyPI v9.0.2] https://pypi.org/project/codat-sync-for-payables/9.0.2 - sync-for-payables \ No newline at end of file diff --git a/sync-for-payables/docs/models/shared/connection.md b/sync-for-payables/docs/models/shared/connection.md index 5bebcd785..32e3b4b5b 100644 --- a/sync-for-payables/docs/models/shared/connection.md +++ b/sync-for-payables/docs/models/shared/connection.md @@ -18,7 +18,7 @@ Before you can use a data connection to pull or push data, the company must gran | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `integration_id` | *str* | :heavy_check_mark: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | -| `integration_key` | *str* | :heavy_check_mark: | A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. | | +| `integration_key` | *Optional[str]* | :heavy_minus_sign: | A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. | | | `source_id` | *str* | :heavy_check_mark: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 | | `source_type` | [shared.SourceType](../../models/shared/sourcetype.md) | :heavy_check_mark: | The type of platform of the connection. | Accounting | | `platform_name` | *str* | :heavy_check_mark: | Name of integration connected to company. | | diff --git a/sync-for-payables/pyproject.toml b/sync-for-payables/pyproject.toml index 323d1dac6..95d8920ce 100644 --- a/sync-for-payables/pyproject.toml +++ b/sync-for-payables/pyproject.toml @@ -1,7 +1,7 @@ [project] name = "codat-sync-for-payables" -version = "9.0.1" +version = "9.0.2" description = "Streamline your customers' accounts payable workflow." authors = [{ name = "Speakeasy" },] readme = "README-PYPI.md" diff --git a/sync-for-payables/src/codat_sync_for_payables/_version.py b/sync-for-payables/src/codat_sync_for_payables/_version.py index ab19f6e91..3a78fa4bc 100644 --- a/sync-for-payables/src/codat_sync_for_payables/_version.py +++ b/sync-for-payables/src/codat_sync_for_payables/_version.py @@ -3,12 +3,10 @@ import importlib.metadata __title__: str = "codat-sync-for-payables" -__version__: str = "9.0.1" +__version__: str = "9.0.2" __openapi_doc_version__: str = "3.0.0" -__gen_version__: str = "2.869.10" -__user_agent__: str = ( - "speakeasy-sdk/python 9.0.1 2.869.10 3.0.0 codat-sync-for-payables" -) +__gen_version__: str = "2.881.4" +__user_agent__: str = "speakeasy-sdk/python 9.0.2 2.881.4 3.0.0 codat-sync-for-payables" try: if __package__ is not None: diff --git a/sync-for-payables/src/codat_sync_for_payables/bank_accounts.py b/sync-for-payables/src/codat_sync_for_payables/bank_accounts.py index 0465022f3..d7e2d6488 100644 --- a/sync-for-payables/src/codat_sync_for_payables/bank_accounts.py +++ b/sync-for-payables/src/codat_sync_for_payables/bank_accounts.py @@ -97,18 +97,7 @@ def create( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -215,18 +204,7 @@ async def create_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) diff --git a/sync-for-payables/src/codat_sync_for_payables/basesdk.py b/sync-for-payables/src/codat_sync_for_payables/basesdk.py index 0ba2366ce..3aad08733 100644 --- a/sync-for-payables/src/codat_sync_for_payables/basesdk.py +++ b/sync-for-payables/src/codat_sync_for_payables/basesdk.py @@ -6,6 +6,7 @@ AfterErrorContext, AfterSuccessContext, BeforeRequestContext, + HookContext, ) from codat_sync_for_payables.models import errors from codat_sync_for_payables.utils import ( @@ -67,6 +68,7 @@ def _build_request_async( url_override: Optional[str] = None, http_headers: Optional[Mapping[str, str]] = None, allow_empty_value: Optional[List[str]] = None, + allowed_fields: Optional[List[str]] = None, ) -> httpx.Request: client = self.sdk_configuration.async_client return self._build_request_with_client( @@ -88,6 +90,7 @@ def _build_request_async( url_override, http_headers, allow_empty_value, + allowed_fields, ) def _build_request( @@ -111,6 +114,7 @@ def _build_request( url_override: Optional[str] = None, http_headers: Optional[Mapping[str, str]] = None, allow_empty_value: Optional[List[str]] = None, + allowed_fields: Optional[List[str]] = None, ) -> httpx.Request: client = self.sdk_configuration.client return self._build_request_with_client( @@ -132,6 +136,7 @@ def _build_request( url_override, http_headers, allow_empty_value, + allowed_fields, ) def _build_request_with_client( @@ -156,6 +161,7 @@ def _build_request_with_client( url_override: Optional[str] = None, http_headers: Optional[Mapping[str, str]] = None, allow_empty_value: Optional[List[str]] = None, + allowed_fields: Optional[List[str]] = None, ) -> httpx.Request: query_params = {} @@ -189,7 +195,9 @@ def _build_request_with_client( security = security() if security is not None: - security_headers, security_query_params = utils.get_security(security) + security_headers, security_query_params = utils.get_security( + security, allowed_fields + ) headers = {**headers, **security_headers} query_params = {**query_params, **security_query_params} @@ -226,15 +234,15 @@ def _build_request_with_client( data=serialized_request_body.data, files=serialized_request_body.files, headers=headers, - timeout=timeout, + timeout=timeout if timeout is not None else httpx.USE_CLIENT_DEFAULT, ) def do_request( self, - hook_ctx, - request, - error_status_codes, - stream=False, + hook_ctx: HookContext, + request: httpx.Request, + is_error_status_code: Callable[[int], bool], + stream: bool = False, retry_config: Optional[Tuple[RetryConfig, List[str]]] = None, ) -> httpx.Response: client = self.sdk_configuration.client @@ -246,6 +254,8 @@ def do(): http_res = None try: req = hooks.before_request(BeforeRequestContext(hook_ctx), request) + if "timeout" in request.extensions and "timeout" not in req.extensions: + req.extensions["timeout"] = request.extensions["timeout"] logger.debug( "Request:\nMethod: %s\nURL: %s\nHeaders: %s\nBody: %s", req.method, @@ -276,19 +286,6 @@ def do(): "" if stream else http_res.text, ) - if utils.match_status_codes(error_status_codes, http_res.status_code): - result, err = hooks.after_error( - AfterErrorContext(hook_ctx), http_res, None - ) - if err is not None: - logger.debug("Request Exception", exc_info=True) - raise err - if result is not None: - http_res = result - else: - logger.debug("Raising unexpected SDK error") - raise errors.SDKError("Unexpected error occurred", http_res) - return http_res if retry_config is not None: @@ -296,17 +293,27 @@ def do(): else: http_res = do() - if not utils.match_status_codes(error_status_codes, http_res.status_code): + if is_error_status_code(http_res.status_code): + result, err = hooks.after_error(AfterErrorContext(hook_ctx), http_res, None) + if err is not None: + logger.debug("Request Exception", exc_info=True) + raise err + if result is not None: + http_res = result + else: + logger.debug("Raising unexpected SDK error") + raise errors.SDKError("Unexpected error occurred", http_res) + else: http_res = hooks.after_success(AfterSuccessContext(hook_ctx), http_res) return http_res async def do_request_async( self, - hook_ctx, - request, - error_status_codes, - stream=False, + hook_ctx: HookContext, + request: httpx.Request, + is_error_status_code: Callable[[int], bool], + stream: bool = False, retry_config: Optional[Tuple[RetryConfig, List[str]]] = None, ) -> httpx.Response: client = self.sdk_configuration.async_client @@ -321,6 +328,8 @@ async def do(): hooks.before_request, BeforeRequestContext(hook_ctx), request ) + if "timeout" in request.extensions and "timeout" not in req.extensions: + req.extensions["timeout"] = request.extensions["timeout"] logger.debug( "Request:\nMethod: %s\nURL: %s\nHeaders: %s\nBody: %s", req.method, @@ -354,20 +363,6 @@ async def do(): "" if stream else http_res.text, ) - if utils.match_status_codes(error_status_codes, http_res.status_code): - result, err = await run_sync_in_thread( - hooks.after_error, AfterErrorContext(hook_ctx), http_res, None - ) - - if err is not None: - logger.debug("Request Exception", exc_info=True) - raise err - if result is not None: - http_res = result - else: - logger.debug("Raising unexpected SDK error") - raise errors.SDKError("Unexpected error occurred", http_res) - return http_res if retry_config is not None: @@ -377,7 +372,20 @@ async def do(): else: http_res = await do() - if not utils.match_status_codes(error_status_codes, http_res.status_code): + if is_error_status_code(http_res.status_code): + result, err = await run_sync_in_thread( + hooks.after_error, AfterErrorContext(hook_ctx), http_res, None + ) + + if err is not None: + logger.debug("Request Exception", exc_info=True) + raise err + if result is not None: + http_res = result + else: + logger.debug("Raising unexpected SDK error") + raise errors.SDKError("Unexpected error occurred", http_res) + else: http_res = await run_sync_in_thread( hooks.after_success, AfterSuccessContext(hook_ctx), http_res ) diff --git a/sync-for-payables/src/codat_sync_for_payables/bill_payments.py b/sync-for-payables/src/codat_sync_for_payables/bill_payments.py index b634b6140..1c7c0d4ab 100644 --- a/sync-for-payables/src/codat_sync_for_payables/bill_payments.py +++ b/sync-for-payables/src/codat_sync_for_payables/bill_payments.py @@ -94,18 +94,7 @@ def get_payment_options( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -209,18 +198,7 @@ async def get_payment_options_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -327,19 +305,7 @@ def create( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "409", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -448,19 +414,7 @@ async def create_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "409", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) diff --git a/sync-for-payables/src/codat_sync_for_payables/bills.py b/sync-for-payables/src/codat_sync_for_payables/bills.py index bd54a718a..2cd20e93f 100644 --- a/sync-for-payables/src/codat_sync_for_payables/bills.py +++ b/sync-for-payables/src/codat_sync_for_payables/bills.py @@ -93,18 +93,7 @@ def get_bill_options( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -206,18 +195,7 @@ async def get_bill_options_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -318,19 +296,7 @@ def list( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "409", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -433,19 +399,7 @@ async def list_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "409", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -553,19 +507,7 @@ def create( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "409", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -673,19 +615,7 @@ async def create_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "409", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -805,19 +735,7 @@ def update( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "409", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -937,19 +855,7 @@ async def update_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "409", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -1058,18 +964,7 @@ def upload_attachment( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -1176,18 +1071,7 @@ async def upload_attachment_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -1287,18 +1171,7 @@ def list_attachments( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "409", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -1398,18 +1271,7 @@ async def list_attachments_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "409", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -1512,17 +1374,7 @@ def download_attachment( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), stream=True, retry_config=retry_config, ) @@ -1633,17 +1485,7 @@ async def download_attachment_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), stream=True, retry_config=retry_config, ) diff --git a/sync-for-payables/src/codat_sync_for_payables/companies.py b/sync-for-payables/src/codat_sync_for_payables/companies.py index c4741ea60..a49b9a649 100644 --- a/sync-for-payables/src/codat_sync_for_payables/companies.py +++ b/sync-for-payables/src/codat_sync_for_payables/companies.py @@ -103,18 +103,7 @@ def list( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -227,18 +216,7 @@ async def list_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -343,17 +321,7 @@ def create( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -458,17 +426,7 @@ async def create_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -575,17 +533,7 @@ def replace( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -692,17 +640,7 @@ async def replace_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -810,17 +748,7 @@ def update( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -928,17 +856,7 @@ async def update_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -1039,17 +957,7 @@ def delete( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -1150,17 +1058,7 @@ async def delete_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -1261,17 +1159,7 @@ def get( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -1372,17 +1260,7 @@ async def get_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) diff --git a/sync-for-payables/src/codat_sync_for_payables/company_information.py b/sync-for-payables/src/codat_sync_for_payables/company_information.py index ccf258f53..939ae1b15 100644 --- a/sync-for-payables/src/codat_sync_for_payables/company_information.py +++ b/sync-for-payables/src/codat_sync_for_payables/company_information.py @@ -90,18 +90,7 @@ def get( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -201,18 +190,7 @@ async def get_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) diff --git a/sync-for-payables/src/codat_sync_for_payables/connections.py b/sync-for-payables/src/codat_sync_for_payables/connections.py index 253b3b85a..2bb868a4a 100644 --- a/sync-for-payables/src/codat_sync_for_payables/connections.py +++ b/sync-for-payables/src/codat_sync_for_payables/connections.py @@ -88,18 +88,7 @@ def list( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -197,18 +186,7 @@ async def list_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -315,17 +293,7 @@ def create( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -432,17 +400,7 @@ async def create_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -539,17 +497,7 @@ def get( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -646,17 +594,7 @@ async def get_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -755,17 +693,7 @@ def delete( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -864,17 +792,7 @@ async def delete_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -979,17 +897,7 @@ def unlink( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -1094,17 +1002,7 @@ async def unlink_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) diff --git a/sync-for-payables/src/codat_sync_for_payables/models/shared/connection.py b/sync-for-payables/src/codat_sync_for_payables/models/shared/connection.py index d804cfa09..e4413479e 100644 --- a/sync-for-payables/src/codat_sync_for_payables/models/shared/connection.py +++ b/sync-for-payables/src/codat_sync_for_payables/models/shared/connection.py @@ -46,8 +46,6 @@ class ConnectionTypedDict(TypedDict): r"""Unique identifier for a company's data connection.""" integration_id: str r"""A Codat ID representing the integration.""" - integration_key: str - r"""A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future.""" source_id: str r"""A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`.""" source_type: SourceType @@ -79,6 +77,8 @@ class ConnectionTypedDict(TypedDict): > 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. """ + integration_key: NotRequired[str] + r"""A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future.""" last_sync: NotRequired[str] r"""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: @@ -123,9 +123,6 @@ class Connection(BaseModel): integration_id: Annotated[str, pydantic.Field(alias="integrationId")] r"""A Codat ID representing the integration.""" - integration_key: Annotated[str, pydantic.Field(alias="integrationKey")] - r"""A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future.""" - source_id: Annotated[str, pydantic.Field(alias="sourceId")] r"""A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`.""" @@ -163,6 +160,11 @@ class Connection(BaseModel): > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ + integration_key: Annotated[ + Optional[str], pydantic.Field(alias="integrationKey") + ] = None + r"""A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future.""" + last_sync: Annotated[Optional[str], pydantic.Field(alias="lastSync")] = None r"""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: @@ -196,7 +198,9 @@ class Connection(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = set(["lastSync", "dataConnectionErrors", "connectionInfo"]) + optional_fields = set( + ["integrationKey", "lastSync", "dataConnectionErrors", "connectionInfo"] + ) nullable_fields = set(["dataConnectionErrors", "connectionInfo"]) serialized = handler(self) m = {} diff --git a/sync-for-payables/src/codat_sync_for_payables/suppliers.py b/sync-for-payables/src/codat_sync_for_payables/suppliers.py index 826d5836d..81ffdd371 100644 --- a/sync-for-payables/src/codat_sync_for_payables/suppliers.py +++ b/sync-for-payables/src/codat_sync_for_payables/suppliers.py @@ -104,19 +104,7 @@ def list( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "409", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -232,19 +220,7 @@ async def list_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "409", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -364,18 +340,7 @@ def create( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -493,18 +458,7 @@ async def create_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -629,18 +583,7 @@ def update( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) @@ -765,18 +708,7 @@ async def update_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=[ - "400", - "401", - "402", - "403", - "404", - "429", - "4XX", - "500", - "503", - "5XX", - ], + is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c), retry_config=retry_config, ) diff --git a/sync-for-payables/src/codat_sync_for_payables/utils/metadata.py b/sync-for-payables/src/codat_sync_for_payables/utils/metadata.py index 173b3e5ce..5abddd588 100644 --- a/sync-for-payables/src/codat_sync_for_payables/utils/metadata.py +++ b/sync-for-payables/src/codat_sync_for_payables/utils/metadata.py @@ -15,6 +15,7 @@ class SecurityMetadata: scheme_type: Optional[str] = None sub_type: Optional[str] = None field_name: Optional[str] = None + composite: bool = False def get_field_name(self, default: str) -> str: return self.field_name or default diff --git a/sync-for-payables/src/codat_sync_for_payables/utils/security.py b/sync-for-payables/src/codat_sync_for_payables/utils/security.py index 17996bd54..42d8d78e9 100644 --- a/sync-for-payables/src/codat_sync_for_payables/utils/security.py +++ b/sync-for-payables/src/codat_sync_for_payables/utils/security.py @@ -5,6 +5,7 @@ Any, Dict, List, + Optional, Tuple, ) from pydantic import BaseModel @@ -16,7 +17,9 @@ ) -def get_security(security: Any) -> Tuple[Dict[str, str], Dict[str, List[str]]]: +def get_security( + security: Any, allowed_fields: Optional[List[str]] = None +) -> Tuple[Dict[str, str], Dict[str, List[str]]]: headers: Dict[str, str] = {} query_params: Dict[str, List[str]] = {} @@ -27,7 +30,14 @@ def get_security(security: Any) -> Tuple[Dict[str, str], Dict[str, List[str]]]: raise TypeError("security must be a pydantic model") sec_fields: Dict[str, FieldInfo] = security.__class__.model_fields - for name in sec_fields: + sec_field_names = ( + list(sec_fields.keys()) if allowed_fields is None else allowed_fields + ) + + for name in sec_field_names: + if name not in sec_fields: + continue + sec_field = sec_fields[name] value = getattr(security, name) @@ -49,6 +59,9 @@ def get_security(security: Any) -> Tuple[Dict[str, str], Dict[str, List[str]]]: else: _parse_security_scheme(headers, query_params, metadata, name, value) + if not metadata.composite: + return headers, query_params + return headers, query_params @@ -59,15 +72,24 @@ def _parse_security_option( raise TypeError("security option must be a pydantic model") opt_fields: Dict[str, FieldInfo] = option.__class__.model_fields + for name in opt_fields: opt_field = opt_fields[name] metadata = find_field_metadata(opt_field, SecurityMetadata) if metadata is None or not metadata.scheme: continue - _parse_security_scheme( - headers, query_params, metadata, name, getattr(option, name) - ) + + value = getattr(option, name) + if ( + metadata.scheme_type == "http" + and metadata.sub_type == "basic" + and not isinstance(value, BaseModel) + ): + _parse_basic_auth_scheme(headers, option) + return + + _parse_security_scheme(headers, query_params, metadata, name, value) def _parse_security_scheme( diff --git a/sync-for-payables/src/codat_sync_for_payables/utils/serializers.py b/sync-for-payables/src/codat_sync_for_payables/utils/serializers.py index 14321eb47..d2149f8b9 100644 --- a/sync-for-payables/src/codat_sync_for_payables/utils/serializers.py +++ b/sync-for-payables/src/codat_sync_for_payables/utils/serializers.py @@ -17,8 +17,7 @@ def serialize_decimal(as_str: bool): def serialize(d): - # Optional[T] is a Union[T, None] - if is_union(type(d)) and type(None) in get_args(type(d)) and d is None: + if d is None: return None if isinstance(d, Unset): return d @@ -46,8 +45,7 @@ def validate_decimal(d): def serialize_float(as_str: bool): def serialize(f): - # Optional[T] is a Union[T, None] - if is_union(type(f)) and type(None) in get_args(type(f)) and f is None: + if f is None: return None if isinstance(f, Unset): return f @@ -75,8 +73,7 @@ def validate_float(f): def serialize_int(as_str: bool): def serialize(i): - # Optional[T] is a Union[T, None] - if is_union(type(i)) and type(None) in get_args(type(i)) and i is None: + if i is None: return None if isinstance(i, Unset): return i @@ -104,8 +101,7 @@ def validate_int(b): def validate_const(v): def validate(c): - # Optional[T] is a Union[T, None] - if is_union(type(c)) and type(None) in get_args(type(c)) and c is None: + if c is None: return None if v != c: